types

package
v8.18.1 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2025 License: Apache-2.0 Imports: 234 Imported by: 2,167

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Access added in v8.17.0 

type Access struct {
	// Replication A list of indices permission entries for cross-cluster replication.
	Replication []ReplicationAccess `json:"replication,omitempty"`
	// Search A list of indices permission entries for cross-cluster search.
	Search []SearchAccess `json:"search,omitempty"`
}

Access type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Access.ts#L22-L31

func NewAccess added in v8.17.0 

func NewAccess() *Access

NewAccess returns a Access.

type AcknowledgeState 

type AcknowledgeState struct {
	State     acknowledgementoptions.AcknowledgementOptions `json:"state"`
	Timestamp DateTime                                      `json:"timestamp"`
}

AcknowledgeState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L109-L112

func NewAcknowledgeState added in v8.5.0 

func NewAcknowledgeState() *AcknowledgeState

NewAcknowledgeState returns a AcknowledgeState.

func (*AcknowledgeState) UnmarshalJSON added in v8.7.1 

func (s *AcknowledgeState) UnmarshalJSON(data []byte) error

type Acknowledgement 

type Acknowledgement struct {
	License []string `json:"license"`
	Message string   `json:"message"`
}

Acknowledgement type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/license/post/types.ts#L20-L23

func NewAcknowledgement added in v8.5.0 

func NewAcknowledgement() *Acknowledgement

NewAcknowledgement returns a Acknowledgement.

func (*Acknowledgement) UnmarshalJSON added in v8.9.0 

func (s *Acknowledgement) UnmarshalJSON(data []byte) error

type ActionStatus 

type ActionStatus struct {
	Ack                     AcknowledgeState `json:"ack"`
	LastExecution           *ExecutionState  `json:"last_execution,omitempty"`
	LastSuccessfulExecution *ExecutionState  `json:"last_successful_execution,omitempty"`
	LastThrottle            *ThrottleState   `json:"last_throttle,omitempty"`
}

ActionStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L125-L130

func NewActionStatus added in v8.5.0 

func NewActionStatus() *ActionStatus

NewActionStatus returns a ActionStatus.

type ActivationState 

type ActivationState struct {
	Active    bool     `json:"active"`
	Timestamp DateTime `json:"timestamp"`
}

ActivationState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Activation.ts#L24-L27

func NewActivationState added in v8.5.0 

func NewActivationState() *ActivationState

NewActivationState returns a ActivationState.

func (*ActivationState) UnmarshalJSON added in v8.7.1 

func (s *ActivationState) UnmarshalJSON(data []byte) error

type ActivationStatus 

type ActivationStatus struct {
	Actions WatcherStatusActions `json:"actions"`
	State   ActivationState      `json:"state"`
	Version int64                `json:"version"`
}

ActivationStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Activation.ts#L29-L33

func NewActivationStatus added in v8.5.0 

func NewActivationStatus() *ActivationStatus

NewActivationStatus returns a ActivationStatus.

func (*ActivationStatus) UnmarshalJSON added in v8.7.1 

func (s *ActivationStatus) UnmarshalJSON(data []byte) error

type AdaptiveAllocations added in v8.18.0 

type AdaptiveAllocations struct {
	// Enabled Turn on `adaptive_allocations`.
	Enabled *bool `json:"enabled,omitempty"`
	// MaxNumberOfAllocations The maximum number of allocations to scale to.
	// If set, it must be greater than or equal to `min_number_of_allocations`.
	MaxNumberOfAllocations *int `json:"max_number_of_allocations,omitempty"`
	// MinNumberOfAllocations The minimum number of allocations to scale to.
	// If set, it must be greater than or equal to 0.
	// If not defined, the deployment scales to 0.
	MinNumberOfAllocations *int `json:"min_number_of_allocations,omitempty"`
}

AdaptiveAllocations type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L99-L116

func NewAdaptiveAllocations added in v8.18.0 

func NewAdaptiveAllocations() *AdaptiveAllocations

NewAdaptiveAllocations returns a AdaptiveAllocations.

func (*AdaptiveAllocations) UnmarshalJSON added in v8.18.0 

func (s *AdaptiveAllocations) UnmarshalJSON(data []byte) error

type AdaptiveAllocationsSettings added in v8.17.0 

type AdaptiveAllocationsSettings struct {
	// Enabled If true, adaptive_allocations is enabled
	Enabled bool `json:"enabled"`
	// MaxNumberOfAllocations Specifies the maximum number of allocations to scale to.
	// If set, it must be greater than or equal to min_number_of_allocations.
	MaxNumberOfAllocations *int `json:"max_number_of_allocations,omitempty"`
	// MinNumberOfAllocations Specifies the minimum number of allocations to scale to.
	// If set, it must be greater than or equal to 0.
	// If not defined, the deployment scales to 0.
	MinNumberOfAllocations *int `json:"min_number_of_allocations,omitempty"`
}

AdaptiveAllocationsSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L109-L125

func NewAdaptiveAllocationsSettings added in v8.17.0 

func NewAdaptiveAllocationsSettings() *AdaptiveAllocationsSettings

NewAdaptiveAllocationsSettings returns a AdaptiveAllocationsSettings.

func (*AdaptiveAllocationsSettings) UnmarshalJSON added in v8.17.0 

func (s *AdaptiveAllocationsSettings) UnmarshalJSON(data []byte) error

type AdaptiveSelection 

type AdaptiveSelection struct {
	// AvgQueueSize The exponentially weighted moving average queue size of search requests on
	// the keyed node.
	AvgQueueSize *int64 `json:"avg_queue_size,omitempty"`
	// AvgResponseTime The exponentially weighted moving average response time of search requests on
	// the keyed node.
	AvgResponseTime Duration `json:"avg_response_time,omitempty"`
	// AvgResponseTimeNs The exponentially weighted moving average response time, in nanoseconds, of
	// search requests on the keyed node.
	AvgResponseTimeNs *int64 `json:"avg_response_time_ns,omitempty"`
	// AvgServiceTime The exponentially weighted moving average service time of search requests on
	// the keyed node.
	AvgServiceTime Duration `json:"avg_service_time,omitempty"`
	// AvgServiceTimeNs The exponentially weighted moving average service time, in nanoseconds, of
	// search requests on the keyed node.
	AvgServiceTimeNs *int64 `json:"avg_service_time_ns,omitempty"`
	// OutgoingSearches The number of outstanding search requests to the keyed node from the node
	// these stats are for.
	OutgoingSearches *int64 `json:"outgoing_searches,omitempty"`
	// Rank The rank of this node; used for shard selection when routing search requests.
	Rank *string `json:"rank,omitempty"`
}

AdaptiveSelection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L439-L468

func NewAdaptiveSelection added in v8.5.0 

func NewAdaptiveSelection() *AdaptiveSelection

NewAdaptiveSelection returns a AdaptiveSelection.

func (*AdaptiveSelection) UnmarshalJSON added in v8.7.1 

func (s *AdaptiveSelection) UnmarshalJSON(data []byte) error

type AddAction 

type AddAction struct {
	// Alias Alias for the action.
	// Index alias names support date math.
	Alias *string `json:"alias,omitempty"`
	// Aliases Aliases for the action.
	// Index alias names support date math.
	Aliases []string `json:"aliases,omitempty"`
	// Filter Query used to limit documents the alias can access.
	Filter *Query `json:"filter,omitempty"`
	// Index Data stream or index for the action.
	// Supports wildcards (`*`).
	Index *string `json:"index,omitempty"`
	// IndexRouting Value used to route indexing operations to a specific shard.
	// If specified, this overwrites the `routing` value for indexing operations.
	// Data stream aliases don’t support this parameter.
	IndexRouting *string `json:"index_routing,omitempty"`
	// Indices Data streams or indices for the action.
	// Supports wildcards (`*`).
	Indices []string `json:"indices,omitempty"`
	// IsHidden If `true`, the alias is hidden.
	IsHidden *bool `json:"is_hidden,omitempty"`
	// IsWriteIndex If `true`, sets the write index or data stream for the alias.
	IsWriteIndex *bool `json:"is_write_index,omitempty"`
	// MustExist If `true`, the alias must exist to perform the action.
	MustExist *bool `json:"must_exist,omitempty"`
	// Routing Value used to route indexing and search operations to a specific shard.
	// Data stream aliases don’t support this parameter.
	Routing *string `json:"routing,omitempty"`
	// SearchRouting Value used to route search operations to a specific shard.
	// If specified, this overwrites the `routing` value for search operations.
	// Data stream aliases don’t support this parameter.
	SearchRouting *string `json:"search_routing,omitempty"`
}

AddAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/update_aliases/types.ts#L41-L95

func NewAddAction added in v8.5.0 

func NewAddAction() *AddAction

NewAddAction returns a AddAction.

func (*AddAction) UnmarshalJSON added in v8.7.1 

func (s *AddAction) UnmarshalJSON(data []byte) error

type AdjacencyMatrixAggregate 

type AdjacencyMatrixAggregate struct {
	Buckets BucketsAdjacencyMatrixBucket `json:"buckets"`
	Meta    Metadata                     `json:"meta,omitempty"`
}

AdjacencyMatrixAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L647-L652

func NewAdjacencyMatrixAggregate added in v8.5.0 

func NewAdjacencyMatrixAggregate() *AdjacencyMatrixAggregate

NewAdjacencyMatrixAggregate returns a AdjacencyMatrixAggregate.

func (*AdjacencyMatrixAggregate) UnmarshalJSON added in v8.7.0 

func (s *AdjacencyMatrixAggregate) UnmarshalJSON(data []byte) error

type AdjacencyMatrixAggregation 

type AdjacencyMatrixAggregation struct {
	// Filters Filters used to create buckets.
	// At least one filter is required.
	Filters map[string]Query `json:"filters,omitempty"`
	// Separator Separator used to concatenate filter names. Defaults to &.
	Separator *string `json:"separator,omitempty"`
}

AdjacencyMatrixAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L60-L70

func NewAdjacencyMatrixAggregation added in v8.5.0 

func NewAdjacencyMatrixAggregation() *AdjacencyMatrixAggregation

NewAdjacencyMatrixAggregation returns a AdjacencyMatrixAggregation.

func (*AdjacencyMatrixAggregation) UnmarshalJSON added in v8.7.1 

func (s *AdjacencyMatrixAggregation) UnmarshalJSON(data []byte) error

type AdjacencyMatrixBucket 

type AdjacencyMatrixBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
}

AdjacencyMatrixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L654-L656

func NewAdjacencyMatrixBucket added in v8.5.0 

func NewAdjacencyMatrixBucket() *AdjacencyMatrixBucket

NewAdjacencyMatrixBucket returns a AdjacencyMatrixBucket.

func (AdjacencyMatrixBucket) MarshalJSON 

func (s AdjacencyMatrixBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*AdjacencyMatrixBucket) UnmarshalJSON added in v8.7.0 

func (s *AdjacencyMatrixBucket) UnmarshalJSON(data []byte) error

type Aggregate 

type Aggregate any

Aggregate holds the union for the following types: 

CardinalityAggregate
HdrPercentilesAggregate
HdrPercentileRanksAggregate
TDigestPercentilesAggregate
TDigestPercentileRanksAggregate
PercentilesBucketAggregate
MedianAbsoluteDeviationAggregate
MinAggregate
MaxAggregate
SumAggregate
AvgAggregate
WeightedAvgAggregate
ValueCountAggregate
SimpleValueAggregate
DerivativeAggregate
BucketMetricValueAggregate
StatsAggregate
StatsBucketAggregate
ExtendedStatsAggregate
ExtendedStatsBucketAggregate
GeoBoundsAggregate
GeoCentroidAggregate
HistogramAggregate
DateHistogramAggregate
AutoDateHistogramAggregate
VariableWidthHistogramAggregate
StringTermsAggregate
LongTermsAggregate
DoubleTermsAggregate
UnmappedTermsAggregate
LongRareTermsAggregate
StringRareTermsAggregate
UnmappedRareTermsAggregate
MultiTermsAggregate
MissingAggregate
NestedAggregate
ReverseNestedAggregate
GlobalAggregate
FilterAggregate
ChildrenAggregate
ParentAggregate
SamplerAggregate
UnmappedSamplerAggregate
GeoHashGridAggregate
GeoTileGridAggregate
GeoHexGridAggregate
RangeAggregate
DateRangeAggregate
GeoDistanceAggregate
IpRangeAggregate
IpPrefixAggregate
FiltersAggregate
AdjacencyMatrixAggregate
SignificantLongTermsAggregate
SignificantStringTermsAggregate
UnmappedSignificantTermsAggregate
CompositeAggregate
FrequentItemSetsAggregate
TimeSeriesAggregate
ScriptedMetricAggregate
TopHitsAggregate
InferenceAggregate
StringStatsAggregate
BoxPlotAggregate
TopMetricsAggregate
TTestAggregate
RateAggregate
CumulativeCardinalityAggregate
MatrixStatsAggregate
GeoLineAggregate

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L38-L125

type AggregateMetricDoubleProperty 

type AggregateMetricDoubleProperty struct {
	DefaultMetric string                         `json:"default_metric"`
	Dynamic       *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields        map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove   *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Metrics             []string                                         `json:"metrics"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	TimeSeriesMetric    *timeseriesmetrictype.TimeSeriesMetricType       `json:"time_series_metric,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

AggregateMetricDoubleProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/complex.ts#L59-L64

func NewAggregateMetricDoubleProperty added in v8.5.0 

func NewAggregateMetricDoubleProperty() *AggregateMetricDoubleProperty

NewAggregateMetricDoubleProperty returns a AggregateMetricDoubleProperty.

func (AggregateMetricDoubleProperty) MarshalJSON added in v8.9.0 

func (s AggregateMetricDoubleProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*AggregateMetricDoubleProperty) UnmarshalJSON added in v8.7.0 

func (s *AggregateMetricDoubleProperty) UnmarshalJSON(data []byte) error

type AggregateOrder 

type AggregateOrder any

AggregateOrder holds the union for the following types: 

map[string]sortorder.SortOrder
[]map[string]sortorder.SortOrder

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1052-L1054

type AggregateOutput 

type AggregateOutput struct {
	Exponent           *Weights `json:"exponent,omitempty"`
	LogisticRegression *Weights `json:"logistic_regression,omitempty"`
	WeightedMode       *Weights `json:"weighted_mode,omitempty"`
	WeightedSum        *Weights `json:"weighted_sum,omitempty"`
}

AggregateOutput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L101-L106

func NewAggregateOutput added in v8.5.0 

func NewAggregateOutput() *AggregateOutput

NewAggregateOutput returns a AggregateOutput.

type Aggregation 

type Aggregation struct {
}

Aggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregation.ts#L20-L20

func NewAggregation added in v8.5.0 

func NewAggregation() *Aggregation

NewAggregation returns a Aggregation.

type AggregationBreakdown 

type AggregationBreakdown struct {
	BuildAggregation        int64  `json:"build_aggregation"`
	BuildAggregationCount   int64  `json:"build_aggregation_count"`
	BuildLeafCollector      int64  `json:"build_leaf_collector"`
	BuildLeafCollectorCount int64  `json:"build_leaf_collector_count"`
	Collect                 int64  `json:"collect"`
	CollectCount            int64  `json:"collect_count"`
	Initialize              int64  `json:"initialize"`
	InitializeCount         int64  `json:"initialize_count"`
	PostCollection          *int64 `json:"post_collection,omitempty"`
	PostCollectionCount     *int64 `json:"post_collection_count,omitempty"`
	Reduce                  int64  `json:"reduce"`
	ReduceCount             int64  `json:"reduce_count"`
}

AggregationBreakdown type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L26-L39

func NewAggregationBreakdown added in v8.5.0 

func NewAggregationBreakdown() *AggregationBreakdown

NewAggregationBreakdown returns a AggregationBreakdown.

func (*AggregationBreakdown) UnmarshalJSON added in v8.7.1 

func (s *AggregationBreakdown) UnmarshalJSON(data []byte) error

type AggregationProfile 

type AggregationProfile struct {
	Breakdown   AggregationBreakdown     `json:"breakdown"`
	Children    []AggregationProfile     `json:"children,omitempty"`
	Debug       *AggregationProfileDebug `json:"debug,omitempty"`
	Description string                   `json:"description"`
	TimeInNanos int64                    `json:"time_in_nanos"`
	Type        string                   `json:"type"`
}

AggregationProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L85-L92

func NewAggregationProfile added in v8.5.0 

func NewAggregationProfile() *AggregationProfile

NewAggregationProfile returns a AggregationProfile.

func (*AggregationProfile) UnmarshalJSON added in v8.7.1 

func (s *AggregationProfile) UnmarshalJSON(data []byte) error

type AggregationProfileDebug 

type AggregationProfileDebug struct {
	BruteForceUsed                    *int                                    `json:"brute_force_used,omitempty"`
	BuiltBuckets                      *int                                    `json:"built_buckets,omitempty"`
	CharsFetched                      *int                                    `json:"chars_fetched,omitempty"`
	CollectAnalyzedCount              *int                                    `json:"collect_analyzed_count,omitempty"`
	CollectAnalyzedNs                 *int                                    `json:"collect_analyzed_ns,omitempty"`
	CollectionStrategy                *string                                 `json:"collection_strategy,omitempty"`
	DeferredAggregators               []string                                `json:"deferred_aggregators,omitempty"`
	Delegate                          *string                                 `json:"delegate,omitempty"`
	DelegateDebug                     *AggregationProfileDebug                `json:"delegate_debug,omitempty"`
	DynamicPruningAttempted           *int                                    `json:"dynamic_pruning_attempted,omitempty"`
	DynamicPruningUsed                *int                                    `json:"dynamic_pruning_used,omitempty"`
	EmptyCollectorsUsed               *int                                    `json:"empty_collectors_used,omitempty"`
	ExtractCount                      *int                                    `json:"extract_count,omitempty"`
	ExtractNs                         *int                                    `json:"extract_ns,omitempty"`
	Filters                           []AggregationProfileDelegateDebugFilter `json:"filters,omitempty"`
	HasFilter                         *bool                                   `json:"has_filter,omitempty"`
	MapReducer                        *string                                 `json:"map_reducer,omitempty"`
	NumericCollectorsUsed             *int                                    `json:"numeric_collectors_used,omitempty"`
	OrdinalsCollectorsOverheadTooHigh *int                                    `json:"ordinals_collectors_overhead_too_high,omitempty"`
	OrdinalsCollectorsUsed            *int                                    `json:"ordinals_collectors_used,omitempty"`
	ResultStrategy                    *string                                 `json:"result_strategy,omitempty"`
	SegmentsCollected                 *int                                    `json:"segments_collected,omitempty"`
	SegmentsCounted                   *int                                    `json:"segments_counted,omitempty"`
	SegmentsWithDeletedDocs           *int                                    `json:"segments_with_deleted_docs,omitempty"`
	SegmentsWithDocCountField         *int                                    `json:"segments_with_doc_count_field,omitempty"`
	SegmentsWithMultiValuedOrds       *int                                    `json:"segments_with_multi_valued_ords,omitempty"`
	SegmentsWithSingleValuedOrds      *int                                    `json:"segments_with_single_valued_ords,omitempty"`
	SkippedDueToNoData                *int                                    `json:"skipped_due_to_no_data,omitempty"`
	StringHashingCollectorsUsed       *int                                    `json:"string_hashing_collectors_used,omitempty"`
	SurvivingBuckets                  *int                                    `json:"surviving_buckets,omitempty"`
	TotalBuckets                      *int                                    `json:"total_buckets,omitempty"`
	ValuesFetched                     *int                                    `json:"values_fetched,omitempty"`
}

AggregationProfileDebug type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L42-L76

func NewAggregationProfileDebug added in v8.5.0 

func NewAggregationProfileDebug() *AggregationProfileDebug

NewAggregationProfileDebug returns a AggregationProfileDebug.

func (*AggregationProfileDebug) UnmarshalJSON added in v8.7.1 

func (s *AggregationProfileDebug) UnmarshalJSON(data []byte) error

type AggregationProfileDelegateDebugFilter 

type AggregationProfileDelegateDebugFilter struct {
	Query                         *string `json:"query,omitempty"`
	ResultsFromMetadata           *int    `json:"results_from_metadata,omitempty"`
	SegmentsCountedInConstantTime *int    `json:"segments_counted_in_constant_time,omitempty"`
	SpecializedFor                *string `json:"specialized_for,omitempty"`
}

AggregationProfileDelegateDebugFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L78-L83

func NewAggregationProfileDelegateDebugFilter added in v8.5.0 

func NewAggregationProfileDelegateDebugFilter() *AggregationProfileDelegateDebugFilter

NewAggregationProfileDelegateDebugFilter returns a AggregationProfileDelegateDebugFilter.

func (*AggregationProfileDelegateDebugFilter) UnmarshalJSON added in v8.7.1 

func (s *AggregationProfileDelegateDebugFilter) UnmarshalJSON(data []byte) error

type AggregationRange 

type AggregationRange struct {
	// From Start of the range (inclusive).
	From *Float64 `json:"from,omitempty"`
	// Key Custom key to return the range with.
	Key *string `json:"key,omitempty"`
	// To End of the range (exclusive).
	To *Float64 `json:"to,omitempty"`
}

AggregationRange type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L691-L704

func NewAggregationRange added in v8.5.0 

func NewAggregationRange() *AggregationRange

NewAggregationRange returns a AggregationRange.

func (*AggregationRange) UnmarshalJSON added in v8.7.1 

func (s *AggregationRange) UnmarshalJSON(data []byte) error

type Aggregations added in v8.5.0 

type Aggregations struct {
	// AdjacencyMatrix A bucket aggregation returning a form of adjacency matrix.
	// The request provides a collection of named filter expressions, similar to the
	// `filters` aggregation.
	// Each bucket in the response represents a non-empty cell in the matrix of
	// intersecting filters.
	AdjacencyMatrix *AdjacencyMatrixAggregation `json:"adjacency_matrix,omitempty"`
	// Aggregations Sub-aggregations for this aggregation.
	// Only applies to bucket aggregations.
	Aggregations map[string]Aggregations `json:"aggregations,omitempty"`
	// AutoDateHistogram A multi-bucket aggregation similar to the date histogram, except instead of
	// providing an interval to use as the width of each bucket, a target number of
	// buckets is provided.
	AutoDateHistogram *AutoDateHistogramAggregation `json:"auto_date_histogram,omitempty"`
	// Avg A single-value metrics aggregation that computes the average of numeric
	// values that are extracted from the aggregated documents.
	Avg *AverageAggregation `json:"avg,omitempty"`
	// AvgBucket A sibling pipeline aggregation which calculates the mean value of a specified
	// metric in a sibling aggregation.
	// The specified metric must be numeric and the sibling aggregation must be a
	// multi-bucket aggregation.
	AvgBucket *AverageBucketAggregation `json:"avg_bucket,omitempty"`
	// Boxplot A metrics aggregation that computes a box plot of numeric values extracted
	// from the aggregated documents.
	Boxplot *BoxplotAggregation `json:"boxplot,omitempty"`
	// BucketCorrelation A sibling pipeline aggregation which runs a correlation function on the
	// configured sibling multi-bucket aggregation.
	BucketCorrelation *BucketCorrelationAggregation `json:"bucket_correlation,omitempty"`
	// BucketCountKsTest A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov
	// test ("K-S test") against a provided distribution and the distribution
	// implied by the documents counts in the configured sibling aggregation.
	BucketCountKsTest *BucketKsAggregation `json:"bucket_count_ks_test,omitempty"`
	// BucketScript A parent pipeline aggregation which runs a script which can perform per
	// bucket computations on metrics in the parent multi-bucket aggregation.
	BucketScript *BucketScriptAggregation `json:"bucket_script,omitempty"`
	// BucketSelector A parent pipeline aggregation which runs a script to determine whether the
	// current bucket will be retained in the parent multi-bucket aggregation.
	BucketSelector *BucketSelectorAggregation `json:"bucket_selector,omitempty"`
	// BucketSort A parent pipeline aggregation which sorts the buckets of its parent
	// multi-bucket aggregation.
	BucketSort *BucketSortAggregation `json:"bucket_sort,omitempty"`
	// Cardinality A single-value metrics aggregation that calculates an approximate count of
	// distinct values.
	Cardinality *CardinalityAggregation `json:"cardinality,omitempty"`
	// CategorizeText A multi-bucket aggregation that groups semi-structured text into buckets.
	CategorizeText *CategorizeTextAggregation `json:"categorize_text,omitempty"`
	// Children A single bucket aggregation that selects child documents that have the
	// specified type, as defined in a `join` field.
	Children *ChildrenAggregation `json:"children,omitempty"`
	// Composite A multi-bucket aggregation that creates composite buckets from different
	// sources.
	// Unlike the other multi-bucket aggregations, you can use the `composite`
	// aggregation to paginate *all* buckets from a multi-level aggregation
	// efficiently.
	Composite *CompositeAggregation `json:"composite,omitempty"`
	// CumulativeCardinality A parent pipeline aggregation which calculates the cumulative cardinality in
	// a parent `histogram` or `date_histogram` aggregation.
	CumulativeCardinality *CumulativeCardinalityAggregation `json:"cumulative_cardinality,omitempty"`
	// CumulativeSum A parent pipeline aggregation which calculates the cumulative sum of a
	// specified metric in a parent `histogram` or `date_histogram` aggregation.
	CumulativeSum *CumulativeSumAggregation `json:"cumulative_sum,omitempty"`
	// DateHistogram A multi-bucket values source based aggregation that can be applied on date
	// values or date range values extracted from the documents.
	// It dynamically builds fixed size (interval) buckets over the values.
	DateHistogram *DateHistogramAggregation `json:"date_histogram,omitempty"`
	// DateRange A multi-bucket value source based aggregation that enables the user to define
	// a set of date ranges - each representing a bucket.
	DateRange *DateRangeAggregation `json:"date_range,omitempty"`
	// Derivative A parent pipeline aggregation which calculates the derivative of a specified
	// metric in a parent `histogram` or `date_histogram` aggregation.
	Derivative *DerivativeAggregation `json:"derivative,omitempty"`
	// DiversifiedSampler A filtering aggregation used to limit any sub aggregations' processing to a
	// sample of the top-scoring documents.
	// Similar to the `sampler` aggregation, but adds the ability to limit the
	// number of matches that share a common value.
	DiversifiedSampler *DiversifiedSamplerAggregation `json:"diversified_sampler,omitempty"`
	// ExtendedStats A multi-value metrics aggregation that computes stats over numeric values
	// extracted from the aggregated documents.
	ExtendedStats *ExtendedStatsAggregation `json:"extended_stats,omitempty"`
	// ExtendedStatsBucket A sibling pipeline aggregation which calculates a variety of stats across all
	// bucket of a specified metric in a sibling aggregation.
	ExtendedStatsBucket *ExtendedStatsBucketAggregation `json:"extended_stats_bucket,omitempty"`
	// Filter A single bucket aggregation that narrows the set of documents to those that
	// match a query.
	Filter *Query `json:"filter,omitempty"`
	// Filters A multi-bucket aggregation where each bucket contains the documents that
	// match a query.
	Filters *FiltersAggregation `json:"filters,omitempty"`
	// FrequentItemSets A bucket aggregation which finds frequent item sets, a form of association
	// rules mining that identifies items that often occur together.
	FrequentItemSets *FrequentItemSetsAggregation `json:"frequent_item_sets,omitempty"`
	// GeoBounds A metric aggregation that computes the geographic bounding box containing all
	// values for a Geopoint or Geoshape field.
	GeoBounds *GeoBoundsAggregation `json:"geo_bounds,omitempty"`
	// GeoCentroid A metric aggregation that computes the weighted centroid from all coordinate
	// values for geo fields.
	GeoCentroid *GeoCentroidAggregation `json:"geo_centroid,omitempty"`
	// GeoDistance A multi-bucket aggregation that works on `geo_point` fields.
	// Evaluates the distance of each document value from an origin point and
	// determines the buckets it belongs to, based on ranges defined in the request.
	GeoDistance *GeoDistanceAggregation `json:"geo_distance,omitempty"`
	// GeoLine Aggregates all `geo_point` values within a bucket into a `LineString` ordered
	// by the chosen sort field.
	GeoLine *GeoLineAggregation `json:"geo_line,omitempty"`
	// GeohashGrid A multi-bucket aggregation that groups `geo_point` and `geo_shape` values
	// into buckets that represent a grid.
	// Each cell is labeled using a geohash which is of user-definable precision.
	GeohashGrid *GeoHashGridAggregation `json:"geohash_grid,omitempty"`
	// GeohexGrid A multi-bucket aggregation that groups `geo_point` and `geo_shape` values
	// into buckets that represent a grid.
	// Each cell corresponds to a H3 cell index and is labeled using the H3Index
	// representation.
	GeohexGrid *GeohexGridAggregation `json:"geohex_grid,omitempty"`
	// GeotileGrid A multi-bucket aggregation that groups `geo_point` and `geo_shape` values
	// into buckets that represent a grid.
	// Each cell corresponds to a map tile as used by many online map sites.
	GeotileGrid *GeoTileGridAggregation `json:"geotile_grid,omitempty"`
	// Global Defines a single bucket of all the documents within the search execution
	// context.
	// This context is defined by the indices and the document types you’re
	// searching on, but is not influenced by the search query itself.
	Global *GlobalAggregation `json:"global,omitempty"`
	// Histogram A multi-bucket values source based aggregation that can be applied on numeric
	// values or numeric range values extracted from the documents.
	// It dynamically builds fixed size (interval) buckets over the values.
	Histogram *HistogramAggregation `json:"histogram,omitempty"`
	// Inference A parent pipeline aggregation which loads a pre-trained model and performs
	// inference on the collated result fields from the parent bucket aggregation.
	Inference *InferenceAggregation `json:"inference,omitempty"`
	// IpPrefix A bucket aggregation that groups documents based on the network or
	// sub-network of an IP address.
	IpPrefix *IpPrefixAggregation `json:"ip_prefix,omitempty"`
	// IpRange A multi-bucket value source based aggregation that enables the user to define
	// a set of IP ranges - each representing a bucket.
	IpRange *IpRangeAggregation `json:"ip_range,omitempty"`
	Line    *GeoLineAggregation `json:"line,omitempty"`
	// MatrixStats A numeric aggregation that computes the following statistics over a set of
	// document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`,
	// `covariance`, and `covariance`.
	MatrixStats *MatrixStatsAggregation `json:"matrix_stats,omitempty"`
	// Max A single-value metrics aggregation that returns the maximum value among the
	// numeric values extracted from the aggregated documents.
	Max *MaxAggregation `json:"max,omitempty"`
	// MaxBucket A sibling pipeline aggregation which identifies the bucket(s) with the
	// maximum value of a specified metric in a sibling aggregation and outputs both
	// the value and the key(s) of the bucket(s).
	MaxBucket *MaxBucketAggregation `json:"max_bucket,omitempty"`
	// MedianAbsoluteDeviation A single-value aggregation that approximates the median absolute deviation of
	// its search results.
	MedianAbsoluteDeviation *MedianAbsoluteDeviationAggregation `json:"median_absolute_deviation,omitempty"`
	Meta                    Metadata                            `json:"meta,omitempty"`
	// Min A single-value metrics aggregation that returns the minimum value among
	// numeric values extracted from the aggregated documents.
	Min *MinAggregation `json:"min,omitempty"`
	// MinBucket A sibling pipeline aggregation which identifies the bucket(s) with the
	// minimum value of a specified metric in a sibling aggregation and outputs both
	// the value and the key(s) of the bucket(s).
	MinBucket *MinBucketAggregation `json:"min_bucket,omitempty"`
	// Missing A field data based single bucket aggregation, that creates a bucket of all
	// documents in the current document set context that are missing a field value
	// (effectively, missing a field or having the configured NULL value set).
	Missing   *MissingAggregation      `json:"missing,omitempty"`
	MovingAvg MovingAverageAggregation `json:"moving_avg,omitempty"`
	// MovingFn Given an ordered series of data, "slides" a window across the data and runs a
	// custom script on each window of data.
	// For convenience, a number of common functions are predefined such as `min`,
	// `max`, and moving averages.
	MovingFn *MovingFunctionAggregation `json:"moving_fn,omitempty"`
	// MovingPercentiles Given an ordered series of percentiles, "slides" a window across those
	// percentiles and computes cumulative percentiles.
	MovingPercentiles *MovingPercentilesAggregation `json:"moving_percentiles,omitempty"`
	// MultiTerms A multi-bucket value source based aggregation where buckets are dynamically
	// built - one per unique set of values.
	MultiTerms *MultiTermsAggregation `json:"multi_terms,omitempty"`
	// Nested A special single bucket aggregation that enables aggregating nested
	// documents.
	Nested *NestedAggregation `json:"nested,omitempty"`
	// Normalize A parent pipeline aggregation which calculates the specific
	// normalized/rescaled value for a specific bucket value.
	Normalize *NormalizeAggregation `json:"normalize,omitempty"`
	// Parent A special single bucket aggregation that selects parent documents that have
	// the specified type, as defined in a `join` field.
	Parent *ParentAggregation `json:"parent,omitempty"`
	// PercentileRanks A multi-value metrics aggregation that calculates one or more percentile
	// ranks over numeric values extracted from the aggregated documents.
	PercentileRanks *PercentileRanksAggregation `json:"percentile_ranks,omitempty"`
	// Percentiles A multi-value metrics aggregation that calculates one or more percentiles
	// over numeric values extracted from the aggregated documents.
	Percentiles *PercentilesAggregation `json:"percentiles,omitempty"`
	// PercentilesBucket A sibling pipeline aggregation which calculates percentiles across all bucket
	// of a specified metric in a sibling aggregation.
	PercentilesBucket *PercentilesBucketAggregation `json:"percentiles_bucket,omitempty"`
	// RandomSampler A single bucket aggregation that randomly includes documents in the
	// aggregated results.
	// Sampling provides significant speed improvement at the cost of accuracy.
	RandomSampler *RandomSamplerAggregation `json:"random_sampler,omitempty"`
	// Range A multi-bucket value source based aggregation that enables the user to define
	// a set of ranges - each representing a bucket.
	Range *RangeAggregation `json:"range,omitempty"`
	// RareTerms A multi-bucket value source based aggregation which finds "rare" terms —
	// terms that are at the long-tail of the distribution and are not frequent.
	RareTerms *RareTermsAggregation `json:"rare_terms,omitempty"`
	// Rate Calculates a rate of documents or a field in each bucket.
	// Can only be used inside a `date_histogram` or `composite` aggregation.
	Rate *RateAggregation `json:"rate,omitempty"`
	// ReverseNested A special single bucket aggregation that enables aggregating on parent
	// documents from nested documents.
	// Should only be defined inside a `nested` aggregation.
	ReverseNested *ReverseNestedAggregation `json:"reverse_nested,omitempty"`
	// Sampler A filtering aggregation used to limit any sub aggregations' processing to a
	// sample of the top-scoring documents.
	Sampler *SamplerAggregation `json:"sampler,omitempty"`
	// ScriptedMetric A metric aggregation that uses scripts to provide a metric output.
	ScriptedMetric *ScriptedMetricAggregation `json:"scripted_metric,omitempty"`
	// SerialDiff An aggregation that subtracts values in a time series from themselves at
	// different time lags or periods.
	SerialDiff *SerialDifferencingAggregation `json:"serial_diff,omitempty"`
	// SignificantTerms Returns interesting or unusual occurrences of terms in a set.
	SignificantTerms *SignificantTermsAggregation `json:"significant_terms,omitempty"`
	// SignificantText Returns interesting or unusual occurrences of free-text terms in a set.
	SignificantText *SignificantTextAggregation `json:"significant_text,omitempty"`
	// Stats A multi-value metrics aggregation that computes stats over numeric values
	// extracted from the aggregated documents.
	Stats *StatsAggregation `json:"stats,omitempty"`
	// StatsBucket A sibling pipeline aggregation which calculates a variety of stats across all
	// bucket of a specified metric in a sibling aggregation.
	StatsBucket *StatsBucketAggregation `json:"stats_bucket,omitempty"`
	// StringStats A multi-value metrics aggregation that computes statistics over string values
	// extracted from the aggregated documents.
	StringStats *StringStatsAggregation `json:"string_stats,omitempty"`
	// Sum A single-value metrics aggregation that sums numeric values that are
	// extracted from the aggregated documents.
	Sum *SumAggregation `json:"sum,omitempty"`
	// SumBucket A sibling pipeline aggregation which calculates the sum of a specified metric
	// across all buckets in a sibling aggregation.
	SumBucket *SumBucketAggregation `json:"sum_bucket,omitempty"`
	// TTest A metrics aggregation that performs a statistical hypothesis test in which
	// the test statistic follows a Student’s t-distribution under the null
	// hypothesis on numeric values extracted from the aggregated documents.
	TTest *TTestAggregation `json:"t_test,omitempty"`
	// Terms A multi-bucket value source based aggregation where buckets are dynamically
	// built - one per unique value.
	Terms *TermsAggregation `json:"terms,omitempty"`
	// TimeSeries The time series aggregation queries data created using a time series index.
	// This is typically data such as metrics or other data streams with a time
	// component, and requires creating an index using the time series mode.
	TimeSeries *TimeSeriesAggregation `json:"time_series,omitempty"`
	// TopHits A metric aggregation that returns the top matching documents per bucket.
	TopHits *TopHitsAggregation `json:"top_hits,omitempty"`
	// TopMetrics A metric aggregation that selects metrics from the document with the largest
	// or smallest sort value.
	TopMetrics *TopMetricsAggregation `json:"top_metrics,omitempty"`
	// ValueCount A single-value metrics aggregation that counts the number of values that are
	// extracted from the aggregated documents.
	ValueCount *ValueCountAggregation `json:"value_count,omitempty"`
	// VariableWidthHistogram A multi-bucket aggregation similar to the histogram, except instead of
	// providing an interval to use as the width of each bucket, a target number of
	// buckets is provided.
	VariableWidthHistogram *VariableWidthHistogramAggregation `json:"variable_width_histogram,omitempty"`
	// WeightedAvg A single-value metrics aggregation that computes the weighted average of
	// numeric values that are extracted from the aggregated documents.
	WeightedAvg *WeightedAverageAggregation `json:"weighted_avg,omitempty"`
}

Aggregations type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/AggregationContainer.ts#L107-L533

func NewAggregations added in v8.5.0 

func NewAggregations() *Aggregations

NewAggregations returns a Aggregations.

func (*Aggregations) UnmarshalJSON added in v8.7.0 

func (s *Aggregations) UnmarshalJSON(data []byte) error

type Alias 

type Alias struct {
	// Filter Query used to limit documents the alias can access.
	Filter *Query `json:"filter,omitempty"`
	// IndexRouting Value used to route indexing operations to a specific shard.
	// If specified, this overwrites the `routing` value for indexing operations.
	IndexRouting *string `json:"index_routing,omitempty"`
	// IsHidden If `true`, the alias is hidden.
	// All indices for the alias must have the same `is_hidden` value.
	IsHidden *bool `json:"is_hidden,omitempty"`
	// IsWriteIndex If `true`, the index is the write index for the alias.
	IsWriteIndex *bool `json:"is_write_index,omitempty"`
	// Routing Value used to route indexing and search operations to a specific shard.
	Routing *string `json:"routing,omitempty"`
	// SearchRouting Value used to route search operations to a specific shard.
	// If specified, this overwrites the `routing` value for search operations.
	SearchRouting *string `json:"search_routing,omitempty"`
}

Alias type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/Alias.ts#L23-L53

func NewAlias added in v8.5.0 

func NewAlias() *Alias

NewAlias returns a Alias.

func (*Alias) UnmarshalJSON added in v8.7.1 

func (s *Alias) UnmarshalJSON(data []byte) error

type AliasDefinition 

type AliasDefinition struct {
	// Filter Query used to limit documents the alias can access.
	Filter *Query `json:"filter,omitempty"`
	// IndexRouting Value used to route indexing operations to a specific shard.
	// If specified, this overwrites the `routing` value for indexing operations.
	IndexRouting *string `json:"index_routing,omitempty"`
	// IsHidden If `true`, the alias is hidden.
	// All indices for the alias must have the same `is_hidden` value.
	IsHidden *bool `json:"is_hidden,omitempty"`
	// IsWriteIndex If `true`, the index is the write index for the alias.
	IsWriteIndex *bool `json:"is_write_index,omitempty"`
	// Routing Value used to route indexing and search operations to a specific shard.
	Routing *string `json:"routing,omitempty"`
	// SearchRouting Value used to route search operations to a specific shard.
	// If specified, this overwrites the `routing` value for search operations.
	SearchRouting *string `json:"search_routing,omitempty"`
}

AliasDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/AliasDefinition.ts#L22-L54

func NewAliasDefinition added in v8.5.0 

func NewAliasDefinition() *AliasDefinition

NewAliasDefinition returns a AliasDefinition.

func (*AliasDefinition) UnmarshalJSON added in v8.7.1 

func (s *AliasDefinition) UnmarshalJSON(data []byte) error

type AliasesRecord 

type AliasesRecord struct {
	// Alias alias name
	Alias *string `json:"alias,omitempty"`
	// Filter filter
	Filter *string `json:"filter,omitempty"`
	// Index index alias points to
	Index *string `json:"index,omitempty"`
	// IsWriteIndex write index
	IsWriteIndex *string `json:"is_write_index,omitempty"`
	// RoutingIndex index routing
	RoutingIndex *string `json:"routing.index,omitempty"`
	// RoutingSearch search routing
	RoutingSearch *string `json:"routing.search,omitempty"`
}

AliasesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/aliases/types.ts#L22-L53

func NewAliasesRecord added in v8.5.0 

func NewAliasesRecord() *AliasesRecord

NewAliasesRecord returns a AliasesRecord.

func (*AliasesRecord) UnmarshalJSON added in v8.7.1 

func (s *AliasesRecord) UnmarshalJSON(data []byte) error

type AlibabaCloudServiceSettings added in v8.18.0 

type AlibabaCloudServiceSettings struct {
	// ApiKey A valid API key for the AlibabaCloud AI Search API.
	ApiKey string `json:"api_key"`
	// Host The name of the host address used for the inference task.
	// You can find the host address in the API keys section of the documentation.
	Host string `json:"host"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// AlibabaCloud AI Search.
	// By default, the `alibabacloud-ai-search` service sets the number of requests
	// allowed per minute to `1000`.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// ServiceId The name of the model service to use for the inference task.
	// The following service IDs are available for the `completion` task:
	//
	// * `ops-qwen-turbo`
	// * `qwen-turbo`
	// * `qwen-plus`
	// * `qwen-max ÷ qwen-max-longcontext`
	//
	// The following service ID is available for the `rerank` task:
	//
	// * `ops-bge-reranker-larger`
	//
	// The following service ID is available for the `sparse_embedding` task:
	//
	// * `ops-text-sparse-embedding-001`
	//
	// The following service IDs are available for the `text_embedding` task:
	//
	// `ops-text-embedding-001`
	// `ops-text-embedding-zh-001`
	// `ops-text-embedding-en-001`
	// `ops-text-embedding-002`
	ServiceId string `json:"service_id"`
	// Workspace The name of the workspace used for the inference task.
	Workspace string `json:"workspace"`
}

AlibabaCloudServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L292-L337

func NewAlibabaCloudServiceSettings added in v8.18.0 

func NewAlibabaCloudServiceSettings() *AlibabaCloudServiceSettings

NewAlibabaCloudServiceSettings returns a AlibabaCloudServiceSettings.

func (*AlibabaCloudServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *AlibabaCloudServiceSettings) UnmarshalJSON(data []byte) error

type AlibabaCloudTaskSettings added in v8.18.0 

type AlibabaCloudTaskSettings struct {
	// InputType For a `sparse_embedding` or `text_embedding` task, specify the type of input
	// passed to the model.
	// Valid values are:
	//
	// * `ingest` for storing document embeddings in a vector database.
	// * `search` for storing embeddings of search queries run against a vector
	// database to find relevant documents.
	InputType *string `json:"input_type,omitempty"`
	// ReturnToken For a `sparse_embedding` task, it affects whether the token name will be
	// returned in the response.
	// It defaults to `false`, which means only the token ID will be returned in the
	// response.
	ReturnToken *bool `json:"return_token,omitempty"`
}

AlibabaCloudTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L339-L353

func NewAlibabaCloudTaskSettings added in v8.18.0 

func NewAlibabaCloudTaskSettings() *AlibabaCloudTaskSettings

NewAlibabaCloudTaskSettings returns a AlibabaCloudTaskSettings.

func (*AlibabaCloudTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *AlibabaCloudTaskSettings) UnmarshalJSON(data []byte) error

type AllField 

type AllField struct {
	Analyzer                 string `json:"analyzer"`
	Enabled                  bool   `json:"enabled"`
	OmitNorms                bool   `json:"omit_norms"`
	SearchAnalyzer           string `json:"search_analyzer"`
	Similarity               string `json:"similarity"`
	Store                    bool   `json:"store"`
	StoreTermVectorOffsets   bool   `json:"store_term_vector_offsets"`
	StoreTermVectorPayloads  bool   `json:"store_term_vector_payloads"`
	StoreTermVectorPositions bool   `json:"store_term_vector_positions"`
	StoreTermVectors         bool   `json:"store_term_vectors"`
}

AllField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L29-L40

func NewAllField added in v8.5.0 

func NewAllField() *AllField

NewAllField returns a AllField.

func (*AllField) UnmarshalJSON added in v8.7.1 

func (s *AllField) UnmarshalJSON(data []byte) error

type AllocateAction added in v8.15.0 

type AllocateAction struct {
	Exclude            map[string]string `json:"exclude,omitempty"`
	Include            map[string]string `json:"include,omitempty"`
	NumberOfReplicas   *int              `json:"number_of_replicas,omitempty"`
	Require            map[string]string `json:"require,omitempty"`
	TotalShardsPerNode *int              `json:"total_shards_per_node,omitempty"`
}

AllocateAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L133-L139

func NewAllocateAction added in v8.15.0 

func NewAllocateAction() *AllocateAction

NewAllocateAction returns a AllocateAction.

func (*AllocateAction) UnmarshalJSON added in v8.15.0 

func (s *AllocateAction) UnmarshalJSON(data []byte) error

type AllocationDecision 

type AllocationDecision struct {
	Decider     string                                              `json:"decider"`
	Decision    allocationexplaindecision.AllocationExplainDecision `json:"decision"`
	Explanation string                                              `json:"explanation"`
}

AllocationDecision type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L27-L31

func NewAllocationDecision added in v8.5.0 

func NewAllocationDecision() *AllocationDecision

NewAllocationDecision returns a AllocationDecision.

func (*AllocationDecision) UnmarshalJSON added in v8.9.0 

func (s *AllocationDecision) UnmarshalJSON(data []byte) error

type AllocationRecord 

type AllocationRecord struct {
	// DiskAvail Free disk space available to Elasticsearch.
	// Elasticsearch retrieves this metric from the node’s operating system.
	// Disk-based shard allocation uses this metric to assign shards to nodes based
	// on available disk space.
	DiskAvail *ByteSize `json:"disk.avail,omitempty"`
	// DiskIndices Disk space used by the node’s shards. Does not include disk space for the
	// translog or unassigned shards.
	// IMPORTANT: This metric double-counts disk space for hard-linked files, such
	// as those created when shrinking, splitting, or cloning an index.
	DiskIndices *ByteSize `json:"disk.indices,omitempty"`
	// DiskIndicesForecast Sum of shard size forecasts
	DiskIndicesForecast *ByteSize `json:"disk.indices.forecast,omitempty"`
	// DiskPercent Total percentage of disk space in use. Calculated as `disk.used /
	// disk.total`.
	DiskPercent *Percentage `json:"disk.percent,omitempty"`
	// DiskTotal Total disk space for the node, including in-use and available space.
	DiskTotal *ByteSize `json:"disk.total,omitempty"`
	// DiskUsed Total disk space in use.
	// Elasticsearch retrieves this metric from the node’s operating system (OS).
	// The metric includes disk space for: Elasticsearch, including the translog and
	// unassigned shards; the node’s operating system; any other applications or
	// files on the node.
	// Unlike `disk.indices`, this metric does not double-count disk space for
	// hard-linked files.
	DiskUsed *ByteSize `json:"disk.used,omitempty"`
	// Host Network host for the node. Set using the `network.host` setting.
	Host *string `json:"host,omitempty"`
	// Ip IP address and port for the node.
	Ip *string `json:"ip,omitempty"`
	// Node Name for the node. Set using the `node.name` setting.
	Node *string `json:"node,omitempty"`
	// NodeRole Node roles
	NodeRole *string `json:"node.role,omitempty"`
	// Shards Number of primary and replica shards assigned to the node.
	Shards *string `json:"shards,omitempty"`
	// ShardsUndesired Amount of shards that are scheduled to be moved elsewhere in the cluster or
	// -1 other than desired balance allocator is used
	ShardsUndesired *string `json:"shards.undesired,omitempty"`
	// WriteLoadForecast Sum of index write load forecasts
	WriteLoadForecast *Stringifieddouble `json:"write_load.forecast,omitempty"`
}

AllocationRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/allocation/types.ts#L25-L99

func NewAllocationRecord added in v8.5.0 

func NewAllocationRecord() *AllocationRecord

NewAllocationRecord returns a AllocationRecord.

func (*AllocationRecord) UnmarshalJSON added in v8.7.1 

func (s *AllocationRecord) UnmarshalJSON(data []byte) error

type AllocationStore 

type AllocationStore struct {
	AllocationId        string `json:"allocation_id"`
	Found               bool   `json:"found"`
	InSync              bool   `json:"in_sync"`
	MatchingSizeInBytes int64  `json:"matching_size_in_bytes"`
	MatchingSyncId      bool   `json:"matching_sync_id"`
	StoreException      string `json:"store_exception"`
}

AllocationStore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L40-L47

func NewAllocationStore added in v8.5.0 

func NewAllocationStore() *AllocationStore

NewAllocationStore returns a AllocationStore.

func (*AllocationStore) UnmarshalJSON added in v8.7.1 

func (s *AllocationStore) UnmarshalJSON(data []byte) error

type AlwaysCondition 

type AlwaysCondition struct {
}

AlwaysCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L25-L25

func NewAlwaysCondition added in v8.5.0 

func NewAlwaysCondition() *AlwaysCondition

NewAlwaysCondition returns a AlwaysCondition.

type AmazonBedrockServiceSettings added in v8.18.0 

type AmazonBedrockServiceSettings struct {
	// AccessKey A valid AWS access key that has permissions to use Amazon Bedrock and access
	// to models for inference requests.
	AccessKey string `json:"access_key"`
	// Model The base model ID or an ARN to a custom model based on a foundational model.
	// The base model IDs can be found in the Amazon Bedrock documentation.
	// Note that the model ID must be available for the provider chosen and your IAM
	// user must have access to the model.
	Model string `json:"model"`
	// Provider The model provider for your deployment.
	// Note that some providers may support only certain task types.
	// Supported providers include:
	//
	// * `amazontitan` - available for `text_embedding` and `completion` task types
	// * `anthropic` - available for `completion` task type only
	// * `ai21labs` - available for `completion` task type only
	// * `cohere` - available for `text_embedding` and `completion` task types
	// * `meta` - available for `completion` task type only
	// * `mistral` - available for `completion` task type only
	Provider *string `json:"provider,omitempty"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Watsonx.
	// By default, the `watsonxai` service sets the number of requests allowed per
	// minute to 120.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Region The region that your model or ARN is deployed in.
	// The list of available regions per model can be found in the Amazon Bedrock
	// documentation.
	Region string `json:"region"`
	// SecretKey A valid AWS secret key that is paired with the `access_key`.
	// For informationg about creating and managing access and secret keys, refer to
	// the AWS documentation.
	SecretKey string `json:"secret_key"`
}

AmazonBedrockServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L366-L408

func NewAmazonBedrockServiceSettings added in v8.18.0 

func NewAmazonBedrockServiceSettings() *AmazonBedrockServiceSettings

NewAmazonBedrockServiceSettings returns a AmazonBedrockServiceSettings.

func (*AmazonBedrockServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *AmazonBedrockServiceSettings) UnmarshalJSON(data []byte) error

type AmazonBedrockTaskSettings added in v8.18.0 

type AmazonBedrockTaskSettings struct {
	// MaxNewTokens For a `completion` task, it sets the maximum number for the output tokens to
	// be generated.
	MaxNewTokens *int `json:"max_new_tokens,omitempty"`
	// Temperature For a `completion` task, it is a number between 0.0 and 1.0 that controls the
	// apparent creativity of the results.
	// At temperature 0.0 the model is most deterministic, at temperature 1.0 most
	// random.
	// It should not be used if `top_p` or `top_k` is specified.
	Temperature *float32 `json:"temperature,omitempty"`
	// TopK For a `completion` task, it limits samples to the top-K most likely words,
	// balancing coherence and variability.
	// It is only available for anthropic, cohere, and mistral providers.
	// It is an alternative to `temperature`; it should not be used if `temperature`
	// is specified.
	TopK *float32 `json:"top_k,omitempty"`
	// TopP For a `completion` task, it is a number in the range of 0.0 to 1.0, to
	// eliminate low-probability tokens.
	// Top-p uses nucleus sampling to select top tokens whose sum of likelihoods
	// does not exceed a certain value, ensuring both variety and coherence.
	// It is an alternative to `temperature`; it should not be used if `temperature`
	// is specified.
	TopP *float32 `json:"top_p,omitempty"`
}

AmazonBedrockTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L410-L434

func NewAmazonBedrockTaskSettings added in v8.18.0 

func NewAmazonBedrockTaskSettings() *AmazonBedrockTaskSettings

NewAmazonBedrockTaskSettings returns a AmazonBedrockTaskSettings.

func (*AmazonBedrockTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *AmazonBedrockTaskSettings) UnmarshalJSON(data []byte) error

type AnalysisConfig 

type AnalysisConfig struct {
	// BucketSpan The size of the interval that the analysis is aggregated into, typically
	// between `5m` and `1h`. This value should be either a whole number of days or
	// equate to a
	// whole number of buckets in one day. If the anomaly detection job uses a
	// datafeed with aggregations, this value must also be divisible by the interval
	// of the date histogram aggregation.
	BucketSpan Duration `json:"bucket_span,omitempty"`
	// CategorizationAnalyzer If `categorization_field_name` is specified, you can also define the analyzer
	// that is used to interpret the categorization field. This property cannot be
	// used at the same time as `categorization_filters`. The categorization
	// analyzer specifies how the `categorization_field` is interpreted by the
	// categorization process. The `categorization_analyzer` field can be specified
	// either as a string or as an object. If it is a string, it must refer to a
	// built-in analyzer or one added by another plugin.
	CategorizationAnalyzer CategorizationAnalyzer `json:"categorization_analyzer,omitempty"`
	// CategorizationFieldName If this property is specified, the values of the specified field will be
	// categorized. The resulting categories must be used in a detector by setting
	// `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword
	// `mlcategory`.
	CategorizationFieldName *string `json:"categorization_field_name,omitempty"`
	// CategorizationFilters If `categorization_field_name` is specified, you can also define optional
	// filters. This property expects an array of regular expressions. The
	// expressions are used to filter out matching sequences from the categorization
	// field values. You can use this functionality to fine tune the categorization
	// by excluding sequences from consideration when categories are defined. For
	// example, you can exclude SQL statements that appear in your log files. This
	// property cannot be used at the same time as `categorization_analyzer`. If you
	// only want to define simple regular expression filters that are applied prior
	// to tokenization, setting this property is the easiest method. If you also
	// want to customize the tokenizer or post-tokenization filtering, use the
	// `categorization_analyzer` property instead and include the filters as
	// pattern_replace character filters. The effect is exactly the same.
	CategorizationFilters []string `json:"categorization_filters,omitempty"`
	// Detectors Detector configuration objects specify which data fields a job analyzes. They
	// also specify which analytical functions are used. You can specify multiple
	// detectors for a job. If the detectors array does not contain at least one
	// detector, no analysis can occur and an error is returned.
	Detectors []Detector `json:"detectors"`
	// Influencers A comma separated list of influencer field names. Typically these can be the
	// by, over, or partition fields that are used in the detector configuration.
	// You might also want to use a field name that is not specifically named in a
	// detector, but is available as part of the input data. When you use multiple
	// detectors, the use of influencers is recommended as it aggregates results for
	// each influencer entity.
	Influencers []string `json:"influencers,omitempty"`
	// Latency The size of the window in which to expect data that is out of time order. If
	// you specify a non-zero value, it must be greater than or equal to one second.
	// NOTE: Latency is applicable only when you send data by using the post data
	// API.
	Latency Duration `json:"latency,omitempty"`
	// ModelPruneWindow Advanced configuration option. Affects the pruning of models that have not
	// been updated for the given time duration. The value must be set to a multiple
	// of the `bucket_span`. If set too low, important information may be removed
	// from the model. For jobs created in 8.1 and later, the default value is the
	// greater of `30d` or 20 times `bucket_span`.
	ModelPruneWindow Duration `json:"model_prune_window,omitempty"`
	// MultivariateByFields This functionality is reserved for internal use. It is not supported for use
	// in customer environments and is not subject to the support SLA of official GA
	// features. If set to `true`, the analysis will automatically find correlations
	// between metrics for a given by field value and report anomalies when those
	// correlations cease to hold. For example, suppose CPU and memory usage on host
	// A is usually highly correlated with the same metrics on host B. Perhaps this
	// correlation occurs because they are running a load-balanced application. If
	// you enable this property, anomalies will be reported when, for example, CPU
	// usage on host A is high and the value of CPU usage on host B is low. That is
	// to say, you’ll see an anomaly when the CPU of host A is unusual given the CPU
	// of host B. To use the `multivariate_by_fields` property, you must also
	// specify `by_field_name` in your detector.
	MultivariateByFields *bool `json:"multivariate_by_fields,omitempty"`
	// PerPartitionCategorization Settings related to how categorization interacts with partition fields.
	PerPartitionCategorization *PerPartitionCategorization `json:"per_partition_categorization,omitempty"`
	// SummaryCountFieldName If this property is specified, the data that is fed to the job is expected to
	// be pre-summarized. This property value is the name of the field that contains
	// the count of raw data points that have been summarized. The same
	// `summary_count_field_name` applies to all detectors in the job. NOTE: The
	// `summary_count_field_name` property cannot be used with the `metric`
	// function.
	SummaryCountFieldName *string `json:"summary_count_field_name,omitempty"`
}

AnalysisConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L29-L77

func NewAnalysisConfig added in v8.5.0 

func NewAnalysisConfig() *AnalysisConfig

NewAnalysisConfig returns a AnalysisConfig.

func (*AnalysisConfig) UnmarshalJSON added in v8.7.0 

func (s *AnalysisConfig) UnmarshalJSON(data []byte) error

type AnalysisConfigRead 

type AnalysisConfigRead struct {
	// BucketSpan The size of the interval that the analysis is aggregated into, typically
	// between `5m` and `1h`.
	BucketSpan Duration `json:"bucket_span"`
	// CategorizationAnalyzer If `categorization_field_name` is specified, you can also define the analyzer
	// that is used to interpret the categorization field.
	// This property cannot be used at the same time as `categorization_filters`.
	// The categorization analyzer specifies how the `categorization_field` is
	// interpreted by the categorization process.
	CategorizationAnalyzer CategorizationAnalyzer `json:"categorization_analyzer,omitempty"`
	// CategorizationFieldName If this property is specified, the values of the specified field will be
	// categorized.
	// The resulting categories must be used in a detector by setting
	// `by_field_name`, `over_field_name`, or `partition_field_name` to the keyword
	// `mlcategory`.
	CategorizationFieldName *string `json:"categorization_field_name,omitempty"`
	// CategorizationFilters If `categorization_field_name` is specified, you can also define optional
	// filters.
	// This property expects an array of regular expressions.
	// The expressions are used to filter out matching sequences from the
	// categorization field values.
	CategorizationFilters []string `json:"categorization_filters,omitempty"`
	// Detectors An array of detector configuration objects.
	// Detector configuration objects specify which data fields a job analyzes.
	// They also specify which analytical functions are used.
	// You can specify multiple detectors for a job.
	Detectors []DetectorRead `json:"detectors"`
	// Influencers A comma separated list of influencer field names.
	// Typically these can be the by, over, or partition fields that are used in the
	// detector configuration.
	// You might also want to use a field name that is not specifically named in a
	// detector, but is available as part of the input data.
	// When you use multiple detectors, the use of influencers is recommended as it
	// aggregates results for each influencer entity.
	Influencers []string `json:"influencers"`
	// Latency The size of the window in which to expect data that is out of time order.
	// Defaults to no latency.
	// If you specify a non-zero value, it must be greater than or equal to one
	// second.
	Latency Duration `json:"latency,omitempty"`
	// ModelPruneWindow Advanced configuration option.
	// Affects the pruning of models that have not been updated for the given time
	// duration.
	// The value must be set to a multiple of the `bucket_span`.
	// If set too low, important information may be removed from the model.
	// Typically, set to `30d` or longer.
	// If not set, model pruning only occurs if the model memory status reaches the
	// soft limit or the hard limit.
	// For jobs created in 8.1 and later, the default value is the greater of `30d`
	// or 20 times `bucket_span`.
	ModelPruneWindow Duration `json:"model_prune_window,omitempty"`
	// MultivariateByFields This functionality is reserved for internal use.
	// It is not supported for use in customer environments and is not subject to
	// the support SLA of official GA features.
	// If set to `true`, the analysis will automatically find correlations between
	// metrics for a given by field value and report anomalies when those
	// correlations cease to hold.
	MultivariateByFields *bool `json:"multivariate_by_fields,omitempty"`
	// PerPartitionCategorization Settings related to how categorization interacts with partition fields.
	PerPartitionCategorization *PerPartitionCategorization `json:"per_partition_categorization,omitempty"`
	// SummaryCountFieldName If this property is specified, the data that is fed to the job is expected to
	// be pre-summarized.
	// This property value is the name of the field that contains the count of raw
	// data points that have been summarized.
	// The same `summary_count_field_name` applies to all detectors in the job.
	SummaryCountFieldName *string `json:"summary_count_field_name,omitempty"`
}

AnalysisConfigRead type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L79-L148

func NewAnalysisConfigRead added in v8.5.0 

func NewAnalysisConfigRead() *AnalysisConfigRead

NewAnalysisConfigRead returns a AnalysisConfigRead.

func (*AnalysisConfigRead) UnmarshalJSON added in v8.7.0 

func (s *AnalysisConfigRead) UnmarshalJSON(data []byte) error

type AnalysisLimits 

type AnalysisLimits struct {
	// CategorizationExamplesLimit The maximum number of examples stored per category in memory and in the
	// results data store. If you increase this value, more examples are available,
	// however it requires that you have more storage available. If you set this
	// value to 0, no examples are stored. NOTE: The `categorization_examples_limit`
	// applies only to analysis that uses categorization.
	CategorizationExamplesLimit *int64 `json:"categorization_examples_limit,omitempty"`
	// ModelMemoryLimit The approximate maximum amount of memory resources that are required for
	// analytical processing. Once this limit is approached, data pruning becomes
	// more aggressive. Upon exceeding this limit, new entities are not modeled. If
	// the `xpack.ml.max_model_memory_limit` setting has a value greater than 0 and
	// less than 1024mb, that value is used instead of the default. The default
	// value is relatively small to ensure that high resource usage is a conscious
	// decision. If you have jobs that are expected to analyze high cardinality
	// fields, you will likely need to use a higher value. If you specify a number
	// instead of a string, the units are assumed to be MiB. Specifying a string is
	// recommended for clarity. If you specify a byte size unit of `b` or `kb` and
	// the number does not equate to a discrete number of megabytes, it is rounded
	// down to the closest MiB. The minimum valid value is 1 MiB. If you specify a
	// value less than 1 MiB, an error occurs. If you specify a value for the
	// `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
	// create jobs that have `model_memory_limit` values greater than that setting
	// value.
	ModelMemoryLimit ByteSize `json:"model_memory_limit,omitempty"`
}

AnalysisLimits type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L161-L172

func NewAnalysisLimits added in v8.5.0 

func NewAnalysisLimits() *AnalysisLimits

NewAnalysisLimits returns a AnalysisLimits.

func (*AnalysisLimits) UnmarshalJSON added in v8.7.1 

func (s *AnalysisLimits) UnmarshalJSON(data []byte) error

type AnalysisMemoryLimit 

type AnalysisMemoryLimit struct {
	// ModelMemoryLimit Limits can be applied for the resources required to hold the mathematical
	// models in memory. These limits are approximate and can be set per job. They
	// do not control the memory used by other processes, for example the
	// Elasticsearch Java processes.
	ModelMemoryLimit string `json:"model_memory_limit"`
}

AnalysisMemoryLimit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L174-L179

func NewAnalysisMemoryLimit added in v8.5.0 

func NewAnalysisMemoryLimit() *AnalysisMemoryLimit

NewAnalysisMemoryLimit returns a AnalysisMemoryLimit.

func (*AnalysisMemoryLimit) UnmarshalJSON added in v8.9.0 

func (s *AnalysisMemoryLimit) UnmarshalJSON(data []byte) error

type Analytics 

type Analytics struct {
	Available bool                `json:"available"`
	Enabled   bool                `json:"enabled"`
	Stats     AnalyticsStatistics `json:"stats"`
}

Analytics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L340-L342

func NewAnalytics added in v8.5.0 

func NewAnalytics() *Analytics

NewAnalytics returns a Analytics.

func (*Analytics) UnmarshalJSON added in v8.7.1 

func (s *Analytics) UnmarshalJSON(data []byte) error

type AnalyticsCollection added in v8.8.0 

type AnalyticsCollection struct {
	// EventDataStream Data stream for the collection.
	EventDataStream EventDataStream `json:"event_data_stream"`
}

AnalyticsCollection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/search_application/_types/BehavioralAnalytics.ts#L22-L27

func NewAnalyticsCollection added in v8.8.0 

func NewAnalyticsCollection() *AnalyticsCollection

NewAnalyticsCollection returns a AnalyticsCollection.

type AnalyticsStatistics 

type AnalyticsStatistics struct {
	BoxplotUsage               int64  `json:"boxplot_usage"`
	CumulativeCardinalityUsage int64  `json:"cumulative_cardinality_usage"`
	MovingPercentilesUsage     int64  `json:"moving_percentiles_usage"`
	MultiTermsUsage            *int64 `json:"multi_terms_usage,omitempty"`
	NormalizeUsage             int64  `json:"normalize_usage"`
	RateUsage                  int64  `json:"rate_usage"`
	StringStatsUsage           int64  `json:"string_stats_usage"`
	TTestUsage                 int64  `json:"t_test_usage"`
	TopMetricsUsage            int64  `json:"top_metrics_usage"`
}

AnalyticsStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L58-L68

func NewAnalyticsStatistics added in v8.5.0 

func NewAnalyticsStatistics() *AnalyticsStatistics

NewAnalyticsStatistics returns a AnalyticsStatistics.

func (*AnalyticsStatistics) UnmarshalJSON added in v8.7.1 

func (s *AnalyticsStatistics) UnmarshalJSON(data []byte) error

type AnalyzeDetail 

type AnalyzeDetail struct {
	Analyzer       *AnalyzerDetail    `json:"analyzer,omitempty"`
	Charfilters    []CharFilterDetail `json:"charfilters,omitempty"`
	CustomAnalyzer bool               `json:"custom_analyzer"`
	Tokenfilters   []TokenDetail      `json:"tokenfilters,omitempty"`
	Tokenizer      *TokenDetail       `json:"tokenizer,omitempty"`
}

AnalyzeDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L24-L30

func NewAnalyzeDetail added in v8.5.0 

func NewAnalyzeDetail() *AnalyzeDetail

NewAnalyzeDetail returns a AnalyzeDetail.

func (*AnalyzeDetail) UnmarshalJSON added in v8.7.1 

func (s *AnalyzeDetail) UnmarshalJSON(data []byte) error

type AnalyzeToken 

type AnalyzeToken struct {
	EndOffset      int64  `json:"end_offset"`
	Position       int64  `json:"position"`
	PositionLength *int64 `json:"positionLength,omitempty"`
	StartOffset    int64  `json:"start_offset"`
	Token          string `json:"token"`
	Type           string `json:"type"`
}

AnalyzeToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L37-L44

func NewAnalyzeToken added in v8.5.0 

func NewAnalyzeToken() *AnalyzeToken

NewAnalyzeToken returns a AnalyzeToken.

func (*AnalyzeToken) UnmarshalJSON added in v8.7.1 

func (s *AnalyzeToken) UnmarshalJSON(data []byte) error

type Analyzer 

type Analyzer any

Analyzer holds the union for the following types: 

CustomAnalyzer
FingerprintAnalyzer
KeywordAnalyzer
NoriAnalyzer
PatternAnalyzer
SimpleAnalyzer
StandardAnalyzer
StopAnalyzer
WhitespaceAnalyzer
IcuAnalyzer
KuromojiAnalyzer
SnowballAnalyzer
ArabicAnalyzer
ArmenianAnalyzer
BasqueAnalyzer
BengaliAnalyzer
BrazilianAnalyzer
BulgarianAnalyzer
CatalanAnalyzer
ChineseAnalyzer
CjkAnalyzer
CzechAnalyzer
DanishAnalyzer
DutchAnalyzer
EnglishAnalyzer
EstonianAnalyzer
FinnishAnalyzer
FrenchAnalyzer
GalicianAnalyzer
GermanAnalyzer
GreekAnalyzer
HindiAnalyzer
HungarianAnalyzer
IndonesianAnalyzer
IrishAnalyzer
ItalianAnalyzer
LatvianAnalyzer
LithuanianAnalyzer
NorwegianAnalyzer
PersianAnalyzer
PortugueseAnalyzer
RomanianAnalyzer
RussianAnalyzer
SerbianAnalyzer
SoraniAnalyzer
SpanishAnalyzer
SwedishAnalyzer
TurkishAnalyzer
ThaiAnalyzer

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L350-L403

type AnalyzerDetail 

type AnalyzerDetail struct {
	Name   string                `json:"name"`
	Tokens []ExplainAnalyzeToken `json:"tokens"`
}

AnalyzerDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L32-L35

func NewAnalyzerDetail added in v8.5.0 

func NewAnalyzerDetail() *AnalyzerDetail

NewAnalyzerDetail returns a AnalyzerDetail.

func (*AnalyzerDetail) UnmarshalJSON added in v8.9.0 

func (s *AnalyzerDetail) UnmarshalJSON(data []byte) error

type Anomaly 

type Anomaly struct {
	// Actual The actual value for the bucket.
	Actual []Float64 `json:"actual,omitempty"`
	// AnomalyScoreExplanation Information about the factors impacting the initial anomaly score.
	AnomalyScoreExplanation *AnomalyExplanation `json:"anomaly_score_explanation,omitempty"`
	// BucketSpan The length of the bucket in seconds. This value matches the `bucket_span`
	// that is specified in the job.
	BucketSpan int64 `json:"bucket_span"`
	// ByFieldName The field used to split the data. In particular, this property is used for
	// analyzing the splits with respect to their own history. It is used for
	// finding unusual values in the context of the split.
	ByFieldName *string `json:"by_field_name,omitempty"`
	// ByFieldValue The value of `by_field_name`.
	ByFieldValue *string `json:"by_field_value,omitempty"`
	// Causes For population analysis, an over field must be specified in the detector.
	// This property contains an array of anomaly records that are the causes for
	// the anomaly that has been identified for the over field. This sub-resource
	// contains the most anomalous records for the `over_field_name`. For
	// scalability reasons, a maximum of the 10 most significant causes of the
	// anomaly are returned. As part of the core analytical modeling, these
	// low-level anomaly records are aggregated for their parent over field record.
	// The `causes` resource contains similar elements to the record resource,
	// namely `actual`, `typical`, `geo_results.actual_point`,
	// `geo_results.typical_point`, `*_field_name` and `*_field_value`. Probability
	// and scores are not applicable to causes.
	Causes []AnomalyCause `json:"causes,omitempty"`
	// DetectorIndex A unique identifier for the detector.
	DetectorIndex int `json:"detector_index"`
	// FieldName Certain functions require a field to operate on, for example, `sum()`. For
	// those functions, this value is the name of the field to be analyzed.
	FieldName *string `json:"field_name,omitempty"`
	// Function The function in which the anomaly occurs, as specified in the detector
	// configuration. For example, `max`.
	Function *string `json:"function,omitempty"`
	// FunctionDescription The description of the function in which the anomaly occurs, as specified in
	// the detector configuration.
	FunctionDescription *string `json:"function_description,omitempty"`
	// GeoResults If the detector function is `lat_long`, this object contains comma delimited
	// strings for the latitude and longitude of the actual and typical values.
	GeoResults *GeoResults `json:"geo_results,omitempty"`
	// Influencers If influencers were specified in the detector configuration, this array
	// contains influencers that contributed to or were to blame for an anomaly.
	Influencers []Influence `json:"influencers,omitempty"`
	// InitialRecordScore A normalized score between 0-100, which is based on the probability of the
	// anomalousness of this record. This is the initial value that was calculated
	// at the time the bucket was processed.
	InitialRecordScore Float64 `json:"initial_record_score"`
	// IsInterim If true, this is an interim result. In other words, the results are
	// calculated based on partial input data.
	IsInterim bool `json:"is_interim"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// OverFieldName The field used to split the data. In particular, this property is used for
	// analyzing the splits with respect to the history of all splits. It is used
	// for finding unusual values in the population of all splits.
	OverFieldName *string `json:"over_field_name,omitempty"`
	// OverFieldValue The value of `over_field_name`.
	OverFieldValue *string `json:"over_field_value,omitempty"`
	// PartitionFieldName The field used to segment the analysis. When you use this property, you have
	// completely independent baselines for each value of this field.
	PartitionFieldName *string `json:"partition_field_name,omitempty"`
	// PartitionFieldValue The value of `partition_field_name`.
	PartitionFieldValue *string `json:"partition_field_value,omitempty"`
	// Probability The probability of the individual anomaly occurring, in the range 0 to 1. For
	// example, `0.0000772031`. This value can be held to a high precision of over
	// 300 decimal places, so the `record_score` is provided as a human-readable and
	// friendly interpretation of this.
	Probability Float64 `json:"probability"`
	// RecordScore A normalized score between 0-100, which is based on the probability of the
	// anomalousness of this record. Unlike `initial_record_score`, this value will
	// be updated by a re-normalization process as new data is analyzed.
	RecordScore Float64 `json:"record_score"`
	// ResultType Internal. This is always set to `record`.
	ResultType string `json:"result_type"`
	// Timestamp The start time of the bucket for which these results were calculated.
	Timestamp int64 `json:"timestamp"`
	// Typical The typical value for the bucket, according to analytical modeling.
	Typical []Float64 `json:"typical,omitempty"`
}

Anomaly type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Anomaly.ts#L24-L121

func NewAnomaly added in v8.5.0 

func NewAnomaly() *Anomaly

NewAnomaly returns a Anomaly.

func (*Anomaly) UnmarshalJSON added in v8.7.1 

func (s *Anomaly) UnmarshalJSON(data []byte) error

type AnomalyCause 

type AnomalyCause struct {
	Actual                 []Float64   `json:"actual,omitempty"`
	ByFieldName            *string     `json:"by_field_name,omitempty"`
	ByFieldValue           *string     `json:"by_field_value,omitempty"`
	CorrelatedByFieldValue *string     `json:"correlated_by_field_value,omitempty"`
	FieldName              *string     `json:"field_name,omitempty"`
	Function               *string     `json:"function,omitempty"`
	FunctionDescription    *string     `json:"function_description,omitempty"`
	GeoResults             *GeoResults `json:"geo_results,omitempty"`
	Influencers            []Influence `json:"influencers,omitempty"`
	OverFieldName          *string     `json:"over_field_name,omitempty"`
	OverFieldValue         *string     `json:"over_field_value,omitempty"`
	PartitionFieldName     *string     `json:"partition_field_name,omitempty"`
	PartitionFieldValue    *string     `json:"partition_field_value,omitempty"`
	Probability            Float64     `json:"probability"`
	Typical                []Float64   `json:"typical,omitempty"`
}

AnomalyCause type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Anomaly.ts#L123-L139

func NewAnomalyCause added in v8.5.0 

func NewAnomalyCause() *AnomalyCause

NewAnomalyCause returns a AnomalyCause.

func (*AnomalyCause) UnmarshalJSON added in v8.7.1 

func (s *AnomalyCause) UnmarshalJSON(data []byte) error

type AnomalyDetectors 

type AnomalyDetectors struct {
	CategorizationAnalyzer               CategorizationAnalyzer `json:"categorization_analyzer"`
	CategorizationExamplesLimit          int                    `json:"categorization_examples_limit"`
	DailyModelSnapshotRetentionAfterDays int                    `json:"daily_model_snapshot_retention_after_days"`
	ModelMemoryLimit                     string                 `json:"model_memory_limit"`
	ModelSnapshotRetentionDays           int                    `json:"model_snapshot_retention_days"`
}

AnomalyDetectors type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/info/types.ts#L46-L52

func NewAnomalyDetectors added in v8.5.0 

func NewAnomalyDetectors() *AnomalyDetectors

NewAnomalyDetectors returns a AnomalyDetectors.

func (*AnomalyDetectors) UnmarshalJSON added in v8.7.0 

func (s *AnomalyDetectors) UnmarshalJSON(data []byte) error

type AnomalyExplanation added in v8.6.0 

type AnomalyExplanation struct {
	// AnomalyCharacteristicsImpact Impact from the duration and magnitude of the detected anomaly relative to
	// the historical average.
	AnomalyCharacteristicsImpact *int `json:"anomaly_characteristics_impact,omitempty"`
	// AnomalyLength Length of the detected anomaly in the number of buckets.
	AnomalyLength *int `json:"anomaly_length,omitempty"`
	// AnomalyType Type of the detected anomaly: `spike` or `dip`.
	AnomalyType *string `json:"anomaly_type,omitempty"`
	// HighVariancePenalty Indicates reduction of anomaly score for the bucket with large confidence
	// intervals. If a bucket has large confidence intervals, the score is reduced.
	HighVariancePenalty *bool `json:"high_variance_penalty,omitempty"`
	// IncompleteBucketPenalty If the bucket contains fewer samples than expected, the score is reduced.
	IncompleteBucketPenalty *bool `json:"incomplete_bucket_penalty,omitempty"`
	// LowerConfidenceBound Lower bound of the 95% confidence interval.
	LowerConfidenceBound *Float64 `json:"lower_confidence_bound,omitempty"`
	// MultiBucketImpact Impact of the deviation between actual and typical values in the past 12
	// buckets.
	MultiBucketImpact *int `json:"multi_bucket_impact,omitempty"`
	// SingleBucketImpact Impact of the deviation between actual and typical values in the current
	// bucket.
	SingleBucketImpact *int `json:"single_bucket_impact,omitempty"`
	// TypicalValue Typical (expected) value for this bucket.
	TypicalValue *Float64 `json:"typical_value,omitempty"`
	// UpperConfidenceBound Upper bound of the 95% confidence interval.
	UpperConfidenceBound *Float64 `json:"upper_confidence_bound,omitempty"`
}

AnomalyExplanation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Anomaly.ts#L157-L198

func NewAnomalyExplanation added in v8.6.0 

func NewAnomalyExplanation() *AnomalyExplanation

NewAnomalyExplanation returns a AnomalyExplanation.

func (*AnomalyExplanation) UnmarshalJSON added in v8.7.1 

func (s *AnomalyExplanation) UnmarshalJSON(data []byte) error

type AnthropicServiceSettings added in v8.18.0 

type AnthropicServiceSettings struct {
	// ApiKey A valid API key for the Anthropic API.
	ApiKey string `json:"api_key"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the Anthropic documentation for the list of supported models.
	ModelId string `json:"model_id"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Anthropic.
	// By default, the `anthropic` service sets the number of requests allowed per
	// minute to 50.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
}

AnthropicServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L445-L461

func NewAnthropicServiceSettings added in v8.18.0 

func NewAnthropicServiceSettings() *AnthropicServiceSettings

NewAnthropicServiceSettings returns a AnthropicServiceSettings.

func (*AnthropicServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *AnthropicServiceSettings) UnmarshalJSON(data []byte) error

type AnthropicTaskSettings added in v8.18.0 

type AnthropicTaskSettings struct {
	// MaxTokens For a `completion` task, it is the maximum number of tokens to generate
	// before stopping.
	MaxTokens int `json:"max_tokens"`
	// Temperature For a `completion` task, it is the amount of randomness injected into the
	// response.
	// For more details about the supported range, refer to Anthropic documentation.
	Temperature *float32 `json:"temperature,omitempty"`
	// TopK For a `completion` task, it specifies to only sample from the top K options
	// for each subsequent token.
	// It is recommended for advanced use cases only.
	// You usually only need to use `temperature`.
	TopK *int `json:"top_k,omitempty"`
	// TopP For a `completion` task, it specifies to use Anthropic's nucleus sampling.
	// In nucleus sampling, Anthropic computes the cumulative distribution over all
	// the options for each subsequent token in decreasing probability order and
	// cuts it off once it reaches the specified probability.
	// You should either alter `temperature` or `top_p`, but not both.
	// It is recommended for advanced use cases only.
	// You usually only need to use `temperature`.
	TopP *float32 `json:"top_p,omitempty"`
}

AnthropicTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L463-L488

func NewAnthropicTaskSettings added in v8.18.0 

func NewAnthropicTaskSettings() *AnthropicTaskSettings

NewAnthropicTaskSettings returns a AnthropicTaskSettings.

func (*AnthropicTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *AnthropicTaskSettings) UnmarshalJSON(data []byte) error

type ApiKey 

type ApiKey struct {
	// Access The access granted to cross-cluster API keys.
	// The access is composed of permissions for cross cluster search and cross
	// cluster replication.
	// At least one of them must be specified.
	// When specified, the new access assignment fully replaces the previously
	// assigned access.
	Access *Access `json:"access,omitempty"`
	// Creation Creation time for the API key in milliseconds.
	Creation int64 `json:"creation"`
	// Expiration Expiration time for the API key in milliseconds.
	Expiration *int64 `json:"expiration,omitempty"`
	// Id Id for the API key
	Id string `json:"id"`
	// Invalidated Invalidation status for the API key.
	// If the key has been invalidated, it has a value of `true`. Otherwise, it is
	// `false`.
	Invalidated bool `json:"invalidated"`
	// Invalidation If the key has been invalidated, invalidation time in milliseconds.
	Invalidation *int64 `json:"invalidation,omitempty"`
	// LimitedBy The owner user’s permissions associated with the API key.
	// It is a point-in-time snapshot captured at creation and subsequent updates.
	// An API key’s effective permissions are an intersection of its assigned
	// privileges and the owner user’s permissions.
	LimitedBy []map[string]RoleDescriptor `json:"limited_by,omitempty"`
	// Metadata Metadata of the API key
	Metadata Metadata `json:"metadata"`
	// Name Name of the API key.
	Name string `json:"name"`
	// ProfileUid The profile uid for the API key owner principal, if requested and if it
	// exists
	ProfileUid *string `json:"profile_uid,omitempty"`
	// Realm Realm name of the principal for which this API key was created.
	Realm string `json:"realm"`
	// RealmType Realm type of the principal for which this API key was created
	RealmType *string `json:"realm_type,omitempty"`
	// RoleDescriptors The role descriptors assigned to this API key when it was created or last
	// updated.
	// An empty role descriptor means the API key inherits the owner user’s
	// permissions.
	RoleDescriptors map[string]RoleDescriptor `json:"role_descriptors,omitempty"`
	// Sort_ Sorting values when using the `sort` parameter with the
	// `security.query_api_keys` API.
	Sort_ []FieldValue `json:"_sort,omitempty"`
	// Type The type of the API key (e.g. `rest` or `cross_cluster`).
	Type apikeytype.ApiKeyType `json:"type"`
	// Username Principal for which this API key was created
	Username string `json:"username"`
}

ApiKey type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/ApiKey.ts#L27-L113

func NewApiKey added in v8.5.0 

func NewApiKey() *ApiKey

NewApiKey returns a ApiKey.

func (*ApiKey) UnmarshalJSON added in v8.7.1 

func (s *ApiKey) UnmarshalJSON(data []byte) error

type ApiKeyAggregate added in v8.13.0 

type ApiKeyAggregate any

ApiKeyAggregate holds the union for the following types: 

CardinalityAggregate
ValueCountAggregate
StringTermsAggregate
LongTermsAggregate
DoubleTermsAggregate
UnmappedTermsAggregate
MultiTermsAggregate
MissingAggregate
FilterAggregate
FiltersAggregate
RangeAggregate
DateRangeAggregate
CompositeAggregate

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_api_keys/types.ts#L122-L139

type ApiKeyAggregationContainer added in v8.13.0 

type ApiKeyAggregationContainer struct {
	// Aggregations Sub-aggregations for this aggregation.
	// Only applies to bucket aggregations.
	Aggregations map[string]ApiKeyAggregationContainer `json:"aggregations,omitempty"`
	// Cardinality A single-value metrics aggregation that calculates an approximate count of
	// distinct values.
	Cardinality *CardinalityAggregation `json:"cardinality,omitempty"`
	// Composite A multi-bucket aggregation that creates composite buckets from different
	// sources.
	// Unlike the other multi-bucket aggregations, you can use the `composite`
	// aggregation to paginate *all* buckets from a multi-level aggregation
	// efficiently.
	Composite *CompositeAggregation `json:"composite,omitempty"`
	// DateRange A multi-bucket value source based aggregation that enables the user to define
	// a set of date ranges - each representing a bucket.
	DateRange *DateRangeAggregation `json:"date_range,omitempty"`
	// Filter A single bucket aggregation that narrows the set of documents to those that
	// match a query.
	Filter *ApiKeyQueryContainer `json:"filter,omitempty"`
	// Filters A multi-bucket aggregation where each bucket contains the documents that
	// match a query.
	Filters *ApiKeyFiltersAggregation `json:"filters,omitempty"`
	Meta    Metadata                  `json:"meta,omitempty"`
	Missing *MissingAggregation       `json:"missing,omitempty"`
	// Range A multi-bucket value source based aggregation that enables the user to define
	// a set of ranges - each representing a bucket.
	Range *RangeAggregation `json:"range,omitempty"`
	// Terms A multi-bucket value source based aggregation where buckets are dynamically
	// built - one per unique value.
	Terms *TermsAggregation `json:"terms,omitempty"`
	// ValueCount A single-value metrics aggregation that counts the number of values that are
	// extracted from the aggregated documents.
	ValueCount *ValueCountAggregation `json:"value_count,omitempty"`
}

ApiKeyAggregationContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_api_keys/types.ts#L63-L120

func NewApiKeyAggregationContainer added in v8.13.0 

func NewApiKeyAggregationContainer() *ApiKeyAggregationContainer

NewApiKeyAggregationContainer returns a ApiKeyAggregationContainer.

func (*ApiKeyAggregationContainer) UnmarshalJSON added in v8.13.0 

func (s *ApiKeyAggregationContainer) UnmarshalJSON(data []byte) error

type ApiKeyAuthorization 

type ApiKeyAuthorization struct {
	// Id The identifier for the API key.
	Id string `json:"id"`
	// Name The name of the API key.
	Name string `json:"name"`
}

ApiKeyAuthorization type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Authorization.ts#L20-L29

func NewApiKeyAuthorization added in v8.5.0 

func NewApiKeyAuthorization() *ApiKeyAuthorization

NewApiKeyAuthorization returns a ApiKeyAuthorization.

func (*ApiKeyAuthorization) UnmarshalJSON added in v8.9.0 

func (s *ApiKeyAuthorization) UnmarshalJSON(data []byte) error

type ApiKeyFiltersAggregation added in v8.13.0 

type ApiKeyFiltersAggregation struct {
	// Filters Collection of queries from which to build buckets.
	Filters BucketsApiKeyQueryContainer `json:"filters,omitempty"`
	// Keyed By default, the named filters aggregation returns the buckets as an object.
	// Set to `false` to return the buckets as an array of objects.
	Keyed *bool `json:"keyed,omitempty"`
	// OtherBucket Set to `true` to add a bucket to the response which will contain all
	// documents that do not match any of the given filters.
	OtherBucket *bool `json:"other_bucket,omitempty"`
	// OtherBucketKey The key with which the other bucket is returned.
	OtherBucketKey *string `json:"other_bucket_key,omitempty"`
}

ApiKeyFiltersAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_api_keys/types.ts#L207-L227

func NewApiKeyFiltersAggregation added in v8.13.0 

func NewApiKeyFiltersAggregation() *ApiKeyFiltersAggregation

NewApiKeyFiltersAggregation returns a ApiKeyFiltersAggregation.

func (*ApiKeyFiltersAggregation) UnmarshalJSON added in v8.13.0 

func (s *ApiKeyFiltersAggregation) UnmarshalJSON(data []byte) error

type ApiKeyQueryContainer added in v8.13.0 

type ApiKeyQueryContainer struct {
	// Bool Matches documents matching boolean combinations of other queries.
	Bool *BoolQuery `json:"bool,omitempty"`
	// Exists Returns documents that contain an indexed value for a field.
	Exists *ExistsQuery `json:"exists,omitempty"`
	// Ids Returns documents based on their IDs.
	// This query uses document IDs stored in the `_id` field.
	Ids *IdsQuery `json:"ids,omitempty"`
	// Match Returns documents that match a provided text, number, date or boolean value.
	// The provided text is analyzed before matching.
	Match map[string]MatchQuery `json:"match,omitempty"`
	// MatchAll Matches all documents, giving them all a `_score` of 1.0.
	MatchAll *MatchAllQuery `json:"match_all,omitempty"`
	// Prefix Returns documents that contain a specific prefix in a provided field.
	Prefix map[string]PrefixQuery `json:"prefix,omitempty"`
	// Range Returns documents that contain terms within a provided range.
	Range map[string]RangeQuery `json:"range,omitempty"`
	// SimpleQueryString Returns documents based on a provided query string, using a parser with a
	// limited but fault-tolerant syntax.
	SimpleQueryString *SimpleQueryStringQuery `json:"simple_query_string,omitempty"`
	// Term Returns documents that contain an exact term in a provided field.
	// To return a document, the query term must exactly match the queried field's
	// value, including whitespace and capitalization.
	Term map[string]TermQuery `json:"term,omitempty"`
	// Terms Returns documents that contain one or more exact terms in a provided field.
	// To return a document, one or more terms must exactly match a field value,
	// including whitespace and capitalization.
	Terms *TermsQuery `json:"terms,omitempty"`
	// Wildcard Returns documents that contain terms matching a wildcard pattern.
	Wildcard map[string]WildcardQuery `json:"wildcard,omitempty"`
}

ApiKeyQueryContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_api_keys/types.ts#L141-L205

func NewApiKeyQueryContainer added in v8.13.0 

func NewApiKeyQueryContainer() *ApiKeyQueryContainer

NewApiKeyQueryContainer returns a ApiKeyQueryContainer.

func (*ApiKeyQueryContainer) UnmarshalJSON added in v8.15.0 

func (s *ApiKeyQueryContainer) UnmarshalJSON(data []byte) error

type ApostropheTokenFilter added in v8.18.1 

type ApostropheTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ApostropheTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L450-L452

func NewApostropheTokenFilter added in v8.18.1 

func NewApostropheTokenFilter() *ApostropheTokenFilter

NewApostropheTokenFilter returns a ApostropheTokenFilter.

func (ApostropheTokenFilter) MarshalJSON added in v8.18.1 

func (s ApostropheTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ApostropheTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *ApostropheTokenFilter) UnmarshalJSON(data []byte) error

type AppendProcessor 

type AppendProcessor struct {
	// AllowDuplicates If `false`, the processor does not append values already present in the
	// field.
	AllowDuplicates *bool `json:"allow_duplicates,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to be appended to.
	// Supports template snippets.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// Value The value to be appended. Supports template snippets.
	Value []json.RawMessage `json:"value"`
}

AppendProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L328-L343

func NewAppendProcessor added in v8.5.0 

func NewAppendProcessor() *AppendProcessor

NewAppendProcessor returns a AppendProcessor.

func (*AppendProcessor) UnmarshalJSON added in v8.7.1 

func (s *AppendProcessor) UnmarshalJSON(data []byte) error

type ApplicationGlobalUserPrivileges 

type ApplicationGlobalUserPrivileges struct {
	Manage ManageUserPrivileges `json:"manage"`
}

ApplicationGlobalUserPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L434-L436

func NewApplicationGlobalUserPrivileges added in v8.5.0 

func NewApplicationGlobalUserPrivileges() *ApplicationGlobalUserPrivileges

NewApplicationGlobalUserPrivileges returns a ApplicationGlobalUserPrivileges.

type ApplicationPrivileges 

type ApplicationPrivileges struct {
	// Application The name of the application to which this entry applies.
	Application string `json:"application"`
	// Privileges A list of strings, where each element is the name of an application privilege
	// or action.
	Privileges []string `json:"privileges"`
	// Resources A list resources to which the privileges are applied.
	Resources []string `json:"resources"`
}

ApplicationPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L27-L40

func NewApplicationPrivileges added in v8.5.0 

func NewApplicationPrivileges() *ApplicationPrivileges

NewApplicationPrivileges returns a ApplicationPrivileges.

func (*ApplicationPrivileges) UnmarshalJSON added in v8.9.0 

func (s *ApplicationPrivileges) UnmarshalJSON(data []byte) error

type ApplicationPrivilegesCheck 

type ApplicationPrivilegesCheck struct {
	// Application The name of the application.
	Application string `json:"application"`
	// Privileges A list of the privileges that you want to check for the specified resources.
	// It may be either application privilege names or the names of actions that are
	// granted by those privileges
	Privileges []string `json:"privileges"`
	// Resources A list of resource names against which the privileges should be checked.
	Resources []string `json:"resources"`
}

ApplicationPrivilegesCheck type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges/types.ts#L24-L32

func NewApplicationPrivilegesCheck added in v8.5.0 

func NewApplicationPrivilegesCheck() *ApplicationPrivilegesCheck

NewApplicationPrivilegesCheck returns a ApplicationPrivilegesCheck.

func (*ApplicationPrivilegesCheck) UnmarshalJSON added in v8.9.0 

func (s *ApplicationPrivilegesCheck) UnmarshalJSON(data []byte) error

type ApplicationsPrivileges 

type ApplicationsPrivileges map[string]ResourcePrivileges

ApplicationsPrivileges type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges/types.ts#L47-L47

type ArabicAnalyzer added in v8.16.0 

type ArabicAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

ArabicAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L52-L57

func NewArabicAnalyzer added in v8.16.0 

func NewArabicAnalyzer() *ArabicAnalyzer

NewArabicAnalyzer returns a ArabicAnalyzer.

func (ArabicAnalyzer) MarshalJSON added in v8.16.0 

func (s ArabicAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ArabicAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *ArabicAnalyzer) UnmarshalJSON(data []byte) error

type ArabicNormalizationTokenFilter added in v8.18.1 

type ArabicNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ArabicNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L454-L456

func NewArabicNormalizationTokenFilter added in v8.18.1 

func NewArabicNormalizationTokenFilter() *ArabicNormalizationTokenFilter

NewArabicNormalizationTokenFilter returns a ArabicNormalizationTokenFilter.

func (ArabicNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s ArabicNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ArabicNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *ArabicNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type Archive 

type Archive struct {
	Available    bool  `json:"available"`
	Enabled      bool  `json:"enabled"`
	IndicesCount int64 `json:"indices_count"`
}

Archive type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L45-L47

func NewArchive added in v8.5.0 

func NewArchive() *Archive

NewArchive returns a Archive.

func (*Archive) UnmarshalJSON added in v8.7.1 

func (s *Archive) UnmarshalJSON(data []byte) error

type ArmenianAnalyzer added in v8.16.0 

type ArmenianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

ArmenianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L59-L64

func NewArmenianAnalyzer added in v8.16.0 

func NewArmenianAnalyzer() *ArmenianAnalyzer

NewArmenianAnalyzer returns a ArmenianAnalyzer.

func (ArmenianAnalyzer) MarshalJSON added in v8.16.0 

func (s ArmenianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ArmenianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *ArmenianAnalyzer) UnmarshalJSON(data []byte) error

type ArrayCompareCondition 

type ArrayCompareCondition struct {
	ArrayCompareCondition map[conditionop.ConditionOp]ArrayCompareOpParams `json:"-"`
	Path                  string                                           `json:"path"`
}

ArrayCompareCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L32-L39

func NewArrayCompareCondition added in v8.5.0 

func NewArrayCompareCondition() *ArrayCompareCondition

NewArrayCompareCondition returns a ArrayCompareCondition.

func (ArrayCompareCondition) MarshalJSON added in v8.5.0 

func (s ArrayCompareCondition) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ArrayCompareCondition) UnmarshalJSON added in v8.9.0 

func (s *ArrayCompareCondition) UnmarshalJSON(data []byte) error

type ArrayCompareOpParams added in v8.5.0 

type ArrayCompareOpParams struct {
	Quantifier quantifier.Quantifier `json:"quantifier"`
	Value      FieldValue            `json:"value"`
}

ArrayCompareOpParams type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L27-L30

func NewArrayCompareOpParams added in v8.5.0 

func NewArrayCompareOpParams() *ArrayCompareOpParams

NewArrayCompareOpParams returns a ArrayCompareOpParams.

func (*ArrayCompareOpParams) UnmarshalJSON added in v8.7.1 

func (s *ArrayCompareOpParams) UnmarshalJSON(data []byte) error

type ArrayPercentilesItem 

type ArrayPercentilesItem struct {
	Key           string   `json:"key"`
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

ArrayPercentilesItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L162-L166

func NewArrayPercentilesItem added in v8.5.0 

func NewArrayPercentilesItem() *ArrayPercentilesItem

NewArrayPercentilesItem returns a ArrayPercentilesItem.

func (*ArrayPercentilesItem) UnmarshalJSON added in v8.7.1 

func (s *ArrayPercentilesItem) UnmarshalJSON(data []byte) error

type AsciiFoldingTokenFilter 

type AsciiFoldingTokenFilter struct {
	// PreserveOriginal If `true`, emit both original tokens and folded tokens. Defaults to `false`.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	Type             string             `json:"type,omitempty"`
	Version          *string            `json:"version,omitempty"`
}

AsciiFoldingTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L213-L217

func NewAsciiFoldingTokenFilter added in v8.5.0 

func NewAsciiFoldingTokenFilter() *AsciiFoldingTokenFilter

NewAsciiFoldingTokenFilter returns a AsciiFoldingTokenFilter.

func (AsciiFoldingTokenFilter) MarshalJSON added in v8.9.0 

func (s AsciiFoldingTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*AsciiFoldingTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *AsciiFoldingTokenFilter) UnmarshalJSON(data []byte) error

type AsyncSearch 

type AsyncSearch struct {
	// Aggregations Partial aggregations results, coming from the shards that have already
	// completed running the query.
	Aggregations map[string]Aggregate       `json:"aggregations,omitempty"`
	Clusters_    *ClusterStatistics         `json:"_clusters,omitempty"`
	Fields       map[string]json.RawMessage `json:"fields,omitempty"`
	Hits         HitsMetadata               `json:"hits"`
	MaxScore     *Float64                   `json:"max_score,omitempty"`
	// NumReducePhases Indicates how many reductions of the results have been performed.
	// If this number increases compared to the last retrieved results for a get
	// asynch search request, you can expect additional results included in the
	// search response.
	NumReducePhases *int64   `json:"num_reduce_phases,omitempty"`
	PitId           *string  `json:"pit_id,omitempty"`
	Profile         *Profile `json:"profile,omitempty"`
	ScrollId_       *string  `json:"_scroll_id,omitempty"`
	// Shards_ Indicates how many shards have run the query.
	// Note that in order for shard results to be included in the search response,
	// they need to be reduced first.
	Shards_         ShardStatistics      `json:"_shards"`
	Suggest         map[string][]Suggest `json:"suggest,omitempty"`
	TerminatedEarly *bool                `json:"terminated_early,omitempty"`
	TimedOut        bool                 `json:"timed_out"`
	Took            int64                `json:"took"`
}

AsyncSearch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/async_search/_types/AsyncSearch.ts#L30-L56

func NewAsyncSearch added in v8.5.0 

func NewAsyncSearch() *AsyncSearch

NewAsyncSearch returns a AsyncSearch.

func (*AsyncSearch) UnmarshalJSON added in v8.7.0 

func (s *AsyncSearch) UnmarshalJSON(data []byte) error

type AttachmentProcessor 

type AttachmentProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to get the base64 encoded field from.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and field does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// IndexedChars The number of chars being used for extraction to prevent huge fields.
	// Use `-1` for no limit.
	IndexedChars *int64 `json:"indexed_chars,omitempty"`
	// IndexedCharsField Field name from which you can overwrite the number of chars being used for
	// extraction.
	IndexedCharsField *string `json:"indexed_chars_field,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Properties Array of properties to select to be stored.
	// Can be `content`, `title`, `name`, `author`, `keywords`, `date`,
	// `content_type`, `content_length`, `language`.
	Properties []string `json:"properties,omitempty"`
	// RemoveBinary If true, the binary field will be removed from the document
	RemoveBinary *bool `json:"remove_binary,omitempty"`
	// ResourceName Field containing the name of the resource to decode.
	// If specified, the processor passes this resource name to the underlying Tika
	// library to enable Resource Name Based Detection.
	ResourceName *string `json:"resource_name,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that will hold the attachment information.
	TargetField *string `json:"target_field,omitempty"`
}

AttachmentProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L345-L386

func NewAttachmentProcessor added in v8.5.0 

func NewAttachmentProcessor() *AttachmentProcessor

NewAttachmentProcessor returns a AttachmentProcessor.

func (*AttachmentProcessor) UnmarshalJSON added in v8.7.1 

func (s *AttachmentProcessor) UnmarshalJSON(data []byte) error

type Audit 

type Audit struct {
	Enabled bool     `json:"enabled"`
	Outputs []string `json:"outputs,omitempty"`
}

Audit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L70-L72

func NewAudit added in v8.5.0 

func NewAudit() *Audit

NewAudit returns a Audit.

func (*Audit) UnmarshalJSON added in v8.7.1 

func (s *Audit) UnmarshalJSON(data []byte) error

type AuthenticateApiKey added in v8.17.0 

type AuthenticateApiKey struct {
	Id   string  `json:"id"`
	Name *string `json:"name,omitempty"`
}

AuthenticateApiKey type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/authenticate/SecurityAuthenticateResponse.ts#L44-L47

func NewAuthenticateApiKey added in v8.17.0 

func NewAuthenticateApiKey() *AuthenticateApiKey

NewAuthenticateApiKey returns a AuthenticateApiKey.

func (*AuthenticateApiKey) UnmarshalJSON added in v8.17.0 

func (s *AuthenticateApiKey) UnmarshalJSON(data []byte) error

type AuthenticateToken added in v8.5.0 

type AuthenticateToken struct {
	Name string  `json:"name"`
	Type *string `json:"type,omitempty"`
}

AuthenticateToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/authenticate/types.ts#L22-L29

func NewAuthenticateToken added in v8.5.0 

func NewAuthenticateToken() *AuthenticateToken

NewAuthenticateToken returns a AuthenticateToken.

func (*AuthenticateToken) UnmarshalJSON added in v8.7.1 

func (s *AuthenticateToken) UnmarshalJSON(data []byte) error

type AuthenticatedUser 

type AuthenticatedUser struct {
	AuthenticationProvider *AuthenticationProvider `json:"authentication_provider,omitempty"`
	AuthenticationRealm    UserRealm               `json:"authentication_realm"`
	AuthenticationType     string                  `json:"authentication_type"`
	Email                  *string                 `json:"email,omitempty"`
	Enabled                bool                    `json:"enabled"`
	FullName               *string                 `json:"full_name,omitempty"`
	LookupRealm            UserRealm               `json:"lookup_realm"`
	Metadata               Metadata                `json:"metadata"`
	ProfileUid             *string                 `json:"profile_uid,omitempty"`
	Roles                  []string                `json:"roles"`
	Username               string                  `json:"username"`
}

AuthenticatedUser type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_token/types.ts#L60-L65

func NewAuthenticatedUser added in v8.5.0 

func NewAuthenticatedUser() *AuthenticatedUser

NewAuthenticatedUser returns a AuthenticatedUser.

func (*AuthenticatedUser) UnmarshalJSON added in v8.7.1 

func (s *AuthenticatedUser) UnmarshalJSON(data []byte) error

type Authentication added in v8.18.0 

type Authentication struct {
	ApiKey              map[string]string   `json:"api_key,omitempty"`
	AuthenticationRealm AuthenticationRealm `json:"authentication_realm"`
	AuthenticationType  string              `json:"authentication_type"`
	Email               *string             `json:"email,omitempty"`
	Enabled             bool                `json:"enabled"`
	FullName            *string             `json:"full_name,omitempty"`
	LookupRealm         AuthenticationRealm `json:"lookup_realm"`
	Metadata            Metadata            `json:"metadata"`
	Roles               []string            `json:"roles"`
	Token               map[string]string   `json:"token,omitempty"`
	Username            string              `json:"username"`
}

Authentication type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/delegate_pki/SecurityDelegatePkiResponse.ts#L43-L55

func NewAuthentication added in v8.18.0 

func NewAuthentication() *Authentication

NewAuthentication returns a Authentication.

func (*Authentication) UnmarshalJSON added in v8.18.0 

func (s *Authentication) UnmarshalJSON(data []byte) error

type AuthenticationProvider 

type AuthenticationProvider struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

AuthenticationProvider type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_token/types.ts#L55-L58

func NewAuthenticationProvider added in v8.5.0 

func NewAuthenticationProvider() *AuthenticationProvider

NewAuthenticationProvider returns a AuthenticationProvider.

func (*AuthenticationProvider) UnmarshalJSON added in v8.7.1 

func (s *AuthenticationProvider) UnmarshalJSON(data []byte) error

type AuthenticationRealm added in v8.18.0 

type AuthenticationRealm struct {
	Domain *string `json:"domain,omitempty"`
	Name   string  `json:"name"`
	Type   string  `json:"type"`
}

AuthenticationRealm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/delegate_pki/SecurityDelegatePkiResponse.ts#L57-L61

func NewAuthenticationRealm added in v8.18.0 

func NewAuthenticationRealm() *AuthenticationRealm

NewAuthenticationRealm returns a AuthenticationRealm.

func (*AuthenticationRealm) UnmarshalJSON added in v8.18.0 

func (s *AuthenticationRealm) UnmarshalJSON(data []byte) error

type AutoDateHistogramAggregate 

type AutoDateHistogramAggregate struct {
	Buckets  BucketsDateHistogramBucket `json:"buckets"`
	Interval string                     `json:"interval"`
	Meta     Metadata                   `json:"meta,omitempty"`
}

AutoDateHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L393-L400

func NewAutoDateHistogramAggregate added in v8.5.0 

func NewAutoDateHistogramAggregate() *AutoDateHistogramAggregate

NewAutoDateHistogramAggregate returns a AutoDateHistogramAggregate.

func (*AutoDateHistogramAggregate) UnmarshalJSON added in v8.7.0 

func (s *AutoDateHistogramAggregate) UnmarshalJSON(data []byte) error

type AutoDateHistogramAggregation 

type AutoDateHistogramAggregation struct {
	// Buckets The target number of buckets.
	Buckets *int `json:"buckets,omitempty"`
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Format The date format used to format `key_as_string` in the response.
	// If no `format` is specified, the first date format specified in the field
	// mapping is used.
	Format *string `json:"format,omitempty"`
	// MinimumInterval The minimum rounding interval.
	// This can make the collection process more efficient, as the aggregation will
	// not attempt to round at any interval lower than `minimum_interval`.
	MinimumInterval *minimuminterval.MinimumInterval `json:"minimum_interval,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing DateTime `json:"missing,omitempty"`
	// Offset Time zone specified as a ISO 8601 UTC offset.
	Offset *string                    `json:"offset,omitempty"`
	Params map[string]json.RawMessage `json:"params,omitempty"`
	Script *Script                    `json:"script,omitempty"`
	// TimeZone Time zone ID.
	TimeZone *string `json:"time_zone,omitempty"`
}

AutoDateHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L72-L110

func NewAutoDateHistogramAggregation added in v8.5.0 

func NewAutoDateHistogramAggregation() *AutoDateHistogramAggregation

NewAutoDateHistogramAggregation returns a AutoDateHistogramAggregation.

func (*AutoDateHistogramAggregation) UnmarshalJSON added in v8.7.1 

func (s *AutoDateHistogramAggregation) UnmarshalJSON(data []byte) error

type AutoFollowPattern 

type AutoFollowPattern struct {
	Name    string                   `json:"name"`
	Pattern AutoFollowPatternSummary `json:"pattern"`
}

AutoFollowPattern type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/get_auto_follow_pattern/types.ts#L23-L26

func NewAutoFollowPattern added in v8.5.0 

func NewAutoFollowPattern() *AutoFollowPattern

NewAutoFollowPattern returns a AutoFollowPattern.

func (*AutoFollowPattern) UnmarshalJSON added in v8.7.1 

func (s *AutoFollowPattern) UnmarshalJSON(data []byte) error

type AutoFollowPatternSummary 

type AutoFollowPatternSummary struct {
	Active bool `json:"active"`
	// FollowIndexPattern The name of follower index.
	FollowIndexPattern *string `json:"follow_index_pattern,omitempty"`
	// LeaderIndexExclusionPatterns An array of simple index patterns that can be used to exclude indices from
	// being auto-followed.
	LeaderIndexExclusionPatterns []string `json:"leader_index_exclusion_patterns"`
	// LeaderIndexPatterns An array of simple index patterns to match against indices in the remote
	// cluster specified by the remote_cluster field.
	LeaderIndexPatterns []string `json:"leader_index_patterns"`
	// MaxOutstandingReadRequests The maximum number of outstanding reads requests from the remote cluster.
	MaxOutstandingReadRequests int `json:"max_outstanding_read_requests"`
	// RemoteCluster The remote cluster containing the leader indices to match against.
	RemoteCluster string `json:"remote_cluster"`
}

AutoFollowPatternSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/get_auto_follow_pattern/types.ts#L28-L52

func NewAutoFollowPatternSummary added in v8.5.0 

func NewAutoFollowPatternSummary() *AutoFollowPatternSummary

NewAutoFollowPatternSummary returns a AutoFollowPatternSummary.

func (*AutoFollowPatternSummary) UnmarshalJSON added in v8.7.1 

func (s *AutoFollowPatternSummary) UnmarshalJSON(data []byte) error

type AutoFollowStats 

type AutoFollowStats struct {
	AutoFollowedClusters []AutoFollowedCluster `json:"auto_followed_clusters"`
	// NumberOfFailedFollowIndices The number of indices that the auto-follow coordinator failed to
	// automatically follow.
	// The causes of recent failures are captured in the logs of the elected master
	// node and in the `auto_follow_stats.recent_auto_follow_errors` field.
	NumberOfFailedFollowIndices int64 `json:"number_of_failed_follow_indices"`
	// NumberOfFailedRemoteClusterStateRequests The number of times that the auto-follow coordinator failed to retrieve the
	// cluster state from a remote cluster registered in a collection of auto-follow
	// patterns.
	NumberOfFailedRemoteClusterStateRequests int64 `json:"number_of_failed_remote_cluster_state_requests"`
	// NumberOfSuccessfulFollowIndices The number of indices that the auto-follow coordinator successfully followed.
	NumberOfSuccessfulFollowIndices int64 `json:"number_of_successful_follow_indices"`
	// RecentAutoFollowErrors An array of objects representing failures by the auto-follow coordinator.
	RecentAutoFollowErrors []ErrorCause `json:"recent_auto_follow_errors"`
}

AutoFollowStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/stats/types.ts.ts#L32-L47

func NewAutoFollowStats added in v8.5.0 

func NewAutoFollowStats() *AutoFollowStats

NewAutoFollowStats returns a AutoFollowStats.

func (*AutoFollowStats) UnmarshalJSON added in v8.7.1 

func (s *AutoFollowStats) UnmarshalJSON(data []byte) error

type AutoFollowedCluster 

type AutoFollowedCluster struct {
	ClusterName              string `json:"cluster_name"`
	LastSeenMetadataVersion  int64  `json:"last_seen_metadata_version"`
	TimeSinceLastCheckMillis int64  `json:"time_since_last_check_millis"`
}

AutoFollowedCluster type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/stats/types.ts.ts#L26-L30

func NewAutoFollowedCluster added in v8.5.0 

func NewAutoFollowedCluster() *AutoFollowedCluster

NewAutoFollowedCluster returns a AutoFollowedCluster.

func (*AutoFollowedCluster) UnmarshalJSON added in v8.7.1 

func (s *AutoFollowedCluster) UnmarshalJSON(data []byte) error

type AutoscalingCapacity 

type AutoscalingCapacity struct {
	Node  AutoscalingResources `json:"node"`
	Total AutoscalingResources `json:"total"`
}

AutoscalingCapacity type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L38-L41

func NewAutoscalingCapacity added in v8.5.0 

func NewAutoscalingCapacity() *AutoscalingCapacity

NewAutoscalingCapacity returns a AutoscalingCapacity.

type AutoscalingDecider 

type AutoscalingDecider struct {
	ReasonDetails    json.RawMessage     `json:"reason_details,omitempty"`
	ReasonSummary    *string             `json:"reason_summary,omitempty"`
	RequiredCapacity AutoscalingCapacity `json:"required_capacity"`
}

AutoscalingDecider type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L52-L56

func NewAutoscalingDecider added in v8.5.0 

func NewAutoscalingDecider() *AutoscalingDecider

NewAutoscalingDecider returns a AutoscalingDecider.

func (*AutoscalingDecider) UnmarshalJSON added in v8.9.0 

func (s *AutoscalingDecider) UnmarshalJSON(data []byte) error

type AutoscalingDeciders 

type AutoscalingDeciders struct {
	CurrentCapacity  AutoscalingCapacity           `json:"current_capacity"`
	CurrentNodes     []AutoscalingNode             `json:"current_nodes"`
	Deciders         map[string]AutoscalingDecider `json:"deciders"`
	RequiredCapacity AutoscalingCapacity           `json:"required_capacity"`
}

AutoscalingDeciders type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L31-L36

func NewAutoscalingDeciders added in v8.5.0 

func NewAutoscalingDeciders() *AutoscalingDeciders

NewAutoscalingDeciders returns a AutoscalingDeciders.

type AutoscalingNode 

type AutoscalingNode struct {
	Name string `json:"name"`
}

AutoscalingNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50

func NewAutoscalingNode added in v8.5.0 

func NewAutoscalingNode() *AutoscalingNode

NewAutoscalingNode returns a AutoscalingNode.

func (*AutoscalingNode) UnmarshalJSON added in v8.7.1 

func (s *AutoscalingNode) UnmarshalJSON(data []byte) error

type AutoscalingPolicy 

type AutoscalingPolicy struct {
	// Deciders Decider settings.
	Deciders map[string]json.RawMessage `json:"deciders"`
	Roles    []string                   `json:"roles"`
}

AutoscalingPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/_types/AutoscalingPolicy.ts#L23-L30

func NewAutoscalingPolicy added in v8.5.0 

func NewAutoscalingPolicy() *AutoscalingPolicy

NewAutoscalingPolicy returns a AutoscalingPolicy.

type AutoscalingResources 

type AutoscalingResources struct {
	Memory  int `json:"memory"`
	Storage int `json:"storage"`
}

AutoscalingResources type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46

func NewAutoscalingResources added in v8.5.0 

func NewAutoscalingResources() *AutoscalingResources

NewAutoscalingResources returns a AutoscalingResources.

func (*AutoscalingResources) UnmarshalJSON added in v8.7.1 

func (s *AutoscalingResources) UnmarshalJSON(data []byte) error

type AverageAggregation 

type AverageAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

AverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L55-L55

func NewAverageAggregation added in v8.5.0 

func NewAverageAggregation() *AverageAggregation

NewAverageAggregation returns a AverageAggregation.

func (*AverageAggregation) UnmarshalJSON added in v8.7.1 

func (s *AverageAggregation) UnmarshalJSON(data []byte) error

type AverageBucketAggregation 

type AverageBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

AverageBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L78-L81

func NewAverageBucketAggregation added in v8.5.0 

func NewAverageBucketAggregation() *AverageBucketAggregation

NewAverageBucketAggregation returns a AverageBucketAggregation.

func (*AverageBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *AverageBucketAggregation) UnmarshalJSON(data []byte) error

type AvgAggregate 

type AvgAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

AvgAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L218-L222

func NewAvgAggregate added in v8.5.0 

func NewAvgAggregate() *AvgAggregate

NewAvgAggregate returns a AvgAggregate.

func (*AvgAggregate) UnmarshalJSON added in v8.7.1 

func (s *AvgAggregate) UnmarshalJSON(data []byte) error

type AzureAiStudioServiceSettings added in v8.18.0 

type AzureAiStudioServiceSettings struct {
	// ApiKey A valid API key of your Azure AI Studio model deployment.
	// This key can be found on the overview page for your deployment in the
	// management section of your Azure AI Studio account.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// EndpointType The type of endpoint that is available for deployment through Azure AI
	// Studio: `token` or `realtime`.
	// The `token` endpoint type is for "pay as you go" endpoints that are billed
	// per token.
	// The `realtime` endpoint type is for "real-time" endpoints that are billed per
	// hour of usage.
	EndpointType string `json:"endpoint_type"`
	// Provider The model provider for your deployment.
	// Note that some providers may support only certain task types.
	// Supported providers include:
	//
	// * `cohere` - available for `text_embedding` and `completion` task types
	// * `databricks` - available for `completion` task type only
	// * `meta` - available for `completion` task type only
	// * `microsoft_phi` - available for `completion` task type only
	// * `mistral` - available for `completion` task type only
	// * `openai` - available for `text_embedding` and `completion` task types
	Provider string `json:"provider"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Azure AI Studio.
	// By default, the `azureaistudio` service sets the number of requests allowed
	// per minute to 240.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Target The target URL of your Azure AI Studio model deployment.
	// This can be found on the overview page for your deployment in the management
	// section of your Azure AI Studio account.
	Target string `json:"target"`
}

AzureAiStudioServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L498-L540

func NewAzureAiStudioServiceSettings added in v8.18.0 

func NewAzureAiStudioServiceSettings() *AzureAiStudioServiceSettings

NewAzureAiStudioServiceSettings returns a AzureAiStudioServiceSettings.

func (*AzureAiStudioServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *AzureAiStudioServiceSettings) UnmarshalJSON(data []byte) error

type AzureAiStudioTaskSettings added in v8.18.0 

type AzureAiStudioTaskSettings struct {
	// DoSample For a `completion` task, instruct the inference process to perform sampling.
	// It has no effect unless `temperature` or `top_p` is specified.
	DoSample *float32 `json:"do_sample,omitempty"`
	// MaxNewTokens For a `completion` task, provide a hint for the maximum number of output
	// tokens to be generated.
	MaxNewTokens *int `json:"max_new_tokens,omitempty"`
	// Temperature For a `completion` task, control the apparent creativity of generated
	// completions with a sampling temperature.
	// It must be a number in the range of 0.0 to 2.0.
	// It should not be used if `top_p` is specified.
	Temperature *float32 `json:"temperature,omitempty"`
	// TopP For a `completion` task, make the model consider the results of the tokens
	// with nucleus sampling probability.
	// It is an alternative value to `temperature` and must be a number in the range
	// of 0.0 to 2.0.
	// It should not be used if `temperature` is specified.
	TopP *float32 `json:"top_p,omitempty"`
	// User For a `text_embedding` task, specify the user issuing the request.
	// This information can be used for abuse detection.
	User *string `json:"user,omitempty"`
}

AzureAiStudioTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L542-L570

func NewAzureAiStudioTaskSettings added in v8.18.0 

func NewAzureAiStudioTaskSettings() *AzureAiStudioTaskSettings

NewAzureAiStudioTaskSettings returns a AzureAiStudioTaskSettings.

func (*AzureAiStudioTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *AzureAiStudioTaskSettings) UnmarshalJSON(data []byte) error

type AzureOpenAIServiceSettings added in v8.18.0 

type AzureOpenAIServiceSettings struct {
	// ApiKey A valid API key for your Azure OpenAI account.
	// You must specify either `api_key` or `entra_id`.
	// If you do not provide either or you provide both, you will receive an error
	// when you try to create your model.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey *string `json:"api_key,omitempty"`
	// ApiVersion The Azure API version ID to use.
	// It is recommended to use the latest supported non-preview version.
	ApiVersion string `json:"api_version"`
	// DeploymentId The deployment name of your deployed models.
	// Your Azure OpenAI deployments can be found though the Azure OpenAI Studio
	// portal that is linked to your subscription.
	DeploymentId string `json:"deployment_id"`
	// EntraId A valid Microsoft Entra token.
	// You must specify either `api_key` or `entra_id`.
	// If you do not provide either or you provide both, you will receive an error
	// when you try to create your model.
	EntraId *string `json:"entra_id,omitempty"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Azure.
	// The `azureopenai` service sets a default number of requests allowed per
	// minute depending on the task type.
	// For `text_embedding`, it is set to `1440`.
	// For `completion`, it is set to `120`.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// ResourceName The name of your Azure OpenAI resource.
	// You can find this from the list of resources in the Azure Portal for your
	// subscription.
	ResourceName string `json:"resource_name"`
}

AzureOpenAIServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L581-L626

func NewAzureOpenAIServiceSettings added in v8.18.0 

func NewAzureOpenAIServiceSettings() *AzureOpenAIServiceSettings

NewAzureOpenAIServiceSettings returns a AzureOpenAIServiceSettings.

func (*AzureOpenAIServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *AzureOpenAIServiceSettings) UnmarshalJSON(data []byte) error

type AzureOpenAITaskSettings added in v8.18.0 

type AzureOpenAITaskSettings struct {
	// User For a `completion` or `text_embedding` task, specify the user issuing the
	// request.
	// This information can be used for abuse detection.
	User *string `json:"user,omitempty"`
}

AzureOpenAITaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L628-L634

func NewAzureOpenAITaskSettings added in v8.18.0 

func NewAzureOpenAITaskSettings() *AzureOpenAITaskSettings

NewAzureOpenAITaskSettings returns a AzureOpenAITaskSettings.

func (*AzureOpenAITaskSettings) UnmarshalJSON added in v8.18.0 

func (s *AzureOpenAITaskSettings) UnmarshalJSON(data []byte) error

type AzureRepository added in v8.13.0 

type AzureRepository struct {
	Settings AzureRepositorySettings `json:"settings"`
	Type     string                  `json:"type,omitempty"`
	Uuid     *string                 `json:"uuid,omitempty"`
}

AzureRepository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L40-L43

func NewAzureRepository added in v8.13.0 

func NewAzureRepository() *AzureRepository

NewAzureRepository returns a AzureRepository.

func (AzureRepository) MarshalJSON added in v8.13.0 

func (s AzureRepository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*AzureRepository) UnmarshalJSON added in v8.13.0 

func (s *AzureRepository) UnmarshalJSON(data []byte) error

type AzureRepositorySettings added in v8.13.0 

type AzureRepositorySettings struct {
	BasePath               *string  `json:"base_path,omitempty"`
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Client                 *string  `json:"client,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	Container              *string  `json:"container,omitempty"`
	LocationMode           *string  `json:"location_mode,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	Readonly               *bool    `json:"readonly,omitempty"`
}

AzureRepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L77-L83

func NewAzureRepositorySettings added in v8.13.0 

func NewAzureRepositorySettings() *AzureRepositorySettings

NewAzureRepositorySettings returns a AzureRepositorySettings.

func (*AzureRepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *AzureRepositorySettings) UnmarshalJSON(data []byte) error

type Base 

type Base struct {
	Available bool `json:"available"`
	Enabled   bool `json:"enabled"`
}

Base type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L27-L30

func NewBase added in v8.5.0 

func NewBase() *Base

NewBase returns a Base.

func (*Base) UnmarshalJSON added in v8.7.1 

func (s *Base) UnmarshalJSON(data []byte) error

type BaseIndicator added in v8.7.1 

type BaseIndicator struct {
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

BaseIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L43-L48

func NewBaseIndicator added in v8.7.1 

func NewBaseIndicator() *BaseIndicator

NewBaseIndicator returns a BaseIndicator.

func (*BaseIndicator) UnmarshalJSON added in v8.9.0 

func (s *BaseIndicator) UnmarshalJSON(data []byte) error

type BaseNode 

type BaseNode struct {
	Attributes       map[string]string   `json:"attributes"`
	Host             string              `json:"host"`
	Ip               string              `json:"ip"`
	Name             string              `json:"name"`
	Roles            []noderole.NodeRole `json:"roles,omitempty"`
	TransportAddress string              `json:"transport_address"`
}

BaseNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/BaseNode.ts#L25-L32

func NewBaseNode added in v8.5.0 

func NewBaseNode() *BaseNode

NewBaseNode returns a BaseNode.

func (*BaseNode) UnmarshalJSON added in v8.7.1 

func (s *BaseNode) UnmarshalJSON(data []byte) error

type BasqueAnalyzer added in v8.16.0 

type BasqueAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

BasqueAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L66-L71

func NewBasqueAnalyzer added in v8.16.0 

func NewBasqueAnalyzer() *BasqueAnalyzer

NewBasqueAnalyzer returns a BasqueAnalyzer.

func (BasqueAnalyzer) MarshalJSON added in v8.16.0 

func (s BasqueAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BasqueAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *BasqueAnalyzer) UnmarshalJSON(data []byte) error

type BengaliAnalyzer added in v8.16.0 

type BengaliAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

BengaliAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L73-L78

func NewBengaliAnalyzer added in v8.16.0 

func NewBengaliAnalyzer() *BengaliAnalyzer

NewBengaliAnalyzer returns a BengaliAnalyzer.

func (BengaliAnalyzer) MarshalJSON added in v8.16.0 

func (s BengaliAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BengaliAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *BengaliAnalyzer) UnmarshalJSON(data []byte) error

type BinaryProperty 

type BinaryProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

BinaryProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L54-L56

func NewBinaryProperty added in v8.5.0 

func NewBinaryProperty() *BinaryProperty

NewBinaryProperty returns a BinaryProperty.

func (BinaryProperty) MarshalJSON added in v8.9.0 

func (s BinaryProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BinaryProperty) UnmarshalJSON added in v8.7.0 

func (s *BinaryProperty) UnmarshalJSON(data []byte) error

type BlobDetails added in v8.18.0 

type BlobDetails struct {
	// Name The name of the blob.
	Name string `json:"name"`
	// Overwritten Indicates whether the blob was overwritten while the read operations were
	// ongoing.
	//
	//	/**
	Overwritten bool `json:"overwritten"`
	ReadEarly   bool `json:"read_early"`
	// ReadEnd The position, in bytes, at which read operations completed.
	ReadEnd int64 `json:"read_end"`
	// ReadStart The position, in bytes, at which read operations started.
	ReadStart int64 `json:"read_start"`
	// Reads A description of every read operation performed on the blob.
	Reads ReadBlobDetails `json:"reads"`
	// Size The size of the blob.
	Size ByteSize `json:"size"`
	// SizeBytes The size of the blob in bytes.
	SizeBytes int64 `json:"size_bytes"`
}

BlobDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L250-L284

func NewBlobDetails added in v8.18.0 

func NewBlobDetails() *BlobDetails

NewBlobDetails returns a BlobDetails.

func (*BlobDetails) UnmarshalJSON added in v8.18.0 

func (s *BlobDetails) UnmarshalJSON(data []byte) error

type BoolQuery 

type BoolQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Filter The clause (query) must appear in matching documents.
	// However, unlike `must`, the score of the query will be ignored.
	Filter []Query `json:"filter,omitempty"`
	// MinimumShouldMatch Specifies the number or percentage of `should` clauses returned documents
	// must match.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Must The clause (query) must appear in matching documents and will contribute to
	// the score.
	Must []Query `json:"must,omitempty"`
	// MustNot The clause (query) must not appear in the matching documents.
	// Because scoring is ignored, a score of `0` is returned for all documents.
	MustNot    []Query `json:"must_not,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Should The clause (query) should appear in the matching document.
	Should []Query `json:"should,omitempty"`
}

BoolQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L29-L56

func NewBoolQuery added in v8.5.0 

func NewBoolQuery() *BoolQuery

NewBoolQuery returns a BoolQuery.

func (*BoolQuery) UnmarshalJSON added in v8.7.1 

func (s *BoolQuery) UnmarshalJSON(data []byte) error

type BooleanProperty 

type BooleanProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fielddata       *NumericFielddata              `json:"fielddata,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *bool                                            `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool  `json:"time_series_dimension,omitempty"`
	Type                string `json:"type,omitempty"`
}

BooleanProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L58-L73

func NewBooleanProperty added in v8.5.0 

func NewBooleanProperty() *BooleanProperty

NewBooleanProperty returns a BooleanProperty.

func (BooleanProperty) MarshalJSON added in v8.9.0 

func (s BooleanProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BooleanProperty) UnmarshalJSON added in v8.7.0 

func (s *BooleanProperty) UnmarshalJSON(data []byte) error

type BoostingQuery 

type BoostingQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Negative Query used to decrease the relevance score of matching documents.
	Negative *Query `json:"negative,omitempty"`
	// NegativeBoost Floating point number between 0 and 1.0 used to decrease the relevance scores
	// of documents matching the `negative` query.
	NegativeBoost Float64 `json:"negative_boost"`
	// Positive Any returned documents must match this query.
	Positive   *Query  `json:"positive,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
}

BoostingQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L58-L74

func NewBoostingQuery added in v8.5.0 

func NewBoostingQuery() *BoostingQuery

NewBoostingQuery returns a BoostingQuery.

func (*BoostingQuery) UnmarshalJSON added in v8.7.1 

func (s *BoostingQuery) UnmarshalJSON(data []byte) error

type BoxPlotAggregate 

type BoxPlotAggregate struct {
	Lower         Float64  `json:"lower"`
	LowerAsString *string  `json:"lower_as_string,omitempty"`
	Max           Float64  `json:"max"`
	MaxAsString   *string  `json:"max_as_string,omitempty"`
	Meta          Metadata `json:"meta,omitempty"`
	Min           Float64  `json:"min"`
	MinAsString   *string  `json:"min_as_string,omitempty"`
	Q1            Float64  `json:"q1"`
	Q1AsString    *string  `json:"q1_as_string,omitempty"`
	Q2            Float64  `json:"q2"`
	Q2AsString    *string  `json:"q2_as_string,omitempty"`
	Q3            Float64  `json:"q3"`
	Q3AsString    *string  `json:"q3_as_string,omitempty"`
	Upper         Float64  `json:"upper"`
	UpperAsString *string  `json:"upper_as_string,omitempty"`
}

BoxPlotAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L806-L825

func NewBoxPlotAggregate added in v8.5.0 

func NewBoxPlotAggregate() *BoxPlotAggregate

NewBoxPlotAggregate returns a BoxPlotAggregate.

func (*BoxPlotAggregate) UnmarshalJSON added in v8.7.1 

func (s *BoxPlotAggregate) UnmarshalJSON(data []byte) error

type BoxplotAggregation 

type BoxplotAggregation struct {
	// Compression Limits the maximum number of nodes used by the underlying TDigest algorithm
	// to `20 * compression`, enabling control of memory usage and approximation
	// error.
	Compression *Float64 `json:"compression,omitempty"`
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

BoxplotAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L57-L62

func NewBoxplotAggregation added in v8.5.0 

func NewBoxplotAggregation() *BoxplotAggregation

NewBoxplotAggregation returns a BoxplotAggregation.

func (*BoxplotAggregation) UnmarshalJSON added in v8.7.1 

func (s *BoxplotAggregation) UnmarshalJSON(data []byte) error

type BrazilianAnalyzer added in v8.16.0 

type BrazilianAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

BrazilianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L80-L84

func NewBrazilianAnalyzer added in v8.16.0 

func NewBrazilianAnalyzer() *BrazilianAnalyzer

NewBrazilianAnalyzer returns a BrazilianAnalyzer.

func (BrazilianAnalyzer) MarshalJSON added in v8.16.0 

func (s BrazilianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BrazilianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *BrazilianAnalyzer) UnmarshalJSON(data []byte) error

type Breaker 

type Breaker struct {
	// EstimatedSize Estimated memory used for the operation.
	EstimatedSize *string `json:"estimated_size,omitempty"`
	// EstimatedSizeInBytes Estimated memory used, in bytes, for the operation.
	EstimatedSizeInBytes *int64 `json:"estimated_size_in_bytes,omitempty"`
	// LimitSize Memory limit for the circuit breaker.
	LimitSize *string `json:"limit_size,omitempty"`
	// LimitSizeInBytes Memory limit, in bytes, for the circuit breaker.
	LimitSizeInBytes *int64 `json:"limit_size_in_bytes,omitempty"`
	// Overhead A constant that all estimates for the circuit breaker are multiplied with to
	// calculate a final estimate.
	Overhead *float32 `json:"overhead,omitempty"`
	// Tripped Total number of times the circuit breaker has been triggered and prevented an
	// out of memory error.
	Tripped *float32 `json:"tripped,omitempty"`
}

Breaker type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L470-L495

func NewBreaker added in v8.5.0 

func NewBreaker() *Breaker

NewBreaker returns a Breaker.

func (*Breaker) UnmarshalJSON added in v8.7.1 

func (s *Breaker) UnmarshalJSON(data []byte) error

type BucketCorrelationAggregation 

type BucketCorrelationAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Function The correlation function to execute.
	Function BucketCorrelationFunction `json:"function"`
}

BucketCorrelationAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L139-L146

func NewBucketCorrelationAggregation added in v8.5.0 

func NewBucketCorrelationAggregation() *BucketCorrelationAggregation

NewBucketCorrelationAggregation returns a BucketCorrelationAggregation.

func (*BucketCorrelationAggregation) UnmarshalJSON added in v8.7.0 

func (s *BucketCorrelationAggregation) UnmarshalJSON(data []byte) error

type BucketCorrelationFunction 

type BucketCorrelationFunction struct {
	// CountCorrelation The configuration to calculate a count correlation. This function is designed
	// for determining the correlation of a term value and a given metric.
	CountCorrelation BucketCorrelationFunctionCountCorrelation `json:"count_correlation"`
}

BucketCorrelationFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L148-L153

func NewBucketCorrelationFunction added in v8.5.0 

func NewBucketCorrelationFunction() *BucketCorrelationFunction

NewBucketCorrelationFunction returns a BucketCorrelationFunction.

type BucketCorrelationFunctionCountCorrelation 

type BucketCorrelationFunctionCountCorrelation struct {
	// Indicator The indicator with which to correlate the configured `bucket_path` values.
	Indicator BucketCorrelationFunctionCountCorrelationIndicator `json:"indicator"`
}

BucketCorrelationFunctionCountCorrelation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L155-L158

func NewBucketCorrelationFunctionCountCorrelation added in v8.5.0 

func NewBucketCorrelationFunctionCountCorrelation() *BucketCorrelationFunctionCountCorrelation

NewBucketCorrelationFunctionCountCorrelation returns a BucketCorrelationFunctionCountCorrelation.

type BucketCorrelationFunctionCountCorrelationIndicator 

type BucketCorrelationFunctionCountCorrelationIndicator struct {
	// DocCount The total number of documents that initially created the expectations. It’s
	// required to be greater
	// than or equal to the sum of all values in the buckets_path as this is the
	// originating superset of data
	// to which the term values are correlated.
	DocCount int `json:"doc_count"`
	// Expectations An array of numbers with which to correlate the configured `bucket_path`
	// values.
	// The length of this value must always equal the number of buckets returned by
	// the `bucket_path`.
	Expectations []Float64 `json:"expectations"`
	// Fractions An array of fractions to use when averaging and calculating variance. This
	// should be used if
	// the pre-calculated data and the buckets_path have known gaps. The length of
	// fractions, if provided,
	// must equal expectations.
	Fractions []Float64 `json:"fractions,omitempty"`
}

BucketCorrelationFunctionCountCorrelationIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L160-L178

func NewBucketCorrelationFunctionCountCorrelationIndicator added in v8.5.0 

func NewBucketCorrelationFunctionCountCorrelationIndicator() *BucketCorrelationFunctionCountCorrelationIndicator

NewBucketCorrelationFunctionCountCorrelationIndicator returns a BucketCorrelationFunctionCountCorrelationIndicator.

func (*BucketCorrelationFunctionCountCorrelationIndicator) UnmarshalJSON added in v8.7.1 

func (s *BucketCorrelationFunctionCountCorrelationIndicator) UnmarshalJSON(data []byte) error

type BucketInfluencer 

type BucketInfluencer struct {
	// AnomalyScore A normalized score between 0-100, which is calculated for each bucket
	// influencer. This score might be updated as
	// newer data is analyzed.
	AnomalyScore Float64 `json:"anomaly_score"`
	// BucketSpan The length of the bucket in seconds. This value matches the bucket span that
	// is specified in the job.
	BucketSpan int64 `json:"bucket_span"`
	// InfluencerFieldName The field name of the influencer.
	InfluencerFieldName string `json:"influencer_field_name"`
	// InitialAnomalyScore The score between 0-100 for each bucket influencer. This score is the initial
	// value that was calculated at the
	// time the bucket was processed.
	InitialAnomalyScore Float64 `json:"initial_anomaly_score"`
	// IsInterim If true, this is an interim result. In other words, the results are
	// calculated based on partial input data.
	IsInterim bool `json:"is_interim"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// Probability The probability that the bucket has this behavior, in the range 0 to 1. This
	// value can be held to a high precision
	// of over 300 decimal places, so the `anomaly_score` is provided as a
	// human-readable and friendly interpretation of
	// this.
	Probability Float64 `json:"probability"`
	// RawAnomalyScore Internal.
	RawAnomalyScore Float64 `json:"raw_anomaly_score"`
	// ResultType Internal. This value is always set to `bucket_influencer`.
	ResultType string `json:"result_type"`
	// Timestamp The start time of the bucket for which these results were calculated.
	Timestamp int64 `json:"timestamp"`
	// TimestampString The start time of the bucket for which these results were calculated.
	TimestampString DateTime `json:"timestamp_string,omitempty"`
}

BucketInfluencer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Bucket.ts#L79-L127

func NewBucketInfluencer added in v8.5.0 

func NewBucketInfluencer() *BucketInfluencer

NewBucketInfluencer returns a BucketInfluencer.

func (*BucketInfluencer) UnmarshalJSON added in v8.7.1 

func (s *BucketInfluencer) UnmarshalJSON(data []byte) error

type BucketKsAggregation 

type BucketKsAggregation struct {
	// Alternative A list of string values indicating which K-S test alternative to calculate.
	// The valid values
	// are: "greater", "less", "two_sided". This parameter is key for determining
	// the K-S statistic used
	// when calculating the K-S test. Default value is all possible alternative
	// hypotheses.
	Alternative []string `json:"alternative,omitempty"`
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Fractions A list of doubles indicating the distribution of the samples with which to
	// compare to the `buckets_path` results.
	// In typical usage this is the overall proportion of documents in each bucket,
	// which is compared with the actual
	// document proportions in each bucket from the sibling aggregation counts. The
	// default is to assume that overall
	// documents are uniformly distributed on these buckets, which they would be if
	// one used equal percentiles of a
	// metric to define the bucket end points.
	Fractions []Float64 `json:"fractions,omitempty"`
	// SamplingMethod Indicates the sampling methodology when calculating the K-S test. Note, this
	// is sampling of the returned values.
	// This determines the cumulative distribution function (CDF) points used
	// comparing the two samples. Default is
	// `upper_tail`, which emphasizes the upper end of the CDF points. Valid options
	// are: `upper_tail`, `uniform`,
	// and `lower_tail`.
	SamplingMethod *string `json:"sampling_method,omitempty"`
}

BucketKsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L103-L137

func NewBucketKsAggregation added in v8.5.0 

func NewBucketKsAggregation() *BucketKsAggregation

NewBucketKsAggregation returns a BucketKsAggregation.

func (*BucketKsAggregation) UnmarshalJSON added in v8.7.0 

func (s *BucketKsAggregation) UnmarshalJSON(data []byte) error

type BucketMetricValueAggregate 

type BucketMetricValueAggregate struct {
	Keys []string `json:"keys"`
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

BucketMetricValueAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L250-L253

func NewBucketMetricValueAggregate added in v8.5.0 

func NewBucketMetricValueAggregate() *BucketMetricValueAggregate

NewBucketMetricValueAggregate returns a BucketMetricValueAggregate.

func (*BucketMetricValueAggregate) UnmarshalJSON added in v8.7.1 

func (s *BucketMetricValueAggregate) UnmarshalJSON(data []byte) error

type BucketPathAggregation 

type BucketPathAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
}

BucketPathAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L31-L37

func NewBucketPathAggregation added in v8.5.0 

func NewBucketPathAggregation() *BucketPathAggregation

NewBucketPathAggregation returns a BucketPathAggregation.

func (*BucketPathAggregation) UnmarshalJSON added in v8.7.0 

func (s *BucketPathAggregation) UnmarshalJSON(data []byte) error

type BucketScriptAggregation 

type BucketScriptAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Script The script to run for this aggregation.
	Script *Script `json:"script,omitempty"`
}

BucketScriptAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L83-L91

func NewBucketScriptAggregation added in v8.5.0 

func NewBucketScriptAggregation() *BucketScriptAggregation

NewBucketScriptAggregation returns a BucketScriptAggregation.

func (*BucketScriptAggregation) UnmarshalJSON added in v8.7.0 

func (s *BucketScriptAggregation) UnmarshalJSON(data []byte) error

type BucketSelectorAggregation 

type BucketSelectorAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Script The script to run for this aggregation.
	Script *Script `json:"script,omitempty"`
}

BucketSelectorAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L93-L101

func NewBucketSelectorAggregation added in v8.5.0 

func NewBucketSelectorAggregation() *BucketSelectorAggregation

NewBucketSelectorAggregation returns a BucketSelectorAggregation.

func (*BucketSelectorAggregation) UnmarshalJSON added in v8.7.0 

func (s *BucketSelectorAggregation) UnmarshalJSON(data []byte) error

type BucketSortAggregation 

type BucketSortAggregation struct {
	// From Buckets in positions prior to `from` will be truncated.
	From *int `json:"from,omitempty"`
	// GapPolicy The policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Size The number of buckets to return.
	// Defaults to all buckets of the parent aggregation.
	Size *int `json:"size,omitempty"`
	// Sort The list of fields to sort on.
	Sort []SortCombinations `json:"sort,omitempty"`
}

BucketSortAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L180-L204

func NewBucketSortAggregation added in v8.5.0 

func NewBucketSortAggregation() *BucketSortAggregation

NewBucketSortAggregation returns a BucketSortAggregation.

func (*BucketSortAggregation) UnmarshalJSON added in v8.7.1 

func (s *BucketSortAggregation) UnmarshalJSON(data []byte) error

type BucketSummary 

type BucketSummary struct {
	// AnomalyScore The maximum anomaly score, between 0-100, for any of the bucket influencers.
	// This is an overall, rate-limited
	// score for the job. All the anomaly records in the bucket contribute to this
	// score. This value might be updated as
	// new data is analyzed.
	AnomalyScore      Float64            `json:"anomaly_score"`
	BucketInfluencers []BucketInfluencer `json:"bucket_influencers"`
	// BucketSpan The length of the bucket in seconds. This value matches the bucket span that
	// is specified in the job.
	BucketSpan int64 `json:"bucket_span"`
	// EventCount The number of input data records processed in this bucket.
	EventCount int64 `json:"event_count"`
	// InitialAnomalyScore The maximum anomaly score for any of the bucket influencers. This is the
	// initial value that was calculated at the
	// time the bucket was processed.
	InitialAnomalyScore Float64 `json:"initial_anomaly_score"`
	// IsInterim If true, this is an interim result. In other words, the results are
	// calculated based on partial input data.
	IsInterim bool `json:"is_interim"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// ProcessingTimeMs The amount of time, in milliseconds, that it took to analyze the bucket
	// contents and calculate results.
	ProcessingTimeMs int64 `json:"processing_time_ms"`
	// ResultType Internal. This value is always set to bucket.
	ResultType string `json:"result_type"`
	// Timestamp The start time of the bucket. This timestamp uniquely identifies the bucket.
	// Events that occur exactly at the
	// timestamp of the bucket are included in the results for the bucket.
	Timestamp int64 `json:"timestamp"`
	// TimestampString The start time of the bucket. This timestamp uniquely identifies the bucket.
	// Events that occur exactly at the
	// timestamp of the bucket are included in the results for the bucket.
	TimestampString DateTime `json:"timestamp_string,omitempty"`
}

BucketSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Bucket.ts#L30-L77

func NewBucketSummary added in v8.5.0 

func NewBucketSummary() *BucketSummary

NewBucketSummary returns a BucketSummary.

func (*BucketSummary) UnmarshalJSON added in v8.7.1 

func (s *BucketSummary) UnmarshalJSON(data []byte) error

type BucketsAdjacencyMatrixBucket 

type BucketsAdjacencyMatrixBucket any

BucketsAdjacencyMatrixBucket holds the union for the following types: 

map[string]AdjacencyMatrixBucket
[]AdjacencyMatrixBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsApiKeyQueryContainer added in v8.13.0 

type BucketsApiKeyQueryContainer any

BucketsApiKeyQueryContainer holds the union for the following types: 

map[string]ApiKeyQueryContainer
[]ApiKeyQueryContainer

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsCompositeBucket 

type BucketsCompositeBucket any

BucketsCompositeBucket holds the union for the following types: 

map[string]CompositeBucket
[]CompositeBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsDateHistogramBucket 

type BucketsDateHistogramBucket any

BucketsDateHistogramBucket holds the union for the following types: 

map[string]DateHistogramBucket
[]DateHistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsDoubleTermsBucket 

type BucketsDoubleTermsBucket any

BucketsDoubleTermsBucket holds the union for the following types: 

map[string]DoubleTermsBucket
[]DoubleTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsFiltersBucket 

type BucketsFiltersBucket any

BucketsFiltersBucket holds the union for the following types: 

map[string]FiltersBucket
[]FiltersBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsFrequentItemSetsBucket added in v8.8.0 

type BucketsFrequentItemSetsBucket any

BucketsFrequentItemSetsBucket holds the union for the following types: 

map[string]FrequentItemSetsBucket
[]FrequentItemSetsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsGeoHashGridBucket 

type BucketsGeoHashGridBucket any

BucketsGeoHashGridBucket holds the union for the following types: 

map[string]GeoHashGridBucket
[]GeoHashGridBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsGeoHexGridBucket added in v8.5.0 

type BucketsGeoHexGridBucket any

BucketsGeoHexGridBucket holds the union for the following types: 

map[string]GeoHexGridBucket
[]GeoHexGridBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsGeoTileGridBucket 

type BucketsGeoTileGridBucket any

BucketsGeoTileGridBucket holds the union for the following types: 

map[string]GeoTileGridBucket
[]GeoTileGridBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsHistogramBucket 

type BucketsHistogramBucket any

BucketsHistogramBucket holds the union for the following types: 

map[string]HistogramBucket
[]HistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsIpPrefixBucket added in v8.5.0 

type BucketsIpPrefixBucket any

BucketsIpPrefixBucket holds the union for the following types: 

map[string]IpPrefixBucket
[]IpPrefixBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsIpRangeBucket 

type BucketsIpRangeBucket any

BucketsIpRangeBucket holds the union for the following types: 

map[string]IpRangeBucket
[]IpRangeBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsLongRareTermsBucket 

type BucketsLongRareTermsBucket any

BucketsLongRareTermsBucket holds the union for the following types: 

map[string]LongRareTermsBucket
[]LongRareTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsLongTermsBucket 

type BucketsLongTermsBucket any

BucketsLongTermsBucket holds the union for the following types: 

map[string]LongTermsBucket
[]LongTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsMultiTermsBucket 

type BucketsMultiTermsBucket any

BucketsMultiTermsBucket holds the union for the following types: 

map[string]MultiTermsBucket
[]MultiTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsPath 

type BucketsPath any

BucketsPath holds the union for the following types: 

string
[]string
map[string]string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L53-L59

type BucketsQuery added in v8.5.0 

type BucketsQuery any

BucketsQuery holds the union for the following types: 

map[string]Query
[]Query

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsRangeBucket 

type BucketsRangeBucket any

BucketsRangeBucket holds the union for the following types: 

map[string]RangeBucket
[]RangeBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsSignificantLongTermsBucket 

type BucketsSignificantLongTermsBucket any

BucketsSignificantLongTermsBucket holds the union for the following types: 

map[string]SignificantLongTermsBucket
[]SignificantLongTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsSignificantStringTermsBucket 

type BucketsSignificantStringTermsBucket any

BucketsSignificantStringTermsBucket holds the union for the following types: 

map[string]SignificantStringTermsBucket
[]SignificantStringTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsStringRareTermsBucket 

type BucketsStringRareTermsBucket any

BucketsStringRareTermsBucket holds the union for the following types: 

map[string]StringRareTermsBucket
[]StringRareTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsStringTermsBucket 

type BucketsStringTermsBucket any

BucketsStringTermsBucket holds the union for the following types: 

map[string]StringTermsBucket
[]StringTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsTimeSeriesBucket added in v8.16.0 

type BucketsTimeSeriesBucket any

BucketsTimeSeriesBucket holds the union for the following types: 

map[string]TimeSeriesBucket
[]TimeSeriesBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsVariableWidthHistogramBucket 

type BucketsVariableWidthHistogramBucket any

BucketsVariableWidthHistogramBucket holds the union for the following types: 

map[string]VariableWidthHistogramBucket
[]VariableWidthHistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BucketsVoid 

type BucketsVoid any

BucketsVoid holds the union for the following types: 

map[string]any
[]any

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L346-L355

type BuildInformation 

type BuildInformation struct {
	Date DateTime `json:"date"`
	Hash string   `json:"hash"`
}

BuildInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/info/types.ts#L24-L27

func NewBuildInformation added in v8.5.0 

func NewBuildInformation() *BuildInformation

NewBuildInformation returns a BuildInformation.

func (*BuildInformation) UnmarshalJSON added in v8.7.1 

func (s *BuildInformation) UnmarshalJSON(data []byte) error

type BulgarianAnalyzer added in v8.16.0 

type BulgarianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

BulgarianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L86-L91

func NewBulgarianAnalyzer added in v8.16.0 

func NewBulgarianAnalyzer() *BulgarianAnalyzer

NewBulgarianAnalyzer returns a BulgarianAnalyzer.

func (BulgarianAnalyzer) MarshalJSON added in v8.16.0 

func (s BulgarianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*BulgarianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *BulgarianAnalyzer) UnmarshalJSON(data []byte) error

type BulkError added in v8.15.0 

type BulkError struct {
	// Count The number of errors
	Count int `json:"count"`
	// Details Details about the errors, keyed by role name
	Details map[string]ErrorCause `json:"details"`
}

BulkError type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Bulk.ts#L24-L33

func NewBulkError added in v8.15.0 

func NewBulkError() *BulkError

NewBulkError returns a BulkError.

func (*BulkError) UnmarshalJSON added in v8.15.0 

func (s *BulkError) UnmarshalJSON(data []byte) error

type BulkIndexByScrollFailure 

type BulkIndexByScrollFailure struct {
	Cause  ErrorCause `json:"cause"`
	Id     string     `json:"id"`
	Index  string     `json:"index"`
	Status int        `json:"status"`
}

BulkIndexByScrollFailure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Errors.ts#L60-L65

func NewBulkIndexByScrollFailure added in v8.5.0 

func NewBulkIndexByScrollFailure() *BulkIndexByScrollFailure

NewBulkIndexByScrollFailure returns a BulkIndexByScrollFailure.

func (*BulkIndexByScrollFailure) UnmarshalJSON added in v8.7.1 

func (s *BulkIndexByScrollFailure) UnmarshalJSON(data []byte) error

type BulkStats 

type BulkStats struct {
	AvgSize           ByteSize `json:"avg_size,omitempty"`
	AvgSizeInBytes    int64    `json:"avg_size_in_bytes"`
	AvgTime           Duration `json:"avg_time,omitempty"`
	AvgTimeInMillis   int64    `json:"avg_time_in_millis"`
	TotalOperations   int64    `json:"total_operations"`
	TotalSize         ByteSize `json:"total_size,omitempty"`
	TotalSizeInBytes  int64    `json:"total_size_in_bytes"`
	TotalTime         Duration `json:"total_time,omitempty"`
	TotalTimeInMillis int64    `json:"total_time_in_millis"`
}

BulkStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L71-L81

func NewBulkStats added in v8.5.0 

func NewBulkStats() *BulkStats

NewBulkStats returns a BulkStats.

func (*BulkStats) UnmarshalJSON added in v8.7.1 

func (s *BulkStats) UnmarshalJSON(data []byte) error

type ByteNumberProperty 

type ByteNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *byte                                            `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

ByteNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L185-L188

func NewByteNumberProperty added in v8.5.0 

func NewByteNumberProperty() *ByteNumberProperty

NewByteNumberProperty returns a ByteNumberProperty.

func (ByteNumberProperty) MarshalJSON added in v8.9.0 

func (s ByteNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ByteNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *ByteNumberProperty) UnmarshalJSON(data []byte) error

type ByteSize 

type ByteSize any

ByteSize holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L97-L98

type BytesProcessor 

type BytesProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to convert.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

BytesProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L555-L571

func NewBytesProcessor added in v8.5.0 

func NewBytesProcessor() *BytesProcessor

NewBytesProcessor returns a BytesProcessor.

func (*BytesProcessor) UnmarshalJSON added in v8.7.1 

func (s *BytesProcessor) UnmarshalJSON(data []byte) error

type CCSStats added in v8.18.1 

type CCSStats struct {
	// Clusters Contains remote cluster settings and metrics collected from them.
	// The keys are cluster names, and the values are per-cluster data.
	// Only present if `include_remotes` option is set to true.
	Clusters map[string]RemoteClusterInfo `json:"clusters,omitempty"`
	// Esql_ Information about ES|QL cross-cluster query usage.
	Esql_ *CCSUsageStats `json:"_esql,omitempty"`
	// Search_ Information about cross-cluster search usage.
	Search_ CCSUsageStats `json:"_search"`
}

CCSStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L591-L606

func NewCCSStats added in v8.18.1 

func NewCCSStats() *CCSStats

NewCCSStats returns a CCSStats.

type CCSUsageClusterStats added in v8.18.1 

type CCSUsageClusterStats struct {
	// Skipped The total number of cross-cluster search requests for which this cluster was
	// skipped.
	Skipped int `json:"skipped"`
	// Took Statistics about the time taken to execute requests against this cluster.
	Took CCSUsageTimeValue `json:"took"`
	// Total The total number of successful (not skipped) cross-cluster search requests
	// that were executed against this cluster. This may include requests where
	// partial results were returned, but not requests in which the cluster has been
	// skipped entirely.
	Total int `json:"total"`
}

CCSUsageClusterStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L677-L684

func NewCCSUsageClusterStats added in v8.18.1 

func NewCCSUsageClusterStats() *CCSUsageClusterStats

NewCCSUsageClusterStats returns a CCSUsageClusterStats.

func (*CCSUsageClusterStats) UnmarshalJSON added in v8.18.1 

func (s *CCSUsageClusterStats) UnmarshalJSON(data []byte) error

type CCSUsageStats added in v8.18.1 

type CCSUsageStats struct {
	// Clients Statistics about the clients that executed cross-cluster search requests. The
	// keys are the names of the clients, and the values are the number of requests
	// that were executed by that client. Only known clients (such as `kibana` or
	// `elasticsearch`) are counted.
	Clients map[string]int `json:"clients"`
	// Clusters Statistics about the clusters that were queried in cross-cluster search
	// requests. The keys are cluster names, and the values are per-cluster
	// telemetry data. This also includes the local cluster itself, which uses the
	// name `(local)`.
	Clusters map[string]CCSUsageClusterStats `json:"clusters"`
	// FailureReasons Statistics about the reasons for cross-cluster search request failures. The
	// keys are the failure reason names and the values are the number of requests
	// that failed for that reason.
	FailureReasons map[string]int `json:"failure_reasons"`
	// Features The keys are the names of the search feature, and the values are the number
	// of requests that used that feature. Single request can use more than one
	// feature (e.g. both `async` and `wildcard`).
	Features map[string]int `json:"features"`
	// RemotesPerSearchAvg The average number of remote clusters that were queried in a single
	// cross-cluster search request.
	RemotesPerSearchAvg Float64 `json:"remotes_per_search_avg"`
	// RemotesPerSearchMax The maximum number of remote clusters that were queried in a single
	// cross-cluster search request.
	RemotesPerSearchMax int `json:"remotes_per_search_max"`
	// Skipped The total number of cross-cluster search requests (successful or failed) that
	// had at least one remote cluster skipped.
	Skipped int `json:"skipped"`
	// Success The total number of cross-cluster search requests that have been successfully
	// executed by the cluster.
	Success int `json:"success"`
	// Took Statistics about the time taken to execute cross-cluster search requests.
	Took CCSUsageTimeValue `json:"took"`
	// TookMrtFalse Statistics about the time taken to execute cross-cluster search requests for
	// which the `ccs_minimize_roundtrips` setting was set to `false`.
	TookMrtFalse *CCSUsageTimeValue `json:"took_mrt_false,omitempty"`
	// TookMrtTrue Statistics about the time taken to execute cross-cluster search requests for
	// which the `ccs_minimize_roundtrips` setting was set to `true`.
	TookMrtTrue *CCSUsageTimeValue `json:"took_mrt_true,omitempty"`
	// Total The total number of cross-cluster search requests that have been executed by
	// the cluster.
	Total int `json:"total"`
}

CCSUsageStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L641-L666

func NewCCSUsageStats added in v8.18.1 

func NewCCSUsageStats() *CCSUsageStats

NewCCSUsageStats returns a CCSUsageStats.

func (*CCSUsageStats) UnmarshalJSON added in v8.18.1 

func (s *CCSUsageStats) UnmarshalJSON(data []byte) error

type CCSUsageTimeValue added in v8.18.1 

type CCSUsageTimeValue struct {
	// Avg The average time taken to execute a request, in milliseconds.
	Avg int64 `json:"avg"`
	// Max The maximum time taken to execute a request, in milliseconds.
	Max int64 `json:"max"`
	// P90 The 90th percentile of the time taken to execute requests, in milliseconds.
	P90 int64 `json:"p90"`
}

CCSUsageTimeValue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L668-L675

func NewCCSUsageTimeValue added in v8.18.1 

func NewCCSUsageTimeValue() *CCSUsageTimeValue

NewCCSUsageTimeValue returns a CCSUsageTimeValue.

func (*CCSUsageTimeValue) UnmarshalJSON added in v8.18.1 

func (s *CCSUsageTimeValue) UnmarshalJSON(data []byte) error

type CacheQueries 

type CacheQueries struct {
	Enabled bool `json:"enabled"`
}

CacheQueries type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L421-L423

func NewCacheQueries added in v8.5.0 

func NewCacheQueries() *CacheQueries

NewCacheQueries returns a CacheQueries.

func (*CacheQueries) UnmarshalJSON added in v8.7.1 

func (s *CacheQueries) UnmarshalJSON(data []byte) error

type CacheStats 

type CacheStats struct {
	Count              int    `json:"count"`
	Evictions          int    `json:"evictions"`
	Hits               int    `json:"hits"`
	HitsTimeInMillis   int64  `json:"hits_time_in_millis"`
	Misses             int    `json:"misses"`
	MissesTimeInMillis int64  `json:"misses_time_in_millis"`
	NodeId             string `json:"node_id"`
	SizeInBytes        int64  `json:"size_in_bytes"`
}

CacheStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/stats/types.ts#L38-L50

func NewCacheStats added in v8.5.0 

func NewCacheStats() *CacheStats

NewCacheStats returns a CacheStats.

func (*CacheStats) UnmarshalJSON added in v8.7.1 

func (s *CacheStats) UnmarshalJSON(data []byte) error

type Calendar 

type Calendar struct {
	// CalendarId A string that uniquely identifies a calendar.
	CalendarId string `json:"calendar_id"`
	// Description A description of the calendar.
	Description *string `json:"description,omitempty"`
	// JobIds An array of anomaly detection job identifiers.
	JobIds []string `json:"job_ids"`
}

Calendar type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/get_calendars/types.ts#L22-L29

func NewCalendar added in v8.5.0 

func NewCalendar() *Calendar

NewCalendar returns a Calendar.

func (*Calendar) UnmarshalJSON added in v8.7.1 

func (s *Calendar) UnmarshalJSON(data []byte) error

type CalendarEvent 

type CalendarEvent struct {
	// CalendarId A string that uniquely identifies a calendar.
	CalendarId *string `json:"calendar_id,omitempty"`
	// Description A description of the scheduled event.
	Description string `json:"description"`
	// EndTime The timestamp for the end of the scheduled event in milliseconds since the
	// epoch or ISO 8601 format.
	EndTime DateTime `json:"end_time"`
	EventId *string  `json:"event_id,omitempty"`
	// StartTime The timestamp for the beginning of the scheduled event in milliseconds since
	// the epoch or ISO 8601 format.
	StartTime DateTime `json:"start_time"`
}

CalendarEvent type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/CalendarEvent.ts#L23-L33

func NewCalendarEvent added in v8.5.0 

func NewCalendarEvent() *CalendarEvent

NewCalendarEvent returns a CalendarEvent.

func (*CalendarEvent) UnmarshalJSON added in v8.7.1 

func (s *CalendarEvent) UnmarshalJSON(data []byte) error

type CardinalityAggregate 

type CardinalityAggregate struct {
	Meta  Metadata `json:"meta,omitempty"`
	Value int64    `json:"value"`
}

CardinalityAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L140-L143

func NewCardinalityAggregate added in v8.5.0 

func NewCardinalityAggregate() *CardinalityAggregate

NewCardinalityAggregate returns a CardinalityAggregate.

func (*CardinalityAggregate) UnmarshalJSON added in v8.7.1 

func (s *CardinalityAggregate) UnmarshalJSON(data []byte) error

type CardinalityAggregation 

type CardinalityAggregation struct {
	// ExecutionHint Mechanism by which cardinality aggregations is run.
	ExecutionHint *cardinalityexecutionmode.CardinalityExecutionMode `json:"execution_hint,omitempty"`
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// PrecisionThreshold A unique count below which counts are expected to be close to accurate.
	// This allows to trade memory for accuracy.
	PrecisionThreshold *int    `json:"precision_threshold,omitempty"`
	Rehash             *bool   `json:"rehash,omitempty"`
	Script             *Script `json:"script,omitempty"`
}

CardinalityAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L87-L99

func NewCardinalityAggregation added in v8.5.0 

func NewCardinalityAggregation() *CardinalityAggregation

NewCardinalityAggregation returns a CardinalityAggregation.

func (*CardinalityAggregation) UnmarshalJSON added in v8.7.1 

func (s *CardinalityAggregation) UnmarshalJSON(data []byte) error

type CatAnonalyDetectorColumns 

type CatAnonalyDetectorColumns []catanomalydetectorcolumn.CatAnomalyDetectorColumn

CatAnonalyDetectorColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L402-L404

type CatComponentTemplate added in v8.5.0 

type CatComponentTemplate struct {
	AliasCount    string  `json:"alias_count"`
	IncludedIn    string  `json:"included_in"`
	MappingCount  string  `json:"mapping_count"`
	MetadataCount string  `json:"metadata_count"`
	Name          string  `json:"name"`
	SettingsCount string  `json:"settings_count"`
	Version       *string `json:"version,omitempty"`
}

CatComponentTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/component_templates/types.ts#L20-L28

func NewCatComponentTemplate added in v8.5.0 

func NewCatComponentTemplate() *CatComponentTemplate

NewCatComponentTemplate returns a CatComponentTemplate.

func (*CatComponentTemplate) UnmarshalJSON added in v8.9.0 

func (s *CatComponentTemplate) UnmarshalJSON(data []byte) error

type CatDatafeedColumns 

type CatDatafeedColumns []catdatafeedcolumn.CatDatafeedColumn

CatDatafeedColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L1015-L1015

type CatDfaColumns 

type CatDfaColumns []catdfacolumn.CatDfaColumn

CatDfaColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L1014-L1014

type CatNodeColumns added in v8.18.1 

type CatNodeColumns []catnodecolumn.CatNodeColumn

CatNodeColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L1016-L1016

type CatTrainedModelsColumns 

type CatTrainedModelsColumns []cattrainedmodelscolumn.CatTrainedModelsColumn

CatTrainedModelsColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L1093-L1095

type CatTransformColumns 

type CatTransformColumns []cattransformcolumn.CatTransformColumn

CatTransformColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/_types/CatBase.ts#L1302-L1302

type CatalanAnalyzer added in v8.16.0 

type CatalanAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

CatalanAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L93-L98

func NewCatalanAnalyzer added in v8.16.0 

func NewCatalanAnalyzer() *CatalanAnalyzer

NewCatalanAnalyzer returns a CatalanAnalyzer.

func (CatalanAnalyzer) MarshalJSON added in v8.16.0 

func (s CatalanAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CatalanAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *CatalanAnalyzer) UnmarshalJSON(data []byte) error

type CategorizationAnalyzer 

type CategorizationAnalyzer any

CategorizationAnalyzer holds the union for the following types: 

string
CategorizationAnalyzerDefinition

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L181-L182

type CategorizationAnalyzerDefinition 

type CategorizationAnalyzerDefinition struct {
	// CharFilter One or more character filters. In addition to the built-in character filters,
	// other plugins can provide more character filters. If this property is not
	// specified, no character filters are applied prior to categorization. If you
	// are customizing some other aspect of the analyzer and you need to achieve the
	// equivalent of `categorization_filters` (which are not permitted when some
	// other aspect of the analyzer is customized), add them here as pattern replace
	// character filters.
	CharFilter []CharFilter `json:"char_filter,omitempty"`
	// Filter One or more token filters. In addition to the built-in token filters, other
	// plugins can provide more token filters. If this property is not specified, no
	// token filters are applied prior to categorization.
	Filter []TokenFilter `json:"filter,omitempty"`
	// Tokenizer The name or definition of the tokenizer to use after character filters are
	// applied. This property is compulsory if `categorization_analyzer` is
	// specified as an object. Machine learning provides a tokenizer called
	// `ml_standard` that tokenizes in a way that has been determined to produce
	// good categorization results on a variety of log file formats for logs in
	// English. If you want to use that tokenizer but change the character or token
	// filters, specify "tokenizer": "ml_standard" in your
	// `categorization_analyzer`. Additionally, the `ml_classic` tokenizer is
	// available, which tokenizes in the same way as the non-customizable tokenizer
	// in old versions of the product (before 6.2). `ml_classic` was the default
	// categorization tokenizer in versions 6.2 to 7.13, so if you need
	// categorization identical to the default for jobs created in these versions,
	// specify "tokenizer": "ml_classic" in your `categorization_analyzer`.
	Tokenizer Tokenizer `json:"tokenizer,omitempty"`
}

CategorizationAnalyzerDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L184-L198

func NewCategorizationAnalyzerDefinition added in v8.5.0 

func NewCategorizationAnalyzerDefinition() *CategorizationAnalyzerDefinition

NewCategorizationAnalyzerDefinition returns a CategorizationAnalyzerDefinition.

func (*CategorizationAnalyzerDefinition) UnmarshalJSON added in v8.7.0 

func (s *CategorizationAnalyzerDefinition) UnmarshalJSON(data []byte) error

type CategorizeTextAggregation 

type CategorizeTextAggregation struct {
	// CategorizationAnalyzer The categorization analyzer specifies how the text is analyzed and tokenized
	// before being categorized.
	// The syntax is very similar to that used to define the analyzer in the
	// `_analyze` endpoint. This property
	// cannot be used at the same time as categorization_filters.
	CategorizationAnalyzer CategorizeTextAnalyzer `json:"categorization_analyzer,omitempty"`
	// CategorizationFilters This property expects an array of regular expressions. The expressions are
	// used to filter out matching
	// sequences from the categorization field values. You can use this
	// functionality to fine tune the categorization
	// by excluding sequences from consideration when categories are defined. For
	// example, you can exclude SQL
	// statements that appear in your log files. This property cannot be used at the
	// same time as categorization_analyzer.
	// If you only want to define simple regular expression filters that are applied
	// prior to tokenization, setting
	// this property is the easiest method. If you also want to customize the
	// tokenizer or post-tokenization filtering,
	// use the categorization_analyzer property instead and include the filters as
	// pattern_replace character filters.
	CategorizationFilters []string `json:"categorization_filters,omitempty"`
	// Field The semi-structured text field to categorize.
	Field string `json:"field"`
	// MaxMatchedTokens The maximum number of token positions to match on before attempting to merge
	// categories. Larger
	// values will use more memory and create narrower categories. Max allowed value
	// is 100.
	MaxMatchedTokens *int `json:"max_matched_tokens,omitempty"`
	// MaxUniqueTokens The maximum number of unique tokens at any position up to max_matched_tokens.
	// Must be larger than 1.
	// Smaller values use less memory and create fewer categories. Larger values
	// will use more memory and
	// create narrower categories. Max allowed value is 100.
	MaxUniqueTokens *int `json:"max_unique_tokens,omitempty"`
	// MinDocCount The minimum number of documents in a bucket to be returned to the results.
	MinDocCount *int `json:"min_doc_count,omitempty"`
	// ShardMinDocCount The minimum number of documents in a bucket to be returned from the shard
	// before merging.
	ShardMinDocCount *int `json:"shard_min_doc_count,omitempty"`
	// ShardSize The number of categorization buckets to return from each shard before merging
	// all the results.
	ShardSize *int `json:"shard_size,omitempty"`
	// SimilarityThreshold The minimum percentage of tokens that must match for text to be added to the
	// category bucket. Must
	// be between 1 and 100. The larger the value the narrower the categories.
	// Larger values will increase memory
	// usage and create narrower categories.
	SimilarityThreshold *int `json:"similarity_threshold,omitempty"`
	// Size The number of buckets to return.
	Size *int `json:"size,omitempty"`
}

CategorizeTextAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1117-L1183

func NewCategorizeTextAggregation added in v8.5.0 

func NewCategorizeTextAggregation() *CategorizeTextAggregation

NewCategorizeTextAggregation returns a CategorizeTextAggregation.

func (*CategorizeTextAggregation) UnmarshalJSON added in v8.7.0 

func (s *CategorizeTextAggregation) UnmarshalJSON(data []byte) error

type CategorizeTextAnalyzer 

type CategorizeTextAnalyzer any

CategorizeTextAnalyzer holds the union for the following types: 

string
CustomCategorizeTextAnalyzer

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1185-L1188

type Category 

type Category struct {
	// CategoryId A unique identifier for the category. category_id is unique at the job level,
	// even when per-partition categorization is enabled.
	CategoryId uint64 `json:"category_id"`
	// Examples A list of examples of actual values that matched the category.
	Examples []string `json:"examples"`
	// GrokPattern [experimental] A Grok pattern that could be used in Logstash or an ingest
	// pipeline to extract fields from messages that match the category. This field
	// is experimental and may be changed or removed in a future release. The Grok
	// patterns that are found are not optimal, but are often a good starting point
	// for manual tweaking.
	GrokPattern *string `json:"grok_pattern,omitempty"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// MaxMatchingLength The maximum length of the fields that matched the category. The value is
	// increased by 10% to enable matching for similar fields that have not been
	// analyzed.
	MaxMatchingLength uint64 `json:"max_matching_length"`
	Mlcategory        string `json:"mlcategory"`
	// NumMatches The number of messages that have been matched by this category. This is only
	// guaranteed to have the latest accurate count after a job _flush or _close
	NumMatches *int64  `json:"num_matches,omitempty"`
	P          *string `json:"p,omitempty"`
	// PartitionFieldName If per-partition categorization is enabled, this property identifies the
	// field used to segment the categorization. It is not present when
	// per-partition categorization is disabled.
	PartitionFieldName *string `json:"partition_field_name,omitempty"`
	// PartitionFieldValue If per-partition categorization is enabled, this property identifies the
	// value of the partition_field_name for the category. It is not present when
	// per-partition categorization is disabled.
	PartitionFieldValue *string `json:"partition_field_value,omitempty"`
	// PreferredToCategories A list of category_id entries that this current category encompasses. Any new
	// message that is processed by the categorizer will match against this category
	// and not any of the categories in this list. This is only guaranteed to have
	// the latest accurate list of categories after a job _flush or _close
	PreferredToCategories []string `json:"preferred_to_categories,omitempty"`
	// Regex A regular expression that is used to search for values that match the
	// category.
	Regex      string `json:"regex"`
	ResultType string `json:"result_type"`
	// Terms A space separated list of the common tokens that are matched in values of the
	// category.
	Terms string `json:"terms"`
}

Category type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Category.ts#L23-L49

func NewCategory added in v8.5.0 

func NewCategory() *Category

NewCategory returns a Category.

func (*Category) UnmarshalJSON added in v8.7.1 

func (s *Category) UnmarshalJSON(data []byte) error

type Ccr 

type Ccr struct {
	AutoFollowPatternsCount int  `json:"auto_follow_patterns_count"`
	Available               bool `json:"available"`
	Enabled                 bool `json:"enabled"`
	FollowerIndicesCount    int  `json:"follower_indices_count"`
}

Ccr type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L344-L347

func NewCcr added in v8.5.0 

func NewCcr() *Ccr

NewCcr returns a Ccr.

func (*Ccr) UnmarshalJSON added in v8.7.1 

func (s *Ccr) UnmarshalJSON(data []byte) error

type CcrShardStats added in v8.5.0 

type CcrShardStats struct {
	// BytesRead The total of transferred bytes read from the leader.
	// This is only an estimate and does not account for compression if enabled.
	BytesRead int64 `json:"bytes_read"`
	// FailedReadRequests The number of failed reads.
	FailedReadRequests int64 `json:"failed_read_requests"`
	// FailedWriteRequests The number of failed bulk write requests on the follower.
	FailedWriteRequests int64       `json:"failed_write_requests"`
	FatalException      *ErrorCause `json:"fatal_exception,omitempty"`
	// FollowerAliasesVersion The index aliases version the follower is synced up to.
	FollowerAliasesVersion int64 `json:"follower_aliases_version"`
	// FollowerGlobalCheckpoint The current global checkpoint on the follower.
	// The difference between the `leader_global_checkpoint` and the
	// `follower_global_checkpoint` is an indication of how much the follower is
	// lagging the leader.
	FollowerGlobalCheckpoint int64 `json:"follower_global_checkpoint"`
	// FollowerIndex The name of the follower index.
	FollowerIndex string `json:"follower_index"`
	// FollowerMappingVersion The mapping version the follower is synced up to.
	FollowerMappingVersion int64 `json:"follower_mapping_version"`
	// FollowerMaxSeqNo The current maximum sequence number on the follower.
	FollowerMaxSeqNo int64 `json:"follower_max_seq_no"`
	// FollowerSettingsVersion The index settings version the follower is synced up to.
	FollowerSettingsVersion int64 `json:"follower_settings_version"`
	// LastRequestedSeqNo The starting sequence number of the last batch of operations requested from
	// the leader.
	LastRequestedSeqNo int64 `json:"last_requested_seq_no"`
	// LeaderGlobalCheckpoint The current global checkpoint on the leader known to the follower task.
	LeaderGlobalCheckpoint int64 `json:"leader_global_checkpoint"`
	// LeaderIndex The name of the index in the leader cluster being followed.
	LeaderIndex string `json:"leader_index"`
	// LeaderMaxSeqNo The current maximum sequence number on the leader known to the follower task.
	LeaderMaxSeqNo int64 `json:"leader_max_seq_no"`
	// OperationsRead The total number of operations read from the leader.
	OperationsRead int64 `json:"operations_read"`
	// OperationsWritten The number of operations written on the follower.
	OperationsWritten int64 `json:"operations_written"`
	// OutstandingReadRequests The number of active read requests from the follower.
	OutstandingReadRequests int `json:"outstanding_read_requests"`
	// OutstandingWriteRequests The number of active bulk write requests on the follower.
	OutstandingWriteRequests int `json:"outstanding_write_requests"`
	// ReadExceptions An array of objects representing failed reads.
	ReadExceptions []ReadException `json:"read_exceptions"`
	// RemoteCluster The remote cluster containing the leader index.
	RemoteCluster string `json:"remote_cluster"`
	// ShardId The numerical shard ID, with values from 0 to one less than the number of
	// replicas.
	ShardId int `json:"shard_id"`
	// SuccessfulReadRequests The number of successful fetches.
	SuccessfulReadRequests int64 `json:"successful_read_requests"`
	// SuccessfulWriteRequests The number of bulk write requests run on the follower.
	SuccessfulWriteRequests int64    `json:"successful_write_requests"`
	TimeSinceLastRead       Duration `json:"time_since_last_read,omitempty"`
	// TimeSinceLastReadMillis The number of milliseconds since a read request was sent to the leader.
	// When the follower is caught up to the leader, this number will increase up to
	// the configured `read_poll_timeout` at which point another read request will
	// be sent to the leader.
	TimeSinceLastReadMillis int64    `json:"time_since_last_read_millis"`
	TotalReadRemoteExecTime Duration `json:"total_read_remote_exec_time,omitempty"`
	// TotalReadRemoteExecTimeMillis The total time reads spent running on the remote cluster.
	TotalReadRemoteExecTimeMillis int64    `json:"total_read_remote_exec_time_millis"`
	TotalReadTime                 Duration `json:"total_read_time,omitempty"`
	// TotalReadTimeMillis The total time reads were outstanding, measured from the time a read was sent
	// to the leader to the time a reply was returned to the follower.
	TotalReadTimeMillis int64    `json:"total_read_time_millis"`
	TotalWriteTime      Duration `json:"total_write_time,omitempty"`
	// TotalWriteTimeMillis The total time spent writing on the follower.
	TotalWriteTimeMillis int64 `json:"total_write_time_millis"`
	// WriteBufferOperationCount The number of write operations queued on the follower.
	WriteBufferOperationCount int64 `json:"write_buffer_operation_count"`
	// WriteBufferSizeInBytes The total number of bytes of operations currently queued for writing.
	WriteBufferSizeInBytes ByteSize `json:"write_buffer_size_in_bytes"`
}

CcrShardStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/_types/FollowIndexStats.ts#L37-L109

func NewCcrShardStats added in v8.5.0 

func NewCcrShardStats() *CcrShardStats

NewCcrShardStats returns a CcrShardStats.

func (*CcrShardStats) UnmarshalJSON added in v8.7.1 

func (s *CcrShardStats) UnmarshalJSON(data []byte) error

type CertificateInformation 

type CertificateInformation struct {
	// Alias If the path refers to a container file (a jks keystore, or a PKCS#12 file),
	// it is the alias of the certificate.
	// Otherwise, it is null.
	Alias *string `json:"alias,omitempty"`
	// Expiry The ISO formatted date of the certificate's expiry (not-after) date.
	Expiry DateTime `json:"expiry"`
	// Format The format of the file.
	// Valid values include `jks`, `PKCS12`, and `PEM`.
	Format string `json:"format"`
	// HasPrivateKey Indicates whether Elasticsearch has access to the private key for this
	// certificate.
	HasPrivateKey bool `json:"has_private_key"`
	// Issuer The Distinguished Name of the certificate's issuer.
	Issuer *string `json:"issuer,omitempty"`
	// Path The path to the certificate, as configured in the `elasticsearch.yml` file.
	Path string `json:"path"`
	// SerialNumber The hexadecimal representation of the certificate's serial number.
	SerialNumber string `json:"serial_number"`
	// SubjectDn The Distinguished Name of the certificate's subject.
	SubjectDn string `json:"subject_dn"`
}

CertificateInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ssl/certificates/types.ts#L22-L57

func NewCertificateInformation added in v8.5.0 

func NewCertificateInformation() *CertificateInformation

NewCertificateInformation returns a CertificateInformation.

func (*CertificateInformation) UnmarshalJSON added in v8.7.1 

func (s *CertificateInformation) UnmarshalJSON(data []byte) error

type Cgroup 

type Cgroup struct {
	// Cpu Contains statistics about `cpu` control group for the node.
	Cpu *CgroupCpu `json:"cpu,omitempty"`
	// Cpuacct Contains statistics about `cpuacct` control group for the node.
	Cpuacct *CpuAcct `json:"cpuacct,omitempty"`
	// Memory Contains statistics about the memory control group for the node.
	Memory *CgroupMemory `json:"memory,omitempty"`
}

Cgroup type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L497-L510

func NewCgroup added in v8.5.0 

func NewCgroup() *Cgroup

NewCgroup returns a Cgroup.

type CgroupCpu 

type CgroupCpu struct {
	// CfsPeriodMicros The period of time, in microseconds, for how regularly all tasks in the same
	// cgroup as the Elasticsearch process should have their access to CPU resources
	// reallocated.
	CfsPeriodMicros *int `json:"cfs_period_micros,omitempty"`
	// CfsQuotaMicros The total amount of time, in microseconds, for which all tasks in the same
	// cgroup as the Elasticsearch process can run during one period
	// `cfs_period_micros`.
	CfsQuotaMicros *int `json:"cfs_quota_micros,omitempty"`
	// ControlGroup The `cpu` control group to which the Elasticsearch process belongs.
	ControlGroup *string `json:"control_group,omitempty"`
	// Stat Contains CPU statistics for the node.
	Stat *CgroupCpuStat `json:"stat,omitempty"`
}

CgroupCpu type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L523-L540

func NewCgroupCpu added in v8.5.0 

func NewCgroupCpu() *CgroupCpu

NewCgroupCpu returns a CgroupCpu.

func (*CgroupCpu) UnmarshalJSON added in v8.7.1 

func (s *CgroupCpu) UnmarshalJSON(data []byte) error

type CgroupCpuStat 

type CgroupCpuStat struct {
	// NumberOfElapsedPeriods The number of reporting periods (as specified by `cfs_period_micros`) that
	// have elapsed.
	NumberOfElapsedPeriods *int64 `json:"number_of_elapsed_periods,omitempty"`
	// NumberOfTimesThrottled The number of times all tasks in the same cgroup as the Elasticsearch process
	// have been throttled.
	NumberOfTimesThrottled *int64 `json:"number_of_times_throttled,omitempty"`
	// TimeThrottledNanos The total amount of time, in nanoseconds, for which all tasks in the same
	// cgroup as the Elasticsearch process have been throttled.
	TimeThrottledNanos *int64 `json:"time_throttled_nanos,omitempty"`
}

CgroupCpuStat type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L542-L555

func NewCgroupCpuStat added in v8.5.0 

func NewCgroupCpuStat() *CgroupCpuStat

NewCgroupCpuStat returns a CgroupCpuStat.

func (*CgroupCpuStat) UnmarshalJSON added in v8.7.1 

func (s *CgroupCpuStat) UnmarshalJSON(data []byte) error

type CgroupMemory 

type CgroupMemory struct {
	// ControlGroup The `memory` control group to which the Elasticsearch process belongs.
	ControlGroup *string `json:"control_group,omitempty"`
	// LimitInBytes The maximum amount of user memory (including file cache) allowed for all
	// tasks in the same cgroup as the Elasticsearch process.
	// This value can be too big to store in a `long`, so is returned as a string so
	// that the value returned can exactly match what the underlying operating
	// system interface returns.
	// Any value that is too large to parse into a `long` almost certainly means no
	// limit has been set for the cgroup.
	LimitInBytes *string `json:"limit_in_bytes,omitempty"`
	// UsageInBytes The total current memory usage by processes in the cgroup, in bytes, by all
	// tasks in the same cgroup as the Elasticsearch process.
	// This value is stored as a string for consistency with `limit_in_bytes`.
	UsageInBytes *string `json:"usage_in_bytes,omitempty"`
}

CgroupMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L557-L573

func NewCgroupMemory added in v8.5.0 

func NewCgroupMemory() *CgroupMemory

NewCgroupMemory returns a CgroupMemory.

func (*CgroupMemory) UnmarshalJSON added in v8.9.0 

func (s *CgroupMemory) UnmarshalJSON(data []byte) error

type ChainInput 

type ChainInput struct {
	Inputs []map[string]WatcherInput `json:"inputs"`
}

ChainInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L35-L37

func NewChainInput added in v8.5.0 

func NewChainInput() *ChainInput

NewChainInput returns a ChainInput.

type CharFilter 

type CharFilter any

CharFilter holds the union for the following types: 

string
CharFilterDefinition

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/char_filters.ts#L28-L33

type CharFilterDefinition 

type CharFilterDefinition any

CharFilterDefinition holds the union for the following types: 

HtmlStripCharFilter
MappingCharFilter
PatternReplaceCharFilter
IcuNormalizationCharFilter
KuromojiIterationMarkCharFilter

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/char_filters.ts#L35-L44

type CharFilterDetail 

type CharFilterDetail struct {
	FilteredText []string `json:"filtered_text"`
	Name         string   `json:"name"`
}

CharFilterDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L46-L49

func NewCharFilterDetail added in v8.5.0 

func NewCharFilterDetail() *CharFilterDetail

NewCharFilterDetail returns a CharFilterDetail.

func (*CharFilterDetail) UnmarshalJSON added in v8.9.0 

func (s *CharFilterDetail) UnmarshalJSON(data []byte) error

type CharFilterTypes 

type CharFilterTypes struct {
	// AnalyzerTypes Contains statistics about analyzer types used in selected nodes.
	AnalyzerTypes []FieldTypes `json:"analyzer_types"`
	// BuiltInAnalyzers Contains statistics about built-in analyzers used in selected nodes.
	BuiltInAnalyzers []FieldTypes `json:"built_in_analyzers"`
	// BuiltInCharFilters Contains statistics about built-in character filters used in selected nodes.
	BuiltInCharFilters []FieldTypes `json:"built_in_char_filters"`
	// BuiltInFilters Contains statistics about built-in token filters used in selected nodes.
	BuiltInFilters []FieldTypes `json:"built_in_filters"`
	// BuiltInTokenizers Contains statistics about built-in tokenizers used in selected nodes.
	BuiltInTokenizers []FieldTypes `json:"built_in_tokenizers"`
	// CharFilterTypes Contains statistics about character filter types used in selected nodes.
	CharFilterTypes []FieldTypes `json:"char_filter_types"`
	// FilterTypes Contains statistics about token filter types used in selected nodes.
	FilterTypes []FieldTypes `json:"filter_types"`
	// TokenizerTypes Contains statistics about tokenizer types used in selected nodes.
	TokenizerTypes []FieldTypes `json:"tokenizer_types"`
}

CharFilterTypes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L228-L261

func NewCharFilterTypes added in v8.5.0 

func NewCharFilterTypes() *CharFilterTypes

NewCharFilterTypes returns a CharFilterTypes.

type CharGroupTokenizer 

type CharGroupTokenizer struct {
	MaxTokenLength  *int     `json:"max_token_length,omitempty"`
	TokenizeOnChars []string `json:"tokenize_on_chars"`
	Type            string   `json:"type,omitempty"`
	Version         *string  `json:"version,omitempty"`
}

CharGroupTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L31-L38

func NewCharGroupTokenizer added in v8.5.0 

func NewCharGroupTokenizer() *CharGroupTokenizer

NewCharGroupTokenizer returns a CharGroupTokenizer.

func (CharGroupTokenizer) MarshalJSON added in v8.9.0 

func (s CharGroupTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CharGroupTokenizer) UnmarshalJSON added in v8.7.1 

func (s *CharGroupTokenizer) UnmarshalJSON(data []byte) error

type CheckpointStats 

type CheckpointStats struct {
	Checkpoint           int64              `json:"checkpoint"`
	CheckpointProgress   *TransformProgress `json:"checkpoint_progress,omitempty"`
	TimeUpperBound       DateTime           `json:"time_upper_bound,omitempty"`
	TimeUpperBoundMillis *int64             `json:"time_upper_bound_millis,omitempty"`
	Timestamp            DateTime           `json:"timestamp,omitempty"`
	TimestampMillis      *int64             `json:"timestamp_millis,omitempty"`
}

CheckpointStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L93-L100

func NewCheckpointStats added in v8.5.0 

func NewCheckpointStats() *CheckpointStats

NewCheckpointStats returns a CheckpointStats.

func (*CheckpointStats) UnmarshalJSON added in v8.7.1 

func (s *CheckpointStats) UnmarshalJSON(data []byte) error

type Checkpointing 

type Checkpointing struct {
	ChangesLastDetectedAt       *int64           `json:"changes_last_detected_at,omitempty"`
	ChangesLastDetectedAtString DateTime         `json:"changes_last_detected_at_string,omitempty"`
	Last                        CheckpointStats  `json:"last"`
	LastSearchTime              *int64           `json:"last_search_time,omitempty"`
	LastSearchTimeString        DateTime         `json:"last_search_time_string,omitempty"`
	Next                        *CheckpointStats `json:"next,omitempty"`
	OperationsBehind            *int64           `json:"operations_behind,omitempty"`
}

Checkpointing type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L102-L110

func NewCheckpointing added in v8.5.0 

func NewCheckpointing() *Checkpointing

NewCheckpointing returns a Checkpointing.

func (*Checkpointing) UnmarshalJSON added in v8.7.1 

func (s *Checkpointing) UnmarshalJSON(data []byte) error

type ChiSquareHeuristic 

type ChiSquareHeuristic struct {
	// BackgroundIsSuperset Set to `false` if you defined a custom background filter that represents a
	// different set of documents that you want to compare to.
	BackgroundIsSuperset bool `json:"background_is_superset"`
	// IncludeNegatives Set to `false` to filter out the terms that appear less often in the subset
	// than in documents outside the subset.
	IncludeNegatives bool `json:"include_negatives"`
}

ChiSquareHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L782-L791

func NewChiSquareHeuristic added in v8.5.0 

func NewChiSquareHeuristic() *ChiSquareHeuristic

NewChiSquareHeuristic returns a ChiSquareHeuristic.

func (*ChiSquareHeuristic) UnmarshalJSON added in v8.7.1 

func (s *ChiSquareHeuristic) UnmarshalJSON(data []byte) error

type ChildrenAggregate 

type ChildrenAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

ChildrenAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L888-L892

func NewChildrenAggregate added in v8.5.0 

func NewChildrenAggregate() *ChildrenAggregate

NewChildrenAggregate returns a ChildrenAggregate.

func (ChildrenAggregate) MarshalJSON 

func (s ChildrenAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ChildrenAggregate) UnmarshalJSON added in v8.7.0 

func (s *ChildrenAggregate) UnmarshalJSON(data []byte) error

type ChildrenAggregation 

type ChildrenAggregation struct {
	// Type The child type that should be selected.
	Type *string `json:"type,omitempty"`
}

ChildrenAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L121-L126

func NewChildrenAggregation added in v8.5.0 

func NewChildrenAggregation() *ChildrenAggregation

NewChildrenAggregation returns a ChildrenAggregation.

func (*ChildrenAggregation) UnmarshalJSON added in v8.7.1 

func (s *ChildrenAggregation) UnmarshalJSON(data []byte) error

type ChineseAnalyzer added in v8.16.0 

type ChineseAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

ChineseAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L100-L104

func NewChineseAnalyzer added in v8.16.0 

func NewChineseAnalyzer() *ChineseAnalyzer

NewChineseAnalyzer returns a ChineseAnalyzer.

func (ChineseAnalyzer) MarshalJSON added in v8.16.0 

func (s ChineseAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ChineseAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *ChineseAnalyzer) UnmarshalJSON(data []byte) error

type ChunkingConfig 

type ChunkingConfig struct {
	// Mode If the mode is `auto`, the chunk size is dynamically calculated;
	// this is the recommended value when the datafeed does not use aggregations.
	// If the mode is `manual`, chunking is applied according to the specified
	// `time_span`;
	// use this mode when the datafeed uses aggregations. If the mode is `off`, no
	// chunking is applied.
	Mode chunkingmode.ChunkingMode `json:"mode"`
	// TimeSpan The time span that each search will be querying. This setting is applicable
	// only when the `mode` is set to `manual`.
	TimeSpan Duration `json:"time_span,omitempty"`
}

ChunkingConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L251-L264

func NewChunkingConfig added in v8.5.0 

func NewChunkingConfig() *ChunkingConfig

NewChunkingConfig returns a ChunkingConfig.

func (*ChunkingConfig) UnmarshalJSON added in v8.7.1 

func (s *ChunkingConfig) UnmarshalJSON(data []byte) error

type CircleProcessor 

type CircleProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// ErrorDistance The difference between the resulting inscribed distance from center to side
	// and the circle’s radius (measured in meters for `geo_shape`, unit-less for
	// `shape`).
	ErrorDistance Float64 `json:"error_distance"`
	// Field The field to interpret as a circle. Either a string in WKT format or a map
	// for GeoJSON.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// ShapeType Which field mapping type is to be used when processing the circle:
	// `geo_shape` or `shape`.
	ShapeType shapetype.ShapeType `json:"shape_type"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the polygon shape to
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

CircleProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L573-L596

func NewCircleProcessor added in v8.5.0 

func NewCircleProcessor() *CircleProcessor

NewCircleProcessor returns a CircleProcessor.

func (*CircleProcessor) UnmarshalJSON added in v8.7.1 

func (s *CircleProcessor) UnmarshalJSON(data []byte) error

type CjkAnalyzer added in v8.16.0 

type CjkAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

CjkAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L106-L110

func NewCjkAnalyzer added in v8.16.0 

func NewCjkAnalyzer() *CjkAnalyzer

NewCjkAnalyzer returns a CjkAnalyzer.

func (CjkAnalyzer) MarshalJSON added in v8.16.0 

func (s CjkAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CjkAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *CjkAnalyzer) UnmarshalJSON(data []byte) error

type CjkBigramTokenFilter added in v8.18.1 

type CjkBigramTokenFilter struct {
	// IgnoredScripts Array of character scripts for which to disable bigrams.
	IgnoredScripts []cjkbigramignoredscript.CjkBigramIgnoredScript `json:"ignored_scripts,omitempty"`
	// OutputUnigrams If `true`, emit tokens in both bigram and unigram form. If `false`, a CJK
	// character is output in unigram form when it has no adjacent characters.
	// Defaults to `false`.
	OutputUnigrams *bool   `json:"output_unigrams,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

CjkBigramTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L465-L471

func NewCjkBigramTokenFilter added in v8.18.1 

func NewCjkBigramTokenFilter() *CjkBigramTokenFilter

NewCjkBigramTokenFilter returns a CjkBigramTokenFilter.

func (CjkBigramTokenFilter) MarshalJSON added in v8.18.1 

func (s CjkBigramTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CjkBigramTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *CjkBigramTokenFilter) UnmarshalJSON(data []byte) error

type CjkWidthTokenFilter added in v8.18.1 

type CjkWidthTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

CjkWidthTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L473-L475

func NewCjkWidthTokenFilter added in v8.18.1 

func NewCjkWidthTokenFilter() *CjkWidthTokenFilter

NewCjkWidthTokenFilter returns a CjkWidthTokenFilter.

func (CjkWidthTokenFilter) MarshalJSON added in v8.18.1 

func (s CjkWidthTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CjkWidthTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *CjkWidthTokenFilter) UnmarshalJSON(data []byte) error

type ClassicTokenFilter added in v8.18.1 

type ClassicTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ClassicTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L477-L479

func NewClassicTokenFilter added in v8.18.1 

func NewClassicTokenFilter() *ClassicTokenFilter

NewClassicTokenFilter returns a ClassicTokenFilter.

func (ClassicTokenFilter) MarshalJSON added in v8.18.1 

func (s ClassicTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ClassicTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *ClassicTokenFilter) UnmarshalJSON(data []byte) error

type ClassicTokenizer added in v8.16.0 

type ClassicTokenizer struct {
	MaxTokenLength *int    `json:"max_token_length,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

ClassicTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L40-L46

func NewClassicTokenizer added in v8.16.0 

func NewClassicTokenizer() *ClassicTokenizer

NewClassicTokenizer returns a ClassicTokenizer.

func (ClassicTokenizer) MarshalJSON added in v8.16.0 

func (s ClassicTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ClassicTokenizer) UnmarshalJSON added in v8.16.0 

func (s *ClassicTokenizer) UnmarshalJSON(data []byte) error

type ClassificationInferenceOptions 

type ClassificationInferenceOptions struct {
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// NumTopFeatureImportanceValues Specifies the maximum number of feature importance values per document.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// PredictionFieldType Specifies the type of the predicted field to write. Acceptable values are:
	// string, number, boolean. When boolean is provided 1.0 is transformed to true
	// and 0.0 to false.
	PredictionFieldType *string `json:"prediction_field_type,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// TopClassesResultsField Specifies the field to which the top classes are written. Defaults to
	// top_classes.
	TopClassesResultsField *string `json:"top_classes_results_field,omitempty"`
}

ClassificationInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L118-L133

func NewClassificationInferenceOptions added in v8.5.0 

func NewClassificationInferenceOptions() *ClassificationInferenceOptions

NewClassificationInferenceOptions returns a ClassificationInferenceOptions.

func (*ClassificationInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *ClassificationInferenceOptions) UnmarshalJSON(data []byte) error

type CleanupRepositoryResults 

type CleanupRepositoryResults struct {
	// DeletedBlobs Number of binary large objects (blobs) removed during cleanup.
	DeletedBlobs int64 `json:"deleted_blobs"`
	// DeletedBytes Number of bytes freed by cleanup operations.
	DeletedBytes int64 `json:"deleted_bytes"`
}

CleanupRepositoryResults type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L29-L34

func NewCleanupRepositoryResults added in v8.5.0 

func NewCleanupRepositoryResults() *CleanupRepositoryResults

NewCleanupRepositoryResults returns a CleanupRepositoryResults.

func (*CleanupRepositoryResults) UnmarshalJSON added in v8.7.1 

func (s *CleanupRepositoryResults) UnmarshalJSON(data []byte) error

type Client 

type Client struct {
	// Agent Reported agent for the HTTP client.
	// If unavailable, this property is not included in the response.
	Agent *string `json:"agent,omitempty"`
	// ClosedTimeMillis Time at which the client closed the connection if the connection is closed.
	ClosedTimeMillis *int64 `json:"closed_time_millis,omitempty"`
	// Id Unique ID for the HTTP client.
	Id *int64 `json:"id,omitempty"`
	// LastRequestTimeMillis Time of the most recent request from this client.
	LastRequestTimeMillis *int64 `json:"last_request_time_millis,omitempty"`
	// LastUri The URI of the client’s most recent request.
	LastUri *string `json:"last_uri,omitempty"`
	// LocalAddress Local address for the HTTP connection.
	LocalAddress *string `json:"local_address,omitempty"`
	// OpenedTimeMillis Time at which the client opened the connection.
	OpenedTimeMillis *int64 `json:"opened_time_millis,omitempty"`
	// RemoteAddress Remote address for the HTTP connection.
	RemoteAddress *string `json:"remote_address,omitempty"`
	// RequestCount Number of requests from this client.
	RequestCount *int64 `json:"request_count,omitempty"`
	// RequestSizeBytes Cumulative size in bytes of all requests from this client.
	RequestSizeBytes *int64 `json:"request_size_bytes,omitempty"`
	// XOpaqueId Value from the client’s `x-opaque-id` HTTP header.
	// If unavailable, this property is not included in the response.
	XOpaqueId *string `json:"x_opaque_id,omitempty"`
}

Client type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L720-L767

func NewClient added in v8.5.0 

func NewClient() *Client

NewClient returns a Client.

func (*Client) UnmarshalJSON added in v8.7.1 

func (s *Client) UnmarshalJSON(data []byte) error

type CloseIndexResult 

type CloseIndexResult struct {
	Closed bool                        `json:"closed"`
	Shards map[string]CloseShardResult `json:"shards,omitempty"`
}

CloseIndexResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/close/CloseIndexResponse.ts#L32-L35

func NewCloseIndexResult added in v8.5.0 

func NewCloseIndexResult() *CloseIndexResult

NewCloseIndexResult returns a CloseIndexResult.

func (*CloseIndexResult) UnmarshalJSON added in v8.7.1 

func (s *CloseIndexResult) UnmarshalJSON(data []byte) error

type CloseShardResult 

type CloseShardResult struct {
	Failures []ShardFailure `json:"failures"`
}

CloseShardResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/close/CloseIndexResponse.ts#L37-L39

func NewCloseShardResult added in v8.5.0 

func NewCloseShardResult() *CloseShardResult

NewCloseShardResult returns a CloseShardResult.

type ClusterAppliedStats 

type ClusterAppliedStats struct {
	Recordings []Recording `json:"recordings,omitempty"`
}

ClusterAppliedStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L221-L223

func NewClusterAppliedStats added in v8.5.0 

func NewClusterAppliedStats() *ClusterAppliedStats

NewClusterAppliedStats returns a ClusterAppliedStats.

type ClusterComponentTemplate added in v8.5.0 

type ClusterComponentTemplate struct {
	ComponentTemplate ComponentTemplateNode `json:"component_template"`
	Name              string                `json:"name"`
}

ClusterComponentTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/_types/ComponentTemplate.ts#L27-L30

func NewClusterComponentTemplate added in v8.5.0 

func NewClusterComponentTemplate() *ClusterComponentTemplate

NewClusterComponentTemplate returns a ClusterComponentTemplate.

func (*ClusterComponentTemplate) UnmarshalJSON added in v8.7.1 

func (s *ClusterComponentTemplate) UnmarshalJSON(data []byte) error

type ClusterDetails added in v8.10.0 

type ClusterDetails struct {
	Failures []ShardFailure                          `json:"failures,omitempty"`
	Indices  string                                  `json:"indices"`
	Shards_  *ShardStatistics                        `json:"_shards,omitempty"`
	Status   clustersearchstatus.ClusterSearchStatus `json:"status"`
	TimedOut bool                                    `json:"timed_out"`
	Took     *int64                                  `json:"took,omitempty"`
}

ClusterDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L45-L52

func NewClusterDetails added in v8.10.0 

func NewClusterDetails() *ClusterDetails

NewClusterDetails returns a ClusterDetails.

func (*ClusterDetails) UnmarshalJSON added in v8.10.0 

func (s *ClusterDetails) UnmarshalJSON(data []byte) error

type ClusterFileSystem 

type ClusterFileSystem struct {
	// AvailableInBytes Total number of bytes available to JVM in file stores across all selected
	// nodes.
	// Depending on operating system or process-level restrictions, this number may
	// be less than `nodes.fs.free_in_byes`.
	// This is the actual amount of free disk space the selected Elasticsearch nodes
	// can use.
	AvailableInBytes int64 `json:"available_in_bytes"`
	// FreeInBytes Total number of unallocated bytes in file stores across all selected nodes.
	FreeInBytes int64 `json:"free_in_bytes"`
	// TotalInBytes Total size, in bytes, of all file stores across all selected nodes.
	TotalInBytes int64 `json:"total_in_bytes"`
}

ClusterFileSystem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L34-L49

func NewClusterFileSystem added in v8.5.0 

func NewClusterFileSystem() *ClusterFileSystem

NewClusterFileSystem returns a ClusterFileSystem.

func (*ClusterFileSystem) UnmarshalJSON added in v8.7.1 

func (s *ClusterFileSystem) UnmarshalJSON(data []byte) error

type ClusterIndexingPressure added in v8.5.0 

type ClusterIndexingPressure struct {
	Memory ClusterPressureMemory `json:"memory"`
}

ClusterIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L570-L572

func NewClusterIndexingPressure added in v8.5.0 

func NewClusterIndexingPressure() *ClusterIndexingPressure

NewClusterIndexingPressure returns a ClusterIndexingPressure.

type ClusterIndices 

type ClusterIndices struct {
	// Analysis Contains statistics about analyzers and analyzer components used in selected
	// nodes.
	Analysis CharFilterTypes `json:"analysis"`
	// Completion Contains statistics about memory used for completion in selected nodes.
	Completion CompletionStats `json:"completion"`
	// Count Total number of indices with shards assigned to selected nodes.
	Count int64 `json:"count"`
	// Docs Contains counts for documents in selected nodes.
	Docs DocStats `json:"docs"`
	// Fielddata Contains statistics about the field data cache of selected nodes.
	Fielddata FielddataStats `json:"fielddata"`
	// Mappings Contains statistics about field mappings in selected nodes.
	Mappings FieldTypesMappings `json:"mappings"`
	// QueryCache Contains statistics about the query cache of selected nodes.
	QueryCache QueryCacheStats `json:"query_cache"`
	// Segments Contains statistics about segments in selected nodes.
	Segments SegmentsStats `json:"segments"`
	// Shards Contains statistics about indices with shards assigned to selected nodes.
	Shards ClusterIndicesShards `json:"shards"`
	// Store Contains statistics about the size of shards assigned to selected nodes.
	Store StoreStats `json:"store"`
	// Versions Contains statistics about analyzers and analyzer components used in selected
	// nodes.
	Versions []IndicesVersions `json:"versions,omitempty"`
}

ClusterIndices type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L74-L107

func NewClusterIndices added in v8.5.0 

func NewClusterIndices() *ClusterIndices

NewClusterIndices returns a ClusterIndices.

func (*ClusterIndices) UnmarshalJSON added in v8.7.1 

func (s *ClusterIndices) UnmarshalJSON(data []byte) error

type ClusterIndicesShards 

type ClusterIndicesShards struct {
	// Index Contains statistics about shards assigned to selected nodes.
	Index *ClusterIndicesShardsIndex `json:"index,omitempty"`
	// Primaries Number of primary shards assigned to selected nodes.
	Primaries *Float64 `json:"primaries,omitempty"`
	// Replication Ratio of replica shards to primary shards across all selected nodes.
	Replication *Float64 `json:"replication,omitempty"`
	// Total Total number of shards assigned to selected nodes.
	Total *Float64 `json:"total,omitempty"`
}

ClusterIndicesShards type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L60-L72

func NewClusterIndicesShards added in v8.5.0 

func NewClusterIndicesShards() *ClusterIndicesShards

NewClusterIndicesShards returns a ClusterIndicesShards.

func (*ClusterIndicesShards) UnmarshalJSON added in v8.7.1 

func (s *ClusterIndicesShards) UnmarshalJSON(data []byte) error

type ClusterIndicesShardsIndex 

type ClusterIndicesShardsIndex struct {
	// Primaries Contains statistics about the number of primary shards assigned to selected
	// nodes.
	Primaries ClusterShardMetrics `json:"primaries"`
	// Replication Contains statistics about the number of replication shards assigned to
	// selected nodes.
	Replication ClusterShardMetrics `json:"replication"`
	// Shards Contains statistics about the number of shards assigned to selected nodes.
	Shards ClusterShardMetrics `json:"shards"`
}

ClusterIndicesShardsIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L51-L58

func NewClusterIndicesShardsIndex added in v8.5.0 

func NewClusterIndicesShardsIndex() *ClusterIndicesShardsIndex

NewClusterIndicesShardsIndex returns a ClusterIndicesShardsIndex.

type ClusterInfo 

type ClusterInfo struct {
	Nodes             map[string]NodeDiskUsage `json:"nodes"`
	ReservedSizes     []ReservedSize           `json:"reserved_sizes"`
	ShardDataSetSizes map[string]string        `json:"shard_data_set_sizes,omitempty"`
	ShardPaths        map[string]string        `json:"shard_paths"`
	ShardSizes        map[string]int64         `json:"shard_sizes"`
}

ClusterInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L49-L55

func NewClusterInfo added in v8.5.0 

func NewClusterInfo() *ClusterInfo

NewClusterInfo returns a ClusterInfo.

type ClusterInfoTargets added in v8.9.0 

type ClusterInfoTargets []clusterinfotarget.ClusterInfoTarget

ClusterInfoTargets type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L393-L393

type ClusterIngest 

type ClusterIngest struct {
	NumberOfPipelines int                         `json:"number_of_pipelines"`
	ProcessorStats    map[string]ClusterProcessor `json:"processor_stats"`
}

ClusterIngest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L270-L273

func NewClusterIngest added in v8.5.0 

func NewClusterIngest() *ClusterIngest

NewClusterIngest returns a ClusterIngest.

func (*ClusterIngest) UnmarshalJSON added in v8.7.1 

func (s *ClusterIngest) UnmarshalJSON(data []byte) error

type ClusterJvm 

type ClusterJvm struct {
	// MaxUptimeInMillis Uptime duration, in milliseconds, since JVM last started.
	MaxUptimeInMillis int64 `json:"max_uptime_in_millis"`
	// Mem Contains statistics about memory used by selected nodes.
	Mem ClusterJvmMemory `json:"mem"`
	// Threads Number of active threads in use by JVM across all selected nodes.
	Threads int64 `json:"threads"`
	// Versions Contains statistics about the JVM versions used by selected nodes.
	Versions []ClusterJvmVersion `json:"versions"`
}

ClusterJvm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L275-L292

func NewClusterJvm added in v8.5.0 

func NewClusterJvm() *ClusterJvm

NewClusterJvm returns a ClusterJvm.

func (*ClusterJvm) UnmarshalJSON added in v8.7.1 

func (s *ClusterJvm) UnmarshalJSON(data []byte) error

type ClusterJvmMemory 

type ClusterJvmMemory struct {
	// HeapMaxInBytes Maximum amount of memory, in bytes, available for use by the heap across all
	// selected nodes.
	HeapMaxInBytes int64 `json:"heap_max_in_bytes"`
	// HeapUsedInBytes Memory, in bytes, currently in use by the heap across all selected nodes.
	HeapUsedInBytes int64 `json:"heap_used_in_bytes"`
}

ClusterJvmMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L294-L303

func NewClusterJvmMemory added in v8.5.0 

func NewClusterJvmMemory() *ClusterJvmMemory

NewClusterJvmMemory returns a ClusterJvmMemory.

func (*ClusterJvmMemory) UnmarshalJSON added in v8.7.1 

func (s *ClusterJvmMemory) UnmarshalJSON(data []byte) error

type ClusterJvmVersion 

type ClusterJvmVersion struct {
	// BundledJdk Always `true`. All distributions come with a bundled Java Development Kit
	// (JDK).
	BundledJdk bool `json:"bundled_jdk"`
	// Count Total number of selected nodes using JVM.
	Count int `json:"count"`
	// UsingBundledJdk If `true`, a bundled JDK is in use by JVM.
	UsingBundledJdk bool `json:"using_bundled_jdk"`
	// Version Version of JVM used by one or more selected nodes.
	Version string `json:"version"`
	// VmName Name of the JVM.
	VmName string `json:"vm_name"`
	// VmVendor Vendor of the JVM.
	VmVendor string `json:"vm_vendor"`
	// VmVersion Full version number of JVM.
	// The full version number includes a plus sign (+) followed by the build
	// number.
	VmVersion string `json:"vm_version"`
}

ClusterJvmVersion type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L305-L335

func NewClusterJvmVersion added in v8.5.0 

func NewClusterJvmVersion() *ClusterJvmVersion

NewClusterJvmVersion returns a ClusterJvmVersion.

func (*ClusterJvmVersion) UnmarshalJSON added in v8.7.1 

func (s *ClusterJvmVersion) UnmarshalJSON(data []byte) error

type ClusterNetworkTypes 

type ClusterNetworkTypes struct {
	// HttpTypes Contains statistics about the HTTP network types used by selected nodes.
	HttpTypes map[string]int `json:"http_types"`
	// TransportTypes Contains statistics about the transport network types used by selected nodes.
	TransportTypes map[string]int `json:"transport_types"`
}

ClusterNetworkTypes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L337-L346

func NewClusterNetworkTypes added in v8.5.0 

func NewClusterNetworkTypes() *ClusterNetworkTypes

NewClusterNetworkTypes returns a ClusterNetworkTypes.

type ClusterNode 

type ClusterNode struct {
	Name string `json:"name"`
}

ClusterNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/ClusterNode.ts#L22-L24

func NewClusterNode added in v8.5.0 

func NewClusterNode() *ClusterNode

NewClusterNode returns a ClusterNode.

func (*ClusterNode) UnmarshalJSON added in v8.7.1 

func (s *ClusterNode) UnmarshalJSON(data []byte) error

type ClusterNodeCount 

type ClusterNodeCount struct {
	CoordinatingOnly    int  `json:"coordinating_only"`
	Data                int  `json:"data"`
	DataCold            int  `json:"data_cold"`
	DataContent         int  `json:"data_content"`
	DataFrozen          *int `json:"data_frozen,omitempty"`
	DataHot             int  `json:"data_hot"`
	DataWarm            int  `json:"data_warm"`
	Ingest              int  `json:"ingest"`
	Master              int  `json:"master"`
	Ml                  int  `json:"ml"`
	RemoteClusterClient int  `json:"remote_cluster_client"`
	Total               int  `json:"total"`
	Transform           int  `json:"transform"`
	VotingOnly          int  `json:"voting_only"`
}

ClusterNodeCount type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L348-L367

func NewClusterNodeCount added in v8.5.0 

func NewClusterNodeCount() *ClusterNodeCount

NewClusterNodeCount returns a ClusterNodeCount.

func (*ClusterNodeCount) UnmarshalJSON added in v8.7.1 

func (s *ClusterNodeCount) UnmarshalJSON(data []byte) error

type ClusterNodes 

type ClusterNodes struct {
	// Count Contains counts for nodes selected by the request’s node filters.
	Count ClusterNodeCount `json:"count"`
	// DiscoveryTypes Contains statistics about the discovery types used by selected nodes.
	DiscoveryTypes map[string]int `json:"discovery_types"`
	// Fs Contains statistics about file stores by selected nodes.
	Fs               ClusterFileSystem       `json:"fs"`
	IndexingPressure ClusterIndexingPressure `json:"indexing_pressure"`
	Ingest           ClusterIngest           `json:"ingest"`
	// Jvm Contains statistics about the Java Virtual Machines (JVMs) used by selected
	// nodes.
	Jvm ClusterJvm `json:"jvm"`
	// NetworkTypes Contains statistics about the transport and HTTP networks used by selected
	// nodes.
	NetworkTypes ClusterNetworkTypes `json:"network_types"`
	// Os Contains statistics about the operating systems used by selected nodes.
	Os ClusterOperatingSystem `json:"os"`
	// PackagingTypes Contains statistics about Elasticsearch distributions installed on selected
	// nodes.
	PackagingTypes []NodePackagingType `json:"packaging_types"`
	// Plugins Contains statistics about installed plugins and modules by selected nodes.
	// If no plugins or modules are installed, this array is empty.
	Plugins []PluginStats `json:"plugins"`
	// Process Contains statistics about processes used by selected nodes.
	Process ClusterProcess `json:"process"`
	// Versions Array of Elasticsearch versions used on selected nodes.
	Versions []string `json:"versions"`
}

ClusterNodes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L369-L402

func NewClusterNodes added in v8.5.0 

func NewClusterNodes() *ClusterNodes

NewClusterNodes returns a ClusterNodes.

type ClusterOperatingSystem 

type ClusterOperatingSystem struct {
	// AllocatedProcessors Number of processors used to calculate thread pool size across all selected
	// nodes.
	// This number can be set with the processors setting of a node and defaults to
	// the number of processors reported by the operating system.
	// In both cases, this number will never be larger than 32.
	AllocatedProcessors int `json:"allocated_processors"`
	// Architectures Contains statistics about processor architectures (for example, x86_64 or
	// aarch64) used by selected nodes.
	Architectures []ClusterOperatingSystemArchitecture `json:"architectures,omitempty"`
	// AvailableProcessors Number of processors available to JVM across all selected nodes.
	AvailableProcessors int `json:"available_processors"`
	// Mem Contains statistics about memory used by selected nodes.
	Mem OperatingSystemMemoryInfo `json:"mem"`
	// Names Contains statistics about operating systems used by selected nodes.
	Names []ClusterOperatingSystemName `json:"names"`
	// PrettyNames Contains statistics about operating systems used by selected nodes.
	PrettyNames []ClusterOperatingSystemPrettyName `json:"pretty_names"`
}

ClusterOperatingSystem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L415-L442

func NewClusterOperatingSystem added in v8.5.0 

func NewClusterOperatingSystem() *ClusterOperatingSystem

NewClusterOperatingSystem returns a ClusterOperatingSystem.

func (*ClusterOperatingSystem) UnmarshalJSON added in v8.7.1 

func (s *ClusterOperatingSystem) UnmarshalJSON(data []byte) error

type ClusterOperatingSystemArchitecture 

type ClusterOperatingSystemArchitecture struct {
	// Arch Name of an architecture used by one or more selected nodes.
	Arch string `json:"arch"`
	// Count Number of selected nodes using the architecture.
	Count int `json:"count"`
}

ClusterOperatingSystemArchitecture type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L404-L413

func NewClusterOperatingSystemArchitecture added in v8.5.0 

func NewClusterOperatingSystemArchitecture() *ClusterOperatingSystemArchitecture

NewClusterOperatingSystemArchitecture returns a ClusterOperatingSystemArchitecture.

func (*ClusterOperatingSystemArchitecture) UnmarshalJSON added in v8.7.1 

func (s *ClusterOperatingSystemArchitecture) UnmarshalJSON(data []byte) error

type ClusterOperatingSystemName 

type ClusterOperatingSystemName struct {
	// Count Number of selected nodes using the operating system.
	Count int `json:"count"`
	// Name Name of an operating system used by one or more selected nodes.
	Name string `json:"name"`
}

ClusterOperatingSystemName type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L444-L453

func NewClusterOperatingSystemName added in v8.5.0 

func NewClusterOperatingSystemName() *ClusterOperatingSystemName

NewClusterOperatingSystemName returns a ClusterOperatingSystemName.

func (*ClusterOperatingSystemName) UnmarshalJSON added in v8.7.1 

func (s *ClusterOperatingSystemName) UnmarshalJSON(data []byte) error

type ClusterOperatingSystemPrettyName 

type ClusterOperatingSystemPrettyName struct {
	// Count Number of selected nodes using the operating system.
	Count int `json:"count"`
	// PrettyName Human-readable name of an operating system used by one or more selected
	// nodes.
	PrettyName string `json:"pretty_name"`
}

ClusterOperatingSystemPrettyName type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L455-L464

func NewClusterOperatingSystemPrettyName added in v8.5.0 

func NewClusterOperatingSystemPrettyName() *ClusterOperatingSystemPrettyName

NewClusterOperatingSystemPrettyName returns a ClusterOperatingSystemPrettyName.

func (*ClusterOperatingSystemPrettyName) UnmarshalJSON added in v8.7.1 

func (s *ClusterOperatingSystemPrettyName) UnmarshalJSON(data []byte) error

type ClusterPressureMemory added in v8.5.0 

type ClusterPressureMemory struct {
	Current      IndexingPressureMemorySummary `json:"current"`
	LimitInBytes int64                         `json:"limit_in_bytes"`
	Total        IndexingPressureMemorySummary `json:"total"`
}

ClusterPressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L574-L578

func NewClusterPressureMemory added in v8.5.0 

func NewClusterPressureMemory() *ClusterPressureMemory

NewClusterPressureMemory returns a ClusterPressureMemory.

func (*ClusterPressureMemory) UnmarshalJSON added in v8.7.1 

func (s *ClusterPressureMemory) UnmarshalJSON(data []byte) error

type ClusterProcess 

type ClusterProcess struct {
	// Cpu Contains statistics about CPU used by selected nodes.
	Cpu ClusterProcessCpu `json:"cpu"`
	// OpenFileDescriptors Contains statistics about open file descriptors in selected nodes.
	OpenFileDescriptors ClusterProcessOpenFileDescriptors `json:"open_file_descriptors"`
}

ClusterProcess type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L466-L475

func NewClusterProcess added in v8.5.0 

func NewClusterProcess() *ClusterProcess

NewClusterProcess returns a ClusterProcess.

type ClusterProcessCpu 

type ClusterProcessCpu struct {
	// Percent Percentage of CPU used across all selected nodes.
	// Returns `-1` if not supported.
	Percent int `json:"percent"`
}

ClusterProcessCpu type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L477-L483

func NewClusterProcessCpu added in v8.5.0 

func NewClusterProcessCpu() *ClusterProcessCpu

NewClusterProcessCpu returns a ClusterProcessCpu.

func (*ClusterProcessCpu) UnmarshalJSON added in v8.7.1 

func (s *ClusterProcessCpu) UnmarshalJSON(data []byte) error

type ClusterProcessOpenFileDescriptors 

type ClusterProcessOpenFileDescriptors struct {
	// Avg Average number of concurrently open file descriptors.
	// Returns `-1` if not supported.
	Avg int64 `json:"avg"`
	// Max Maximum number of concurrently open file descriptors allowed across all
	// selected nodes.
	// Returns `-1` if not supported.
	Max int64 `json:"max"`
	// Min Minimum number of concurrently open file descriptors across all selected
	// nodes.
	// Returns -1 if not supported.
	Min int64 `json:"min"`
}

ClusterProcessOpenFileDescriptors type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L485-L501

func NewClusterProcessOpenFileDescriptors added in v8.5.0 

func NewClusterProcessOpenFileDescriptors() *ClusterProcessOpenFileDescriptors

NewClusterProcessOpenFileDescriptors returns a ClusterProcessOpenFileDescriptors.

func (*ClusterProcessOpenFileDescriptors) UnmarshalJSON added in v8.7.1 

func (s *ClusterProcessOpenFileDescriptors) UnmarshalJSON(data []byte) error

type ClusterProcessor 

type ClusterProcessor struct {
	Count        int64    `json:"count"`
	Current      int64    `json:"current"`
	Failed       int64    `json:"failed"`
	Time         Duration `json:"time,omitempty"`
	TimeInMillis int64    `json:"time_in_millis"`
}

ClusterProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L503-L509

func NewClusterProcessor added in v8.5.0 

func NewClusterProcessor() *ClusterProcessor

NewClusterProcessor returns a ClusterProcessor.

func (*ClusterProcessor) UnmarshalJSON added in v8.7.1 

func (s *ClusterProcessor) UnmarshalJSON(data []byte) error

type ClusterRemoteInfo 

type ClusterRemoteInfo any

ClusterRemoteInfo holds the union for the following types: 

ClusterRemoteSniffInfo
ClusterRemoteProxyInfo

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L29-L30

type ClusterRemoteProxyInfo 

type ClusterRemoteProxyInfo struct {
	// ClusterCredentials This field is present and has a value of `::es_redacted::` only when the
	// remote cluster is configured with the API key based model. Otherwise, the
	// field is not present.
	ClusterCredentials *string `json:"cluster_credentials,omitempty"`
	// Connected If it is `true`, there is at least one open connection to the remote cluster.
	// If it is `false`, it means that the cluster no longer has an open connection
	// to the remote cluster.
	// It does not necessarily mean that the remote cluster is down or unavailable,
	// just that at some point a connection was lost.
	Connected bool `json:"connected"`
	// InitialConnectTimeout The initial connect timeout for remote cluster connections.
	InitialConnectTimeout Duration `json:"initial_connect_timeout"`
	// MaxProxySocketConnections The maximum number of socket connections to the remote cluster when proxy
	// mode is configured.
	MaxProxySocketConnections int `json:"max_proxy_socket_connections"`
	// Mode The connection mode for the remote cluster.
	Mode string `json:"mode,omitempty"`
	// NumProxySocketsConnected The number of open socket connections to the remote cluster when proxy mode
	// is configured.
	NumProxySocketsConnected int `json:"num_proxy_sockets_connected"`
	// ProxyAddress The address for remote connections when proxy mode is configured.
	ProxyAddress string `json:"proxy_address"`
	ServerName   string `json:"server_name"`
	// SkipUnavailable If `true`, cross-cluster search skips the remote cluster when its nodes are
	// unavailable during the search and ignores errors returned by the remote
	// cluster.
	SkipUnavailable bool `json:"skip_unavailable"`
}

ClusterRemoteProxyInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L58-L83

func NewClusterRemoteProxyInfo added in v8.5.0 

func NewClusterRemoteProxyInfo() *ClusterRemoteProxyInfo

NewClusterRemoteProxyInfo returns a ClusterRemoteProxyInfo.

func (ClusterRemoteProxyInfo) MarshalJSON added in v8.9.0 

func (s ClusterRemoteProxyInfo) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ClusterRemoteProxyInfo) UnmarshalJSON added in v8.7.1 

func (s *ClusterRemoteProxyInfo) UnmarshalJSON(data []byte) error

type ClusterRemoteSniffInfo 

type ClusterRemoteSniffInfo struct {
	// Connected If it is `true`, there is at least one open connection to the remote cluster.
	// If it is `false`, it means that the cluster no longer has an open connection
	// to the remote cluster.
	// It does not necessarily mean that the remote cluster is down or unavailable,
	// just that at some point a connection was lost.
	Connected bool `json:"connected"`
	// InitialConnectTimeout The initial connect timeout for remote cluster connections.
	InitialConnectTimeout Duration `json:"initial_connect_timeout"`
	// MaxConnectionsPerCluster The maximum number of connections maintained for the remote cluster when
	// sniff mode is configured.
	MaxConnectionsPerCluster int `json:"max_connections_per_cluster"`
	// Mode The connection mode for the remote cluster.
	Mode string `json:"mode,omitempty"`
	// NumNodesConnected The number of connected nodes in the remote cluster when sniff mode is
	// configured.
	NumNodesConnected int64 `json:"num_nodes_connected"`
	// Seeds The initial seed transport addresses of the remote cluster when sniff mode is
	// configured.
	Seeds []string `json:"seeds"`
	// SkipUnavailable If `true`, cross-cluster search skips the remote cluster when its nodes are
	// unavailable during the search and ignores errors returned by the remote
	// cluster.
	SkipUnavailable bool `json:"skip_unavailable"`
}

ClusterRemoteSniffInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L32-L56

func NewClusterRemoteSniffInfo added in v8.5.0 

func NewClusterRemoteSniffInfo() *ClusterRemoteSniffInfo

NewClusterRemoteSniffInfo returns a ClusterRemoteSniffInfo.

func (ClusterRemoteSniffInfo) MarshalJSON added in v8.9.0 

func (s ClusterRemoteSniffInfo) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ClusterRemoteSniffInfo) UnmarshalJSON added in v8.7.1 

func (s *ClusterRemoteSniffInfo) UnmarshalJSON(data []byte) error

type ClusterRuntimeFieldTypes added in v8.5.0 

type ClusterRuntimeFieldTypes struct {
	// CharsMax Maximum number of characters for a single runtime field script.
	CharsMax int `json:"chars_max"`
	// CharsTotal Total number of characters for the scripts that define the current runtime
	// field data type.
	CharsTotal int `json:"chars_total"`
	// Count Number of runtime fields mapped to the field data type in selected nodes.
	Count int `json:"count"`
	// DocMax Maximum number of accesses to doc_values for a single runtime field script
	DocMax int `json:"doc_max"`
	// DocTotal Total number of accesses to doc_values for the scripts that define the
	// current runtime field data type.
	DocTotal int `json:"doc_total"`
	// IndexCount Number of indices containing a mapping of the runtime field data type in
	// selected nodes.
	IndexCount int `json:"index_count"`
	// Lang Script languages used for the runtime fields scripts.
	Lang []string `json:"lang"`
	// LinesMax Maximum number of lines for a single runtime field script.
	LinesMax int `json:"lines_max"`
	// LinesTotal Total number of lines for the scripts that define the current runtime field
	// data type.
	LinesTotal int `json:"lines_total"`
	// Name Field data type used in selected nodes.
	Name string `json:"name"`
	// ScriptlessCount Number of runtime fields that don’t declare a script.
	ScriptlessCount int `json:"scriptless_count"`
	// ShadowedCount Number of runtime fields that shadow an indexed field.
	ShadowedCount int `json:"shadowed_count"`
	// SourceMax Maximum number of accesses to _source for a single runtime field script.
	SourceMax int `json:"source_max"`
	// SourceTotal Total number of accesses to _source for the scripts that define the current
	// runtime field data type.
	SourceTotal int `json:"source_total"`
}

ClusterRuntimeFieldTypes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L169-L226

func NewClusterRuntimeFieldTypes added in v8.5.0 

func NewClusterRuntimeFieldTypes() *ClusterRuntimeFieldTypes

NewClusterRuntimeFieldTypes returns a ClusterRuntimeFieldTypes.

func (*ClusterRuntimeFieldTypes) UnmarshalJSON added in v8.7.1 

func (s *ClusterRuntimeFieldTypes) UnmarshalJSON(data []byte) error

type ClusterShardMetrics 

type ClusterShardMetrics struct {
	// Avg Mean number of shards in an index, counting only shards assigned to selected
	// nodes.
	Avg Float64 `json:"avg"`
	// Max Maximum number of shards in an index, counting only shards assigned to
	// selected nodes.
	Max Float64 `json:"max"`
	// Min Minimum number of shards in an index, counting only shards assigned to
	// selected nodes.
	Min Float64 `json:"min"`
}

ClusterShardMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L511-L524

func NewClusterShardMetrics added in v8.5.0 

func NewClusterShardMetrics() *ClusterShardMetrics

NewClusterShardMetrics returns a ClusterShardMetrics.

func (*ClusterShardMetrics) UnmarshalJSON added in v8.7.1 

func (s *ClusterShardMetrics) UnmarshalJSON(data []byte) error

type ClusterStateQueue 

type ClusterStateQueue struct {
	// Committed Number of committed cluster states in queue.
	Committed *int64 `json:"committed,omitempty"`
	// Pending Number of pending cluster states in queue.
	Pending *int64 `json:"pending,omitempty"`
	// Total Total number of cluster states in queue.
	Total *int64 `json:"total,omitempty"`
}

ClusterStateQueue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L248-L261

func NewClusterStateQueue added in v8.5.0 

func NewClusterStateQueue() *ClusterStateQueue

NewClusterStateQueue returns a ClusterStateQueue.

func (*ClusterStateQueue) UnmarshalJSON added in v8.7.1 

func (s *ClusterStateQueue) UnmarshalJSON(data []byte) error

type ClusterStateUpdate 

type ClusterStateUpdate struct {
	// CommitTime The cumulative amount of time spent waiting for a successful cluster state
	// update to commit, which measures the time from the start of each publication
	// until a majority of the master-eligible nodes have written the state to disk
	// and confirmed the write to the elected master.
	CommitTime Duration `json:"commit_time,omitempty"`
	// CommitTimeMillis The cumulative amount of time, in milliseconds, spent waiting for a
	// successful cluster state update to commit, which measures the time from the
	// start of each publication until a majority of the master-eligible nodes have
	// written the state to disk and confirmed the write to the elected master.
	CommitTimeMillis *int64 `json:"commit_time_millis,omitempty"`
	// CompletionTime The cumulative amount of time spent waiting for a successful cluster state
	// update to complete, which measures the time from the start of each
	// publication until all the other nodes have notified the elected master that
	// they have applied the cluster state.
	CompletionTime Duration `json:"completion_time,omitempty"`
	// CompletionTimeMillis The cumulative amount of time, in milliseconds,  spent waiting for a
	// successful cluster state update to complete, which measures the time from the
	// start of each publication until all the other nodes have notified the elected
	// master that they have applied the cluster state.
	CompletionTimeMillis *int64 `json:"completion_time_millis,omitempty"`
	// ComputationTime The cumulative amount of time spent computing no-op cluster state updates
	// since the node started.
	ComputationTime Duration `json:"computation_time,omitempty"`
	// ComputationTimeMillis The cumulative amount of time, in milliseconds, spent computing no-op cluster
	// state updates since the node started.
	ComputationTimeMillis *int64 `json:"computation_time_millis,omitempty"`
	// ContextConstructionTime The cumulative amount of time spent constructing a publication context since
	// the node started for publications that ultimately succeeded.
	// This statistic includes the time spent computing the difference between the
	// current and new cluster state preparing a serialized representation of this
	// difference.
	ContextConstructionTime Duration `json:"context_construction_time,omitempty"`
	// ContextConstructionTimeMillis The cumulative amount of time, in milliseconds, spent constructing a
	// publication context since the node started for publications that ultimately
	// succeeded.
	// This statistic includes the time spent computing the difference between the
	// current and new cluster state preparing a serialized representation of this
	// difference.
	ContextConstructionTimeMillis *int64 `json:"context_construction_time_millis,omitempty"`
	// Count The number of cluster state update attempts that did not change the cluster
	// state since the node started.
	Count int64 `json:"count"`
	// MasterApplyTime The cumulative amount of time spent successfully applying cluster state
	// updates on the elected master since the node started.
	MasterApplyTime Duration `json:"master_apply_time,omitempty"`
	// MasterApplyTimeMillis The cumulative amount of time, in milliseconds, spent successfully applying
	// cluster state updates on the elected master since the node started.
	MasterApplyTimeMillis *int64 `json:"master_apply_time_millis,omitempty"`
	// NotificationTime The cumulative amount of time spent notifying listeners of a no-op cluster
	// state update since the node started.
	NotificationTime Duration `json:"notification_time,omitempty"`
	// NotificationTimeMillis The cumulative amount of time, in milliseconds, spent notifying listeners of
	// a no-op cluster state update since the node started.
	NotificationTimeMillis *int64 `json:"notification_time_millis,omitempty"`
	// PublicationTime The cumulative amount of time spent publishing cluster state updates which
	// ultimately succeeded, which includes everything from the start of the
	// publication (just after the computation of the new cluster state) until the
	// publication has finished and the master node is ready to start processing the
	// next state update.
	// This includes the time measured by `context_construction_time`,
	// `commit_time`, `completion_time` and `master_apply_time`.
	PublicationTime Duration `json:"publication_time,omitempty"`
	// PublicationTimeMillis The cumulative amount of time, in milliseconds, spent publishing cluster
	// state updates which ultimately succeeded, which includes everything from the
	// start of the publication (just after the computation of the new cluster
	// state) until the publication has finished and the master node is ready to
	// start processing the next state update.
	// This includes the time measured by `context_construction_time`,
	// `commit_time`, `completion_time` and `master_apply_time`.
	PublicationTimeMillis *int64 `json:"publication_time_millis,omitempty"`
}

ClusterStateUpdate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L278-L343

func NewClusterStateUpdate added in v8.5.0 

func NewClusterStateUpdate() *ClusterStateUpdate

NewClusterStateUpdate returns a ClusterStateUpdate.

func (*ClusterStateUpdate) UnmarshalJSON added in v8.7.1 

func (s *ClusterStateUpdate) UnmarshalJSON(data []byte) error

type ClusterStatistics 

type ClusterStatistics struct {
	Details    map[string]ClusterDetails `json:"details,omitempty"`
	Failed     int                       `json:"failed"`
	Partial    int                       `json:"partial"`
	Running    int                       `json:"running"`
	Skipped    int                       `json:"skipped"`
	Successful int                       `json:"successful"`
	Total      int                       `json:"total"`
}

ClusterStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L27-L35

func NewClusterStatistics added in v8.5.0 

func NewClusterStatistics() *ClusterStatistics

NewClusterStatistics returns a ClusterStatistics.

func (*ClusterStatistics) UnmarshalJSON added in v8.7.1 

func (s *ClusterStatistics) UnmarshalJSON(data []byte) error

type CohereServiceSettings added in v8.18.0 

type CohereServiceSettings struct {
	// ApiKey A valid API key for your Cohere account.
	// You can find or create your Cohere API keys on the Cohere API key settings
	// page.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// EmbeddingType For a `text_embedding` task, the types of embeddings you want to get back.
	// Use `byte` for signed int8 embeddings (this is a synonym of `int8`).
	// Use `float` for the default float embeddings.
	// Use `int8` for signed int8 embeddings.
	EmbeddingType *cohereembeddingtype.CohereEmbeddingType `json:"embedding_type,omitempty"`
	// ModelId For a `completion`, `rerank`, or `text_embedding` task, the name of the model
	// to use for the inference task.
	//
	// * For the available `completion` models, refer to the [Cohere command
	// docs](https://docs.cohere.com/docs/models#command).
	// * For the available `rerank` models, refer to the [Cohere rerank
	// docs](https://docs.cohere.com/reference/rerank-1).
	// * For the available `text_embedding` models, refer to [Cohere embed
	// docs](https://docs.cohere.com/reference/embed).
	//
	// The default value for a text embedding task is `embed-english-v2.0`.
	ModelId *string `json:"model_id,omitempty"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Cohere.
	// By default, the `cohere` service sets the number of requests allowed per
	// minute to 10000.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Similarity The similarity measure.
	// If the `embedding_type` is `float`, the default value is `dot_product`.
	// If the `embedding_type` is `int8` or `byte`, the default value is `cosine`.
	Similarity *coheresimilaritytype.CohereSimilarityType `json:"similarity,omitempty"`
}

CohereServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L645-L686

func NewCohereServiceSettings added in v8.18.0 

func NewCohereServiceSettings() *CohereServiceSettings

NewCohereServiceSettings returns a CohereServiceSettings.

func (*CohereServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *CohereServiceSettings) UnmarshalJSON(data []byte) error

type CohereTaskSettings added in v8.18.0 

type CohereTaskSettings struct {
	// InputType For a `text_embedding` task, the type of input passed to the model.
	// Valid values are:
	//
	// * `classification`: Use it for embeddings passed through a text classifier.
	// * `clustering`: Use it for the embeddings run through a clustering algorithm.
	// * `ingest`: Use it for storing document embeddings in a vector database.
	// * `search`: Use it for storing embeddings of search queries run against a
	// vector database to find relevant documents.
	//
	// IMPORTANT: The `input_type` field is required when using embedding models
	// `v3` and higher.
	InputType *cohereinputtype.CohereInputType `json:"input_type,omitempty"`
	// ReturnDocuments For a `rerank` task, return doc text within the results.
	ReturnDocuments *bool `json:"return_documents,omitempty"`
	// TopN For a `rerank` task, the number of most relevant documents to return.
	// It defaults to the number of the documents.
	// If this inference endpoint is used in a `text_similarity_reranker` retriever
	// query and `top_n` is set, it must be greater than or equal to
	// `rank_window_size` in the query.
	TopN *int `json:"top_n,omitempty"`
	// Truncate For a `text_embedding` task, the method to handle inputs longer than the
	// maximum token length.
	// Valid values are:
	//
	// * `END`: When the input exceeds the maximum input token length, the end of
	// the input is discarded.
	// * `NONE`: When the input exceeds the maximum input token length, an error is
	// returned.
	// * `START`: When the input exceeds the maximum input token length, the start
	// of the input is discarded.
	Truncate *coheretruncatetype.CohereTruncateType `json:"truncate,omitempty"`
}

CohereTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L723-L755

func NewCohereTaskSettings added in v8.18.0 

func NewCohereTaskSettings() *CohereTaskSettings

NewCohereTaskSettings returns a CohereTaskSettings.

func (*CohereTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *CohereTaskSettings) UnmarshalJSON(data []byte) error

type Collector 

type Collector struct {
	Children    []Collector `json:"children,omitempty"`
	Name        string      `json:"name"`
	Reason      string      `json:"reason"`
	TimeInNanos int64       `json:"time_in_nanos"`
}

Collector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L94-L99

func NewCollector added in v8.5.0 

func NewCollector() *Collector

NewCollector returns a Collector.

func (*Collector) UnmarshalJSON added in v8.7.1 

func (s *Collector) UnmarshalJSON(data []byte) error

type Column 

type Column struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

Column type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/sql/types.ts#L23-L26

func NewColumn added in v8.5.0 

func NewColumn() *Column

NewColumn returns a Column.

func (*Column) UnmarshalJSON added in v8.7.1 

func (s *Column) UnmarshalJSON(data []byte) error

type CombinedFieldsQuery 

type CombinedFieldsQuery struct {
	// AutoGenerateSynonymsPhraseQuery If true, match phrase queries are automatically created for multi-term
	// synonyms.
	AutoGenerateSynonymsPhraseQuery *bool `json:"auto_generate_synonyms_phrase_query,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Fields List of fields to search. Field wildcard patterns are allowed. Only `text`
	// fields are supported, and they must all have the same search `analyzer`.
	Fields []string `json:"fields"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Operator Boolean logic used to interpret text in the query value.
	Operator *combinedfieldsoperator.CombinedFieldsOperator `json:"operator,omitempty"`
	// Query Text to search for in the provided `fields`.
	// The `combined_fields` query analyzes the provided text before performing a
	// search.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// ZeroTermsQuery Indicates whether no documents are returned if the analyzer removes all
	// tokens, such as when using a `stop` filter.
	ZeroTermsQuery *combinedfieldszeroterms.CombinedFieldsZeroTerms `json:"zero_terms_query,omitempty"`
}

CombinedFieldsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/abstractions.ts#L472-L506

func NewCombinedFieldsQuery added in v8.5.0 

func NewCombinedFieldsQuery() *CombinedFieldsQuery

NewCombinedFieldsQuery returns a CombinedFieldsQuery.

func (*CombinedFieldsQuery) UnmarshalJSON added in v8.7.1 

func (s *CombinedFieldsQuery) UnmarshalJSON(data []byte) error

type Command 

type Command struct {
	// AllocateEmptyPrimary Allocate an empty primary shard to a node. Accepts the index and shard for
	// index name and shard number, and node to allocate the shard to. Using this
	// command leads to a complete loss of all data that was indexed into this
	// shard, if it was previously started. If a node which has a copy of the data
	// rejoins the cluster later on, that data will be deleted. To ensure that these
	// implications are well-understood, this command requires the flag
	// accept_data_loss to be explicitly set to true.
	AllocateEmptyPrimary *CommandAllocatePrimaryAction `json:"allocate_empty_primary,omitempty"`
	// AllocateReplica Allocate an unassigned replica shard to a node. Accepts index and shard for
	// index name and shard number, and node to allocate the shard to. Takes
	// allocation deciders into account.
	AllocateReplica *CommandAllocateReplicaAction `json:"allocate_replica,omitempty"`
	// AllocateStalePrimary Allocate a primary shard to a node that holds a stale copy. Accepts the index
	// and shard for index name and shard number, and node to allocate the shard to.
	// Using this command may lead to data loss for the provided shard id. If a node
	// which has the good copy of the data rejoins the cluster later on, that data
	// will be deleted or overwritten with the data of the stale copy that was
	// forcefully allocated with this command. To ensure that these implications are
	// well-understood, this command requires the flag accept_data_loss to be
	// explicitly set to true.
	AllocateStalePrimary *CommandAllocatePrimaryAction `json:"allocate_stale_primary,omitempty"`
	// Cancel Cancel allocation of a shard (or recovery). Accepts index and shard for index
	// name and shard number, and node for the node to cancel the shard allocation
	// on. This can be used to force resynchronization of existing replicas from the
	// primary shard by cancelling them and allowing them to be reinitialized
	// through the standard recovery process. By default only replica shard
	// allocations can be cancelled. If it is necessary to cancel the allocation of
	// a primary shard then the allow_primary flag must also be included in the
	// request.
	Cancel *CommandCancelAction `json:"cancel,omitempty"`
	// Move Move a started shard from one node to another node. Accepts index and shard
	// for index name and shard number, from_node for the node to move the shard
	// from, and to_node for the node to move the shard to.
	Move *CommandMoveAction `json:"move,omitempty"`
}

Command type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L22-L43

func NewCommand added in v8.5.0 

func NewCommand() *Command

NewCommand returns a Command.

type CommandAllocatePrimaryAction 

type CommandAllocatePrimaryAction struct {
	// AcceptDataLoss If a node which has a copy of the data rejoins the cluster later on, that
	// data will be deleted. To ensure that these implications are well-understood,
	// this command requires the flag accept_data_loss to be explicitly set to true
	AcceptDataLoss bool   `json:"accept_data_loss"`
	Index          string `json:"index"`
	Node           string `json:"node"`
	Shard          int    `json:"shard"`
}

CommandAllocatePrimaryAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L78-L84

func NewCommandAllocatePrimaryAction added in v8.5.0 

func NewCommandAllocatePrimaryAction() *CommandAllocatePrimaryAction

NewCommandAllocatePrimaryAction returns a CommandAllocatePrimaryAction.

func (*CommandAllocatePrimaryAction) UnmarshalJSON added in v8.7.1 

func (s *CommandAllocatePrimaryAction) UnmarshalJSON(data []byte) error

type CommandAllocateReplicaAction 

type CommandAllocateReplicaAction struct {
	Index string `json:"index"`
	Node  string `json:"node"`
	Shard int    `json:"shard"`
}

CommandAllocateReplicaAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L69-L76

func NewCommandAllocateReplicaAction added in v8.5.0 

func NewCommandAllocateReplicaAction() *CommandAllocateReplicaAction

NewCommandAllocateReplicaAction returns a CommandAllocateReplicaAction.

func (*CommandAllocateReplicaAction) UnmarshalJSON added in v8.7.1 

func (s *CommandAllocateReplicaAction) UnmarshalJSON(data []byte) error

type CommandCancelAction 

type CommandCancelAction struct {
	AllowPrimary *bool  `json:"allow_primary,omitempty"`
	Index        string `json:"index"`
	Node         string `json:"node"`
	Shard        int    `json:"shard"`
}

CommandCancelAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L45-L50

func NewCommandCancelAction added in v8.5.0 

func NewCommandCancelAction() *CommandCancelAction

NewCommandCancelAction returns a CommandCancelAction.

func (*CommandCancelAction) UnmarshalJSON added in v8.7.1 

func (s *CommandCancelAction) UnmarshalJSON(data []byte) error

type CommandMoveAction 

type CommandMoveAction struct {
	// FromNode The node to move the shard from
	FromNode string `json:"from_node"`
	Index    string `json:"index"`
	Shard    int    `json:"shard"`
	// ToNode The node to move the shard to
	ToNode string `json:"to_node"`
}

CommandMoveAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L60-L67

func NewCommandMoveAction added in v8.5.0 

func NewCommandMoveAction() *CommandMoveAction

NewCommandMoveAction returns a CommandMoveAction.

func (*CommandMoveAction) UnmarshalJSON added in v8.7.1 

func (s *CommandMoveAction) UnmarshalJSON(data []byte) error

type CommonCatQueryParameters added in v8.14.0 

type CommonCatQueryParameters struct {
	// Format Specifies the format to return the columnar data in, can be set to
	// `text`, `json`, `cbor`, `yaml`, or `smile`.
	Format *string `json:"format,omitempty"`
	// Help When set to `true` will output available columns. This option
	// can't be combined with any other query string option.
	Help *bool `json:"help,omitempty"`
	// V When set to `true` will enable verbose output.
	V *bool `json:"v,omitempty"`
}

CommonCatQueryParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/behaviors.ts#L77-L100

func NewCommonCatQueryParameters added in v8.14.0 

func NewCommonCatQueryParameters() *CommonCatQueryParameters

NewCommonCatQueryParameters returns a CommonCatQueryParameters.

func (*CommonCatQueryParameters) UnmarshalJSON added in v8.14.0 

func (s *CommonCatQueryParameters) UnmarshalJSON(data []byte) error

type CommonGramsTokenFilter 

type CommonGramsTokenFilter struct {
	// CommonWords A list of tokens. The filter generates bigrams for these tokens.
	// Either this or the `common_words_path` parameter is required.
	CommonWords []string `json:"common_words,omitempty"`
	// CommonWordsPath Path to a file containing a list of tokens. The filter generates bigrams for
	// these tokens.
	// This path must be absolute or relative to the `config` location. The file
	// must be UTF-8 encoded. Each token in the file must be separated by a line
	// break.
	// Either this or the `common_words` parameter is required.
	CommonWordsPath *string `json:"common_words_path,omitempty"`
	// IgnoreCase If `true`, matches for common words matching are case-insensitive. Defaults
	// to `false`.
	IgnoreCase *bool `json:"ignore_case,omitempty"`
	// QueryMode If `true`, the filter excludes the following tokens from the output:
	// - Unigrams for common words
	// - Unigrams for terms followed by common words
	// Defaults to `false`. We recommend enabling this parameter for search
	// analyzers.
	QueryMode *bool   `json:"query_mode,omitempty"`
	Type      string  `json:"type,omitempty"`
	Version   *string `json:"version,omitempty"`
}

CommonGramsTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L219-L235

func NewCommonGramsTokenFilter added in v8.5.0 

func NewCommonGramsTokenFilter() *CommonGramsTokenFilter

NewCommonGramsTokenFilter returns a CommonGramsTokenFilter.

func (CommonGramsTokenFilter) MarshalJSON added in v8.9.0 

func (s CommonGramsTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CommonGramsTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *CommonGramsTokenFilter) UnmarshalJSON(data []byte) error

type CommonQueryParameters added in v8.14.0 

type CommonQueryParameters struct {
	// ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors
	// when they occur.
	ErrorTrace *bool `json:"error_trace,omitempty"`
	// FilterPath Comma-separated list of filters in dot notation which reduce the response
	// returned by Elasticsearch.
	FilterPath []string `json:"filter_path,omitempty"`
	// Human When set to `true` will return statistics in a format suitable for humans.
	// For example `"exists_time": "1h"` for humans and
	// `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
	// readable values will be omitted. This makes sense for responses being
	// consumed
	// only by machines.
	Human *bool `json:"human,omitempty"`
	// Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
	// this option for debugging only.
	Pretty *bool `json:"pretty,omitempty"`
}

CommonQueryParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/behaviors.ts#L41-L75

func NewCommonQueryParameters added in v8.14.0 

func NewCommonQueryParameters() *CommonQueryParameters

NewCommonQueryParameters returns a CommonQueryParameters.

func (*CommonQueryParameters) UnmarshalJSON added in v8.14.0 

func (s *CommonQueryParameters) UnmarshalJSON(data []byte) error

type CommonTermsQuery 

type CommonTermsQuery struct {
	Analyzer *string `json:"analyzer,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost              *float32           `json:"boost,omitempty"`
	CutoffFrequency    *Float64           `json:"cutoff_frequency,omitempty"`
	HighFreqOperator   *operator.Operator `json:"high_freq_operator,omitempty"`
	LowFreqOperator    *operator.Operator `json:"low_freq_operator,omitempty"`
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	Query              string             `json:"query"`
	QueryName_         *string            `json:"_name,omitempty"`
}

CommonTermsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L34-L44

func NewCommonTermsQuery added in v8.5.0 

func NewCommonTermsQuery() *CommonTermsQuery

NewCommonTermsQuery returns a CommonTermsQuery.

func (*CommonTermsQuery) UnmarshalJSON added in v8.7.1 

func (s *CommonTermsQuery) UnmarshalJSON(data []byte) error

type CommonTokenizationConfig added in v8.17.0 

type CommonTokenizationConfig struct {
	// DoLowerCase Should the tokenizer lower case the text
	DoLowerCase *bool `json:"do_lower_case,omitempty"`
	// MaxSequenceLength Maximum input sequence length for the model
	MaxSequenceLength *int `json:"max_sequence_length,omitempty"`
	// Span Tokenization spanning options. Special value of -1 indicates no spanning
	// takes place
	Span *int `json:"span,omitempty"`
	// Truncate Should tokenization input be automatically truncated before sending to the
	// model for inference
	Truncate *tokenizationtruncate.TokenizationTruncate `json:"truncate,omitempty"`
	// WithSpecialTokens Is tokenization completed with special tokens
	WithSpecialTokens *bool `json:"with_special_tokens,omitempty"`
}

CommonTokenizationConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L160-L186

func NewCommonTokenizationConfig added in v8.17.0 

func NewCommonTokenizationConfig() *CommonTokenizationConfig

NewCommonTokenizationConfig returns a CommonTokenizationConfig.

func (*CommonTokenizationConfig) UnmarshalJSON added in v8.17.0 

func (s *CommonTokenizationConfig) UnmarshalJSON(data []byte) error

type CommunityIDProcessor added in v8.16.0 

type CommunityIDProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// DestinationIp Field containing the destination IP address.
	DestinationIp *string `json:"destination_ip,omitempty"`
	// DestinationPort Field containing the destination port.
	DestinationPort *string `json:"destination_port,omitempty"`
	// IanaNumber Field containing the IANA number.
	IanaNumber *string `json:"iana_number,omitempty"`
	// IcmpCode Field containing the ICMP code.
	IcmpCode *string `json:"icmp_code,omitempty"`
	// IcmpType Field containing the ICMP type.
	IcmpType *string `json:"icmp_type,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If true and any required fields are missing, the processor quietly exits
	// without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Seed Seed for the community ID hash. Must be between 0 and 65535 (inclusive). The
	// seed can prevent hash collisions between network domains, such as a staging
	// and production network that use the same addressing scheme.
	Seed *int `json:"seed,omitempty"`
	// SourceIp Field containing the source IP address.
	SourceIp *string `json:"source_ip,omitempty"`
	// SourcePort Field containing the source port.
	SourcePort *string `json:"source_port,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Output field for the community ID.
	TargetField *string `json:"target_field,omitempty"`
	// Transport Field containing the transport protocol name or number. Used only when the
	// iana_number field is not present. The following protocol names are currently
	// supported: eigrp, gre, icmp, icmpv6, igmp, ipv6-icmp, ospf, pim, sctp, tcp,
	// udp
	Transport *string `json:"transport,omitempty"`
}

CommunityIDProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L598-L659

func NewCommunityIDProcessor added in v8.16.0 

func NewCommunityIDProcessor() *CommunityIDProcessor

NewCommunityIDProcessor returns a CommunityIDProcessor.

func (*CommunityIDProcessor) UnmarshalJSON added in v8.16.0 

func (s *CommunityIDProcessor) UnmarshalJSON(data []byte) error

type CompactNodeInfo 

type CompactNodeInfo struct {
	Name string `json:"name"`
}

CompactNodeInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/verify_repository/SnapshotVerifyRepositoryResponse.ts#L27-L29

func NewCompactNodeInfo added in v8.5.0 

func NewCompactNodeInfo() *CompactNodeInfo

NewCompactNodeInfo returns a CompactNodeInfo.

func (*CompactNodeInfo) UnmarshalJSON added in v8.7.1 

func (s *CompactNodeInfo) UnmarshalJSON(data []byte) error

type CompletionContext 

type CompletionContext struct {
	// Boost The factor by which the score of the suggestion should be boosted.
	// The score is computed by multiplying the boost with the suggestion weight.
	Boost *Float64 `json:"boost,omitempty"`
	// Context The value of the category to filter/boost on.
	Context Context `json:"context"`
	// Neighbours An array of precision values at which neighboring geohashes should be taken
	// into account.
	// Precision value can be a distance value (`5m`, `10km`, etc.) or a raw geohash
	// precision (`1`..`12`).
	// Defaults to generating neighbors for index time precision level.
	Neighbours []GeoHashPrecision `json:"neighbours,omitempty"`
	// Precision The precision of the geohash to encode the query geo point.
	// Can be specified as a distance value (`5m`, `10km`, etc.), or as a raw
	// geohash precision (`1`..`12`).
	// Defaults to index time precision level.
	Precision GeoHashPrecision `json:"precision,omitempty"`
	// Prefix Whether the category value should be treated as a prefix or not.
	Prefix *bool `json:"prefix,omitempty"`
}

CompletionContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L235-L264

func NewCompletionContext added in v8.5.0 

func NewCompletionContext() *CompletionContext

NewCompletionContext returns a CompletionContext.

func (*CompletionContext) UnmarshalJSON added in v8.7.0 

func (s *CompletionContext) UnmarshalJSON(data []byte) error

type CompletionInferenceResult added in v8.18.1 

type CompletionInferenceResult struct {
	Completion []CompletionResult `json:"completion"`
}

CompletionInferenceResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L83-L88

func NewCompletionInferenceResult added in v8.18.1 

func NewCompletionInferenceResult() *CompletionInferenceResult

NewCompletionInferenceResult returns a CompletionInferenceResult.

type CompletionProperty 

type CompletionProperty struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	Contexts       []SuggestContext               `json:"contexts,omitempty"`
	CopyTo         []string                       `json:"copy_to,omitempty"`
	DocValues      *bool                          `json:"doc_values,omitempty"`
	Dynamic        *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields         map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove    *int                           `json:"ignore_above,omitempty"`
	MaxInputLength *int                           `json:"max_input_length,omitempty"`
	// Meta Metadata about the field.
	Meta                       map[string]string                                `json:"meta,omitempty"`
	PreservePositionIncrements *bool                                            `json:"preserve_position_increments,omitempty"`
	PreserveSeparators         *bool                                            `json:"preserve_separators,omitempty"`
	Properties                 map[string]Property                              `json:"properties,omitempty"`
	SearchAnalyzer             *string                                          `json:"search_analyzer,omitempty"`
	Store                      *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep        *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                       string                                           `json:"type,omitempty"`
}

CompletionProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L33-L41

func NewCompletionProperty added in v8.5.0 

func NewCompletionProperty() *CompletionProperty

NewCompletionProperty returns a CompletionProperty.

func (CompletionProperty) MarshalJSON added in v8.9.0 

func (s CompletionProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CompletionProperty) UnmarshalJSON added in v8.7.0 

func (s *CompletionProperty) UnmarshalJSON(data []byte) error

type CompletionResult added in v8.14.0 

type CompletionResult struct {
	Result string `json:"result"`
}

CompletionResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L76-L81

func NewCompletionResult added in v8.14.0 

func NewCompletionResult() *CompletionResult

NewCompletionResult returns a CompletionResult.

func (*CompletionResult) UnmarshalJSON added in v8.14.0 

func (s *CompletionResult) UnmarshalJSON(data []byte) error

type CompletionStats 

type CompletionStats struct {
	Fields map[string]FieldSizeUsage `json:"fields,omitempty"`
	// Size Total amount of memory used for completion across all shards assigned to
	// selected nodes.
	Size ByteSize `json:"size,omitempty"`
	// SizeInBytes Total amount, in bytes, of memory used for completion across all shards
	// assigned to selected nodes.
	SizeInBytes int64 `json:"size_in_bytes"`
}

CompletionStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L83-L93

func NewCompletionStats added in v8.5.0 

func NewCompletionStats() *CompletionStats

NewCompletionStats returns a CompletionStats.

func (*CompletionStats) UnmarshalJSON added in v8.7.1 

func (s *CompletionStats) UnmarshalJSON(data []byte) error

type CompletionSuggest 

type CompletionSuggest struct {
	Length  int                       `json:"length"`
	Offset  int                       `json:"offset"`
	Options []CompletionSuggestOption `json:"options"`
	Text    string                    `json:"text"`
}

CompletionSuggest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L48-L55

func NewCompletionSuggest added in v8.5.0 

func NewCompletionSuggest() *CompletionSuggest

NewCompletionSuggest returns a CompletionSuggest.

func (*CompletionSuggest) UnmarshalJSON added in v8.7.1 

func (s *CompletionSuggest) UnmarshalJSON(data []byte) error

type CompletionSuggestOption 

type CompletionSuggestOption struct {
	CollateMatch *bool                      `json:"collate_match,omitempty"`
	Contexts     map[string][]Context       `json:"contexts,omitempty"`
	Fields       map[string]json.RawMessage `json:"fields,omitempty"`
	Id_          *string                    `json:"_id,omitempty"`
	Index_       *string                    `json:"_index,omitempty"`
	Routing_     *string                    `json:"_routing,omitempty"`
	Score        *Float64                   `json:"score,omitempty"`
	Score_       *Float64                   `json:"_score,omitempty"`
	Source_      json.RawMessage            `json:"_source,omitempty"`
	Text         string                     `json:"text"`
}

CompletionSuggestOption type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L73-L84

func NewCompletionSuggestOption added in v8.5.0 

func NewCompletionSuggestOption() *CompletionSuggestOption

NewCompletionSuggestOption returns a CompletionSuggestOption.

func (*CompletionSuggestOption) UnmarshalJSON added in v8.7.1 

func (s *CompletionSuggestOption) UnmarshalJSON(data []byte) error

type CompletionSuggester 

type CompletionSuggester struct {
	// Analyzer The analyzer to analyze the suggest text with.
	// Defaults to the search analyzer of the suggest field.
	Analyzer *string `json:"analyzer,omitempty"`
	// Contexts A value, geo point object, or a geo hash string to filter or boost the
	// suggestion on.
	Contexts map[string][]CompletionContext `json:"contexts,omitempty"`
	// Field The field to fetch the candidate suggestions from.
	// Needs to be set globally or per suggestion.
	Field string `json:"field"`
	// Fuzzy Enables fuzziness, meaning you can have a typo in your search and still get
	// results back.
	Fuzzy *SuggestFuzziness `json:"fuzzy,omitempty"`
	// Regex A regex query that expresses a prefix as a regular expression.
	Regex *RegexOptions `json:"regex,omitempty"`
	// Size The maximum corrections to be returned per suggest text token.
	Size *int `json:"size,omitempty"`
	// SkipDuplicates Whether duplicate suggestions should be filtered out.
	SkipDuplicates *bool `json:"skip_duplicates,omitempty"`
}

CompletionSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L163-L181

func NewCompletionSuggester added in v8.5.0 

func NewCompletionSuggester() *CompletionSuggester

NewCompletionSuggester returns a CompletionSuggester.

func (*CompletionSuggester) UnmarshalJSON added in v8.7.1 

func (s *CompletionSuggester) UnmarshalJSON(data []byte) error

type CompletionTool added in v8.18.0 

type CompletionTool struct {
	// Function The function definition.
	Function CompletionToolFunction `json:"function"`
	// Type The type of tool.
	Type string `json:"type"`
}

CompletionTool type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L278-L290

func NewCompletionTool added in v8.18.0 

func NewCompletionTool() *CompletionTool

NewCompletionTool returns a CompletionTool.

func (*CompletionTool) UnmarshalJSON added in v8.18.0 

func (s *CompletionTool) UnmarshalJSON(data []byte) error

type CompletionToolChoice added in v8.18.0 

type CompletionToolChoice struct {
	// Function The tool choice function.
	Function CompletionToolChoiceFunction `json:"function"`
	// Type The type of the tool.
	Type string `json:"type"`
}

CompletionToolChoice type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L241-L253

func NewCompletionToolChoice added in v8.18.0 

func NewCompletionToolChoice() *CompletionToolChoice

NewCompletionToolChoice returns a CompletionToolChoice.

func (*CompletionToolChoice) UnmarshalJSON added in v8.18.0 

func (s *CompletionToolChoice) UnmarshalJSON(data []byte) error

type CompletionToolChoiceFunction added in v8.18.0 

type CompletionToolChoiceFunction struct {
	// Name The name of the function to call.
	Name string `json:"name"`
}

CompletionToolChoiceFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L230-L239

func NewCompletionToolChoiceFunction added in v8.18.0 

func NewCompletionToolChoiceFunction() *CompletionToolChoiceFunction

NewCompletionToolChoiceFunction returns a CompletionToolChoiceFunction.

func (*CompletionToolChoiceFunction) UnmarshalJSON added in v8.18.0 

func (s *CompletionToolChoiceFunction) UnmarshalJSON(data []byte) error

type CompletionToolFunction added in v8.18.0 

type CompletionToolFunction struct {
	// Description A description of what the function does.
	// This is used by the model to choose when and how to call the function.
	Description *string `json:"description,omitempty"`
	// Name The name of the function.
	Name string `json:"name"`
	// Parameters The parameters the functional accepts. This should be formatted as a JSON
	// object.
	Parameters json.RawMessage `json:"parameters,omitempty"`
	// Strict Whether to enable schema adherence when generating the function call.
	Strict *bool `json:"strict,omitempty"`
}

CompletionToolFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L255-L276

func NewCompletionToolFunction added in v8.18.0 

func NewCompletionToolFunction() *CompletionToolFunction

NewCompletionToolFunction returns a CompletionToolFunction.

func (*CompletionToolFunction) UnmarshalJSON added in v8.18.0 

func (s *CompletionToolFunction) UnmarshalJSON(data []byte) error

type CompletionToolType added in v8.18.0 

type CompletionToolType any

CompletionToolType holds the union for the following types: 

string
CompletionToolChoice

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L118-L121

type ComponentTemplateNode 

type ComponentTemplateNode struct {
	Deprecated *bool                    `json:"deprecated,omitempty"`
	Meta_      Metadata                 `json:"_meta,omitempty"`
	Template   ComponentTemplateSummary `json:"template"`
	Version    *int64                   `json:"version,omitempty"`
}

ComponentTemplateNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/_types/ComponentTemplate.ts#L32-L41

func NewComponentTemplateNode added in v8.5.0 

func NewComponentTemplateNode() *ComponentTemplateNode

NewComponentTemplateNode returns a ComponentTemplateNode.

func (*ComponentTemplateNode) UnmarshalJSON added in v8.7.1 

func (s *ComponentTemplateNode) UnmarshalJSON(data []byte) error

type ComponentTemplateSummary 

type ComponentTemplateSummary struct {
	Aliases   map[string]AliasDefinition       `json:"aliases,omitempty"`
	Lifecycle *DataStreamLifecycleWithRollover `json:"lifecycle,omitempty"`
	Mappings  *TypeMapping                     `json:"mappings,omitempty"`
	Meta_     Metadata                         `json:"_meta,omitempty"`
	Settings  map[string]IndexSettings         `json:"settings,omitempty"`
	Version   *int64                           `json:"version,omitempty"`
}

ComponentTemplateSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/_types/ComponentTemplate.ts#L43-L55

func NewComponentTemplateSummary added in v8.5.0 

func NewComponentTemplateSummary() *ComponentTemplateSummary

NewComponentTemplateSummary returns a ComponentTemplateSummary.

func (*ComponentTemplateSummary) UnmarshalJSON added in v8.7.1 

func (s *ComponentTemplateSummary) UnmarshalJSON(data []byte) error

type CompositeAggregate 

type CompositeAggregate struct {
	AfterKey CompositeAggregateKey  `json:"after_key,omitempty"`
	Buckets  BucketsCompositeBucket `json:"buckets"`
	Meta     Metadata               `json:"meta,omitempty"`
}

CompositeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L698-L703

func NewCompositeAggregate added in v8.5.0 

func NewCompositeAggregate() *CompositeAggregate

NewCompositeAggregate returns a CompositeAggregate.

func (*CompositeAggregate) UnmarshalJSON added in v8.7.0 

func (s *CompositeAggregate) UnmarshalJSON(data []byte) error

type CompositeAggregateKey added in v8.5.0 

type CompositeAggregateKey map[string]FieldValue

CompositeAggregateKey type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L128-L128

type CompositeAggregation 

type CompositeAggregation struct {
	// After When paginating, use the `after_key` value returned in the previous response
	// to retrieve the next page.
	After CompositeAggregateKey `json:"after,omitempty"`
	// Size The number of composite buckets that should be returned.
	Size *int `json:"size,omitempty"`
	// Sources The value sources used to build composite buckets.
	// Keys are returned in the order of the `sources` definition.
	Sources []map[string]CompositeAggregationSource `json:"sources,omitempty"`
}

CompositeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L130-L149

func NewCompositeAggregation added in v8.5.0 

func NewCompositeAggregation() *CompositeAggregation

NewCompositeAggregation returns a CompositeAggregation.

func (*CompositeAggregation) UnmarshalJSON added in v8.7.1 

func (s *CompositeAggregation) UnmarshalJSON(data []byte) error

type CompositeAggregationSource 

type CompositeAggregationSource struct {
	// DateHistogram A date histogram aggregation.
	DateHistogram *CompositeDateHistogramAggregation `json:"date_histogram,omitempty"`
	// GeotileGrid A geotile grid aggregation.
	GeotileGrid *CompositeGeoTileGridAggregation `json:"geotile_grid,omitempty"`
	// Histogram A histogram aggregation.
	Histogram *CompositeHistogramAggregation `json:"histogram,omitempty"`
	// Terms A terms aggregation.
	Terms *CompositeTermsAggregation `json:"terms,omitempty"`
}

CompositeAggregationSource type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L151-L168

func NewCompositeAggregationSource added in v8.5.0 

func NewCompositeAggregationSource() *CompositeAggregationSource

NewCompositeAggregationSource returns a CompositeAggregationSource.

type CompositeBucket 

type CompositeBucket struct {
	Aggregations map[string]Aggregate  `json:"-"`
	DocCount     int64                 `json:"doc_count"`
	Key          CompositeAggregateKey `json:"key"`
}

CompositeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L705-L707

func NewCompositeBucket added in v8.5.0 

func NewCompositeBucket() *CompositeBucket

NewCompositeBucket returns a CompositeBucket.

func (CompositeBucket) MarshalJSON 

func (s CompositeBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*CompositeBucket) UnmarshalJSON added in v8.7.0 

func (s *CompositeBucket) UnmarshalJSON(data []byte) error

type CompositeDateHistogramAggregation added in v8.10.0 

type CompositeDateHistogramAggregation struct {
	// CalendarInterval Either `calendar_interval` or `fixed_interval` must be present
	CalendarInterval *string `json:"calendar_interval,omitempty"`
	// Field Either `field` or `script` must be present
	Field *string `json:"field,omitempty"`
	// FixedInterval Either `calendar_interval` or `fixed_interval` must be present
	FixedInterval *string                    `json:"fixed_interval,omitempty"`
	Format        *string                    `json:"format,omitempty"`
	MissingBucket *bool                      `json:"missing_bucket,omitempty"`
	MissingOrder  *missingorder.MissingOrder `json:"missing_order,omitempty"`
	Offset        Duration                   `json:"offset,omitempty"`
	Order         *sortorder.SortOrder       `json:"order,omitempty"`
	// Script Either `field` or `script` must be present
	Script    *Script              `json:"script,omitempty"`
	TimeZone  *string              `json:"time_zone,omitempty"`
	ValueType *valuetype.ValueType `json:"value_type,omitempty"`
}

CompositeDateHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L187-L195

func NewCompositeDateHistogramAggregation added in v8.10.0 

func NewCompositeDateHistogramAggregation() *CompositeDateHistogramAggregation

NewCompositeDateHistogramAggregation returns a CompositeDateHistogramAggregation.

func (*CompositeDateHistogramAggregation) UnmarshalJSON added in v8.10.0 

func (s *CompositeDateHistogramAggregation) UnmarshalJSON(data []byte) error

type CompositeGeoTileGridAggregation added in v8.10.0 

type CompositeGeoTileGridAggregation struct {
	Bounds GeoBounds `json:"bounds,omitempty"`
	// Field Either `field` or `script` must be present
	Field         *string                    `json:"field,omitempty"`
	MissingBucket *bool                      `json:"missing_bucket,omitempty"`
	MissingOrder  *missingorder.MissingOrder `json:"missing_order,omitempty"`
	Order         *sortorder.SortOrder       `json:"order,omitempty"`
	Precision     *int                       `json:"precision,omitempty"`
	// Script Either `field` or `script` must be present
	Script    *Script              `json:"script,omitempty"`
	ValueType *valuetype.ValueType `json:"value_type,omitempty"`
}

CompositeGeoTileGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L197-L200

func NewCompositeGeoTileGridAggregation added in v8.10.0 

func NewCompositeGeoTileGridAggregation() *CompositeGeoTileGridAggregation

NewCompositeGeoTileGridAggregation returns a CompositeGeoTileGridAggregation.

func (*CompositeGeoTileGridAggregation) UnmarshalJSON added in v8.10.0 

func (s *CompositeGeoTileGridAggregation) UnmarshalJSON(data []byte) error

type CompositeHistogramAggregation added in v8.10.0 

type CompositeHistogramAggregation struct {
	// Field Either `field` or `script` must be present
	Field         *string                    `json:"field,omitempty"`
	Interval      Float64                    `json:"interval"`
	MissingBucket *bool                      `json:"missing_bucket,omitempty"`
	MissingOrder  *missingorder.MissingOrder `json:"missing_order,omitempty"`
	Order         *sortorder.SortOrder       `json:"order,omitempty"`
	// Script Either `field` or `script` must be present
	Script    *Script              `json:"script,omitempty"`
	ValueType *valuetype.ValueType `json:"value_type,omitempty"`
}

CompositeHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L183-L185

func NewCompositeHistogramAggregation added in v8.10.0 

func NewCompositeHistogramAggregation() *CompositeHistogramAggregation

NewCompositeHistogramAggregation returns a CompositeHistogramAggregation.

func (*CompositeHistogramAggregation) UnmarshalJSON added in v8.10.0 

func (s *CompositeHistogramAggregation) UnmarshalJSON(data []byte) error

type CompositeSubField added in v8.16.0 

type CompositeSubField struct {
	Type runtimefieldtype.RuntimeFieldType `json:"type"`
}

CompositeSubField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/RuntimeFields.ts#L52-L54

func NewCompositeSubField added in v8.16.0 

func NewCompositeSubField() *CompositeSubField

NewCompositeSubField returns a CompositeSubField.

type CompositeTermsAggregation added in v8.10.0 

type CompositeTermsAggregation struct {
	// Field Either `field` or `script` must be present
	Field         *string                    `json:"field,omitempty"`
	MissingBucket *bool                      `json:"missing_bucket,omitempty"`
	MissingOrder  *missingorder.MissingOrder `json:"missing_order,omitempty"`
	Order         *sortorder.SortOrder       `json:"order,omitempty"`
	// Script Either `field` or `script` must be present
	Script    *Script              `json:"script,omitempty"`
	ValueType *valuetype.ValueType `json:"value_type,omitempty"`
}

CompositeTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L181-L181

func NewCompositeTermsAggregation added in v8.10.0 

func NewCompositeTermsAggregation() *CompositeTermsAggregation

NewCompositeTermsAggregation returns a CompositeTermsAggregation.

func (*CompositeTermsAggregation) UnmarshalJSON added in v8.10.0 

func (s *CompositeTermsAggregation) UnmarshalJSON(data []byte) error

type ConditionTokenFilter 

type ConditionTokenFilter struct {
	// Filter Array of token filters. If a token matches the predicate script in the
	// `script` parameter, these filters are applied to the token in the order
	// provided.
	Filter []string `json:"filter"`
	// Script Predicate script used to apply token filters. If a token matches this script,
	// the filters in the `filter` parameter are applied to the token.
	Script  Script  `json:"script"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ConditionTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L237-L243

func NewConditionTokenFilter added in v8.5.0 

func NewConditionTokenFilter() *ConditionTokenFilter

NewConditionTokenFilter returns a ConditionTokenFilter.

func (ConditionTokenFilter) MarshalJSON added in v8.9.0 

func (s ConditionTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ConditionTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *ConditionTokenFilter) UnmarshalJSON(data []byte) error

type Configuration 

type Configuration struct {
	// FeatureStates A list of feature states to be included in this snapshot. A list of features
	// available for inclusion in the snapshot and their descriptions be can be
	// retrieved using the get features API.
	// Each feature state includes one or more system indices containing data
	// necessary for the function of that feature. Providing an empty array will
	// include no feature states in the snapshot, regardless of the value of
	// include_global_state. By default, all available feature states will be
	// included in the snapshot if include_global_state is true, or no feature
	// states if include_global_state is false.
	FeatureStates []string `json:"feature_states,omitempty"`
	// IgnoreUnavailable If false, the snapshot fails if any data stream or index in indices is
	// missing or closed. If true, the snapshot ignores missing or closed data
	// streams and indices.
	IgnoreUnavailable *bool `json:"ignore_unavailable,omitempty"`
	// IncludeGlobalState If true, the current global state is included in the snapshot.
	IncludeGlobalState *bool `json:"include_global_state,omitempty"`
	// Indices A comma-separated list of data streams and indices to include in the
	// snapshot. Multi-index syntax is supported.
	// By default, a snapshot includes all data streams and indices in the cluster.
	// If this argument is provided, the snapshot only includes the specified data
	// streams and clusters.
	Indices []string `json:"indices,omitempty"`
	// Metadata Attaches arbitrary metadata to the snapshot, such as a record of who took the
	// snapshot, why it was taken, or any other useful data. Metadata must be less
	// than 1024 bytes.
	Metadata Metadata `json:"metadata,omitempty"`
	// Partial If false, the entire snapshot will fail if one or more indices included in
	// the snapshot do not have all primary shards available.
	Partial *bool `json:"partial,omitempty"`
}

Configuration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L109-L139

func NewConfiguration added in v8.5.0 

func NewConfiguration() *Configuration

NewConfiguration returns a Configuration.

func (*Configuration) UnmarshalJSON added in v8.7.1 

func (s *Configuration) UnmarshalJSON(data []byte) error

type ConfusionMatrixItem 

type ConfusionMatrixItem struct {
	ActualClass                 string                      `json:"actual_class"`
	ActualClassDocCount         int                         `json:"actual_class_doc_count"`
	OtherPredictedClassDocCount int                         `json:"other_predicted_class_doc_count"`
	PredictedClasses            []ConfusionMatrixPrediction `json:"predicted_classes"`
}

ConfusionMatrixItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L125-L130

func NewConfusionMatrixItem added in v8.5.0 

func NewConfusionMatrixItem() *ConfusionMatrixItem

NewConfusionMatrixItem returns a ConfusionMatrixItem.

func (*ConfusionMatrixItem) UnmarshalJSON added in v8.7.1 

func (s *ConfusionMatrixItem) UnmarshalJSON(data []byte) error

type ConfusionMatrixPrediction 

type ConfusionMatrixPrediction struct {
	Count          int    `json:"count"`
	PredictedClass string `json:"predicted_class"`
}

ConfusionMatrixPrediction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L132-L135

func NewConfusionMatrixPrediction added in v8.5.0 

func NewConfusionMatrixPrediction() *ConfusionMatrixPrediction

NewConfusionMatrixPrediction returns a ConfusionMatrixPrediction.

func (*ConfusionMatrixPrediction) UnmarshalJSON added in v8.7.1 

func (s *ConfusionMatrixPrediction) UnmarshalJSON(data []byte) error

type ConfusionMatrixThreshold 

type ConfusionMatrixThreshold struct {
	// FalseNegative False Negative
	FalseNegative int `json:"fn"`
	// FalsePositive False Positive
	FalsePositive int `json:"fp"`
	// TrueNegative True Negative
	TrueNegative int `json:"tn"`
	// TruePositive True Positive
	TruePositive int `json:"tp"`
}

ConfusionMatrixThreshold type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L137-L158

func NewConfusionMatrixThreshold added in v8.5.0 

func NewConfusionMatrixThreshold() *ConfusionMatrixThreshold

NewConfusionMatrixThreshold returns a ConfusionMatrixThreshold.

func (*ConfusionMatrixThreshold) UnmarshalJSON added in v8.7.1 

func (s *ConfusionMatrixThreshold) UnmarshalJSON(data []byte) error

type Connection 

type Connection struct {
	DocCount int64   `json:"doc_count"`
	Source   int64   `json:"source"`
	Target   int64   `json:"target"`
	Weight   Float64 `json:"weight"`
}

Connection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/Connection.ts#L22-L27

func NewConnection added in v8.5.0 

func NewConnection() *Connection

NewConnection returns a Connection.

func (*Connection) UnmarshalJSON added in v8.7.1 

func (s *Connection) UnmarshalJSON(data []byte) error

type Connector added in v8.15.0 

type Connector struct {
	ApiKeyId                         *string                         `json:"api_key_id,omitempty"`
	ApiKeySecretId                   *string                         `json:"api_key_secret_id,omitempty"`
	Configuration                    ConnectorConfiguration          `json:"configuration"`
	CustomScheduling                 ConnectorCustomScheduling       `json:"custom_scheduling"`
	Description                      *string                         `json:"description,omitempty"`
	Error                            *string                         `json:"error,omitempty"`
	Features                         *ConnectorFeatures              `json:"features,omitempty"`
	Filtering                        []FilteringConfig               `json:"filtering"`
	Id                               *string                         `json:"id,omitempty"`
	IndexName                        *string                         `json:"index_name,omitempty"`
	IsNative                         bool                            `json:"is_native"`
	Language                         *string                         `json:"language,omitempty"`
	LastAccessControlSyncError       *string                         `json:"last_access_control_sync_error,omitempty"`
	LastAccessControlSyncScheduledAt DateTime                        `json:"last_access_control_sync_scheduled_at,omitempty"`
	LastAccessControlSyncStatus      *syncstatus.SyncStatus          `json:"last_access_control_sync_status,omitempty"`
	LastDeletedDocumentCount         *int64                          `json:"last_deleted_document_count,omitempty"`
	LastIncrementalSyncScheduledAt   DateTime                        `json:"last_incremental_sync_scheduled_at,omitempty"`
	LastIndexedDocumentCount         *int64                          `json:"last_indexed_document_count,omitempty"`
	LastSeen                         DateTime                        `json:"last_seen,omitempty"`
	LastSyncError                    *string                         `json:"last_sync_error,omitempty"`
	LastSyncScheduledAt              DateTime                        `json:"last_sync_scheduled_at,omitempty"`
	LastSyncStatus                   *syncstatus.SyncStatus          `json:"last_sync_status,omitempty"`
	LastSynced                       DateTime                        `json:"last_synced,omitempty"`
	Name                             *string                         `json:"name,omitempty"`
	Pipeline                         *IngestPipelineParams           `json:"pipeline,omitempty"`
	Scheduling                       SchedulingConfiguration         `json:"scheduling"`
	ServiceType                      *string                         `json:"service_type,omitempty"`
	Status                           connectorstatus.ConnectorStatus `json:"status"`
	SyncCursor                       json.RawMessage                 `json:"sync_cursor,omitempty"`
	SyncNow                          bool                            `json:"sync_now"`
}

Connector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L252-L283

func NewConnector added in v8.15.0 

func NewConnector() *Connector

NewConnector returns a Connector.

func (*Connector) UnmarshalJSON added in v8.15.0 

func (s *Connector) UnmarshalJSON(data []byte) error

type ConnectorConfigProperties added in v8.15.0 

type ConnectorConfigProperties struct {
	Category       *string                                `json:"category,omitempty"`
	DefaultValue   ScalarValue                            `json:"default_value"`
	DependsOn      []Dependency                           `json:"depends_on"`
	Display        displaytype.DisplayType                `json:"display"`
	Label          string                                 `json:"label"`
	Options        []SelectOption                         `json:"options"`
	Order          *int                                   `json:"order,omitempty"`
	Placeholder    *string                                `json:"placeholder,omitempty"`
	Required       bool                                   `json:"required"`
	Sensitive      bool                                   `json:"sensitive"`
	Tooltip        *string                                `json:"tooltip,omitempty"`
	Type           *connectorfieldtype.ConnectorFieldType `json:"type,omitempty"`
	UiRestrictions []string                               `json:"ui_restrictions,omitempty"`
	Validations    []Validation                           `json:"validations,omitempty"`
	Value          json.RawMessage                        `json:"value,omitempty"`
}

ConnectorConfigProperties type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L83-L99

func NewConnectorConfigProperties added in v8.15.0 

func NewConnectorConfigProperties() *ConnectorConfigProperties

NewConnectorConfigProperties returns a ConnectorConfigProperties.

func (*ConnectorConfigProperties) UnmarshalJSON added in v8.15.0 

func (s *ConnectorConfigProperties) UnmarshalJSON(data []byte) error

type ConnectorConfiguration added in v8.15.0 

type ConnectorConfiguration map[string]ConnectorConfigProperties

ConnectorConfiguration type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L101-L104

type ConnectorCustomScheduling added in v8.15.0 

type ConnectorCustomScheduling map[string]CustomScheduling

ConnectorCustomScheduling type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L128-L128

type ConnectorFeatures added in v8.15.0 

type ConnectorFeatures struct {
	// DocumentLevelSecurity Indicates whether document-level security is enabled.
	DocumentLevelSecurity *FeatureEnabled `json:"document_level_security,omitempty"`
	// IncrementalSync Indicates whether incremental syncs are enabled.
	IncrementalSync *FeatureEnabled `json:"incremental_sync,omitempty"`
	// NativeConnectorApiKeys Indicates whether managed connector API keys are enabled.
	NativeConnectorApiKeys *FeatureEnabled   `json:"native_connector_api_keys,omitempty"`
	SyncRules              *SyncRulesFeature `json:"sync_rules,omitempty"`
}

ConnectorFeatures type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L230-L244

func NewConnectorFeatures added in v8.15.0 

func NewConnectorFeatures() *ConnectorFeatures

NewConnectorFeatures returns a ConnectorFeatures.

type ConnectorScheduling added in v8.15.0 

type ConnectorScheduling struct {
	Enabled bool `json:"enabled"`
	// Interval The interval is expressed using the crontab syntax
	Interval string `json:"interval"`
}

ConnectorScheduling type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L106-L110

func NewConnectorScheduling added in v8.15.0 

func NewConnectorScheduling() *ConnectorScheduling

NewConnectorScheduling returns a ConnectorScheduling.

func (*ConnectorScheduling) UnmarshalJSON added in v8.15.0 

func (s *ConnectorScheduling) UnmarshalJSON(data []byte) error

type ConnectorSyncJob added in v8.15.0 

type ConnectorSyncJob struct {
	CancelationRequestedAt DateTime                                  `json:"cancelation_requested_at,omitempty"`
	CanceledAt             DateTime                                  `json:"canceled_at,omitempty"`
	CompletedAt            DateTime                                  `json:"completed_at,omitempty"`
	Connector              SyncJobConnectorReference                 `json:"connector"`
	CreatedAt              DateTime                                  `json:"created_at"`
	DeletedDocumentCount   int64                                     `json:"deleted_document_count"`
	Error                  *string                                   `json:"error,omitempty"`
	Id                     string                                    `json:"id"`
	IndexedDocumentCount   int64                                     `json:"indexed_document_count"`
	IndexedDocumentVolume  int64                                     `json:"indexed_document_volume"`
	JobType                syncjobtype.SyncJobType                   `json:"job_type"`
	LastSeen               DateTime                                  `json:"last_seen,omitempty"`
	Metadata               map[string]json.RawMessage                `json:"metadata"`
	StartedAt              DateTime                                  `json:"started_at,omitempty"`
	Status                 syncstatus.SyncStatus                     `json:"status"`
	TotalDocumentCount     int64                                     `json:"total_document_count"`
	TriggerMethod          syncjobtriggermethod.SyncJobTriggerMethod `json:"trigger_method"`
	WorkerHostname         *string                                   `json:"worker_hostname,omitempty"`
}

ConnectorSyncJob type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/SyncJob.ts#L53-L72

func NewConnectorSyncJob added in v8.15.0 

func NewConnectorSyncJob() *ConnectorSyncJob

NewConnectorSyncJob returns a ConnectorSyncJob.

func (*ConnectorSyncJob) UnmarshalJSON added in v8.15.0 

func (s *ConnectorSyncJob) UnmarshalJSON(data []byte) error

type ConstantKeywordProperty 

type ConstantKeywordProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
	Value               json.RawMessage                                  `json:"value,omitempty"`
}

ConstantKeywordProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L50-L53

func NewConstantKeywordProperty added in v8.5.0 

func NewConstantKeywordProperty() *ConstantKeywordProperty

NewConstantKeywordProperty returns a ConstantKeywordProperty.

func (ConstantKeywordProperty) MarshalJSON added in v8.9.0 

func (s ConstantKeywordProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ConstantKeywordProperty) UnmarshalJSON added in v8.7.0 

func (s *ConstantKeywordProperty) UnmarshalJSON(data []byte) error

type ConstantScoreQuery 

type ConstantScoreQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Filter Filter query you wish to run. Any returned documents must match this query.
	// Filter queries do not calculate relevance scores.
	// To speed up performance, Elasticsearch automatically caches frequently used
	// filter queries.
	Filter     *Query  `json:"filter,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
}

ConstantScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L76-L86

func NewConstantScoreQuery added in v8.5.0 

func NewConstantScoreQuery() *ConstantScoreQuery

NewConstantScoreQuery returns a ConstantScoreQuery.

func (*ConstantScoreQuery) UnmarshalJSON added in v8.7.1 

func (s *ConstantScoreQuery) UnmarshalJSON(data []byte) error

type ContentObject added in v8.18.0 

type ContentObject struct {
	// Text The text content.
	Text string `json:"text"`
	// Type The type of content.
	Type string `json:"type"`
}

ContentObject type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L123-L135

func NewContentObject added in v8.18.0 

func NewContentObject() *ContentObject

NewContentObject returns a ContentObject.

func (*ContentObject) UnmarshalJSON added in v8.18.0 

func (s *ContentObject) UnmarshalJSON(data []byte) error

type Context 

type Context any

Context holds the union for the following types: 

string
GeoLocation

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L228-L233

type ContextMethod 

type ContextMethod struct {
	Name       string               `json:"name"`
	Params     []ContextMethodParam `json:"params"`
	ReturnType string               `json:"return_type"`
}

ContextMethod type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/get_script_context/types.ts#L27-L31

func NewContextMethod added in v8.5.0 

func NewContextMethod() *ContextMethod

NewContextMethod returns a ContextMethod.

func (*ContextMethod) UnmarshalJSON added in v8.7.1 

func (s *ContextMethod) UnmarshalJSON(data []byte) error

type ContextMethodParam 

type ContextMethodParam struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

ContextMethodParam type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/get_script_context/types.ts#L33-L36

func NewContextMethodParam added in v8.5.0 

func NewContextMethodParam() *ContextMethodParam

NewContextMethodParam returns a ContextMethodParam.

func (*ContextMethodParam) UnmarshalJSON added in v8.7.1 

func (s *ContextMethodParam) UnmarshalJSON(data []byte) error

type ConvertProcessor 

type ConvertProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field whose value is to be converted.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to.
	// By default, the `field` is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
	// Type The type to convert the existing value to.
	Type converttype.ConvertType `json:"type"`
}

ConvertProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L672-L692

func NewConvertProcessor added in v8.5.0 

func NewConvertProcessor() *ConvertProcessor

NewConvertProcessor returns a ConvertProcessor.

func (*ConvertProcessor) UnmarshalJSON added in v8.7.1 

func (s *ConvertProcessor) UnmarshalJSON(data []byte) error

type CoordinatorStats 

type CoordinatorStats struct {
	ExecutedSearchesTotal int64  `json:"executed_searches_total"`
	NodeId                string `json:"node_id"`
	QueueSize             int    `json:"queue_size"`
	RemoteRequestsCurrent int    `json:"remote_requests_current"`
	RemoteRequestsTotal   int64  `json:"remote_requests_total"`
}

CoordinatorStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/stats/types.ts#L30-L36

func NewCoordinatorStats added in v8.5.0 

func NewCoordinatorStats() *CoordinatorStats

NewCoordinatorStats returns a CoordinatorStats.

func (*CoordinatorStats) UnmarshalJSON added in v8.7.1 

func (s *CoordinatorStats) UnmarshalJSON(data []byte) error

type CoordsGeoBounds 

type CoordsGeoBounds struct {
	Bottom Float64 `json:"bottom"`
	Left   Float64 `json:"left"`
	Right  Float64 `json:"right"`
	Top    Float64 `json:"top"`
}

CoordsGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L154-L159

func NewCoordsGeoBounds added in v8.5.0 

func NewCoordsGeoBounds() *CoordsGeoBounds

NewCoordsGeoBounds returns a CoordsGeoBounds.

func (*CoordsGeoBounds) UnmarshalJSON added in v8.7.1 

func (s *CoordsGeoBounds) UnmarshalJSON(data []byte) error

type CoreKnnQuery added in v8.5.0 

type CoreKnnQuery struct {
	// Field The name of the vector field to search against
	Field string `json:"field"`
	// K The final number of nearest neighbors to return as top hits
	K int `json:"k"`
	// NumCandidates The number of nearest neighbor candidates to consider per shard
	NumCandidates int `json:"num_candidates"`
	// QueryVector The query vector
	QueryVector []float32 `json:"query_vector"`
}

CoreKnnQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/knn_search/_types/Knn.ts#L24-L33

func NewCoreKnnQuery added in v8.5.0 

func NewCoreKnnQuery() *CoreKnnQuery

NewCoreKnnQuery returns a CoreKnnQuery.

func (*CoreKnnQuery) UnmarshalJSON added in v8.7.1 

func (s *CoreKnnQuery) UnmarshalJSON(data []byte) error

type CountRecord 

type CountRecord struct {
	// Count the document count
	Count *string `json:"count,omitempty"`
	// Epoch seconds since 1970-01-01 00:00:00
	Epoch StringifiedEpochTimeUnitSeconds `json:"epoch,omitempty"`
	// Timestamp time in HH:MM:SS
	Timestamp *string `json:"timestamp,omitempty"`
}

CountRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/count/types.ts#L23-L39

func NewCountRecord added in v8.5.0 

func NewCountRecord() *CountRecord

NewCountRecord returns a CountRecord.

func (*CountRecord) UnmarshalJSON added in v8.7.1 

func (s *CountRecord) UnmarshalJSON(data []byte) error

type CountedKeywordProperty added in v8.18.0 

type CountedKeywordProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

CountedKeywordProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L55-L62

func NewCountedKeywordProperty added in v8.18.0 

func NewCountedKeywordProperty() *CountedKeywordProperty

NewCountedKeywordProperty returns a CountedKeywordProperty.

func (CountedKeywordProperty) MarshalJSON added in v8.18.0 

func (s CountedKeywordProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CountedKeywordProperty) UnmarshalJSON added in v8.18.0 

func (s *CountedKeywordProperty) UnmarshalJSON(data []byte) error

type Counter 

type Counter struct {
	Active int64 `json:"active"`
	Total  int64 `json:"total"`
}

Counter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L32-L35

func NewCounter added in v8.5.0 

func NewCounter() *Counter

NewCounter returns a Counter.

func (*Counter) UnmarshalJSON added in v8.7.1 

func (s *Counter) UnmarshalJSON(data []byte) error

type Cpu 

type Cpu struct {
	LoadAverage   map[string]Float64 `json:"load_average,omitempty"`
	Percent       *int               `json:"percent,omitempty"`
	Sys           Duration           `json:"sys,omitempty"`
	SysInMillis   *int64             `json:"sys_in_millis,omitempty"`
	Total         Duration           `json:"total,omitempty"`
	TotalInMillis *int64             `json:"total_in_millis,omitempty"`
	User          Duration           `json:"user,omitempty"`
	UserInMillis  *int64             `json:"user_in_millis,omitempty"`
}

Cpu type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L575-L584

func NewCpu added in v8.5.0 

func NewCpu() *Cpu

NewCpu returns a Cpu.

func (*Cpu) UnmarshalJSON added in v8.7.1 

func (s *Cpu) UnmarshalJSON(data []byte) error

type CpuAcct 

type CpuAcct struct {
	// ControlGroup The `cpuacct` control group to which the Elasticsearch process belongs.
	ControlGroup *string `json:"control_group,omitempty"`
	// UsageNanos The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup
	// as the Elasticsearch process.
	UsageNanos *int64 `json:"usage_nanos,omitempty"`
}

CpuAcct type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L512-L521

func NewCpuAcct added in v8.5.0 

func NewCpuAcct() *CpuAcct

NewCpuAcct returns a CpuAcct.

func (*CpuAcct) UnmarshalJSON added in v8.7.1 

func (s *CpuAcct) UnmarshalJSON(data []byte) error

type CreateFrom added in v8.18.0 

type CreateFrom struct {
	// MappingsOverride Mappings overrides to be applied to the destination index (optional)
	MappingsOverride *TypeMapping `json:"mappings_override,omitempty"`
	// RemoveIndexBlocks If index blocks should be removed when creating destination index (optional)
	RemoveIndexBlocks *bool `json:"remove_index_blocks,omitempty"`
	// SettingsOverride Settings overrides to be applied to the destination index (optional)
	SettingsOverride *IndexSettings `json:"settings_override,omitempty"`
}

CreateFrom type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/create_from/MigrateCreateFromRequest.ts#L46-L60

func NewCreateFrom added in v8.18.0 

func NewCreateFrom() *CreateFrom

NewCreateFrom returns a CreateFrom.

func (*CreateFrom) UnmarshalJSON added in v8.18.0 

func (s *CreateFrom) UnmarshalJSON(data []byte) error

type CreateOperation added in v8.9.0 

type CreateOperation struct {
	// DynamicTemplates A map from the full name of fields to the name of dynamic templates.
	// It defaults to an empty map.
	// If a name matches a dynamic template, that template will be applied
	// regardless of other match predicates defined in the template.
	// If a field is already defined in the mapping, then this parameter won't be
	// used.
	DynamicTemplates map[string]string `json:"dynamic_templates,omitempty"`
	// Id_ The document ID.
	Id_           *string `json:"_id,omitempty"`
	IfPrimaryTerm *int64  `json:"if_primary_term,omitempty"`
	IfSeqNo       *int64  `json:"if_seq_no,omitempty"`
	// Index_ The name of the index or index alias to perform the action on.
	Index_ *string `json:"_index,omitempty"`
	// Pipeline The ID of the pipeline to use to preprocess incoming documents.
	// If the index has a default ingest pipeline specified, setting the value to
	// `_none` turns off the default ingest pipeline for this request.
	// If a final pipeline is configured, it will always run regardless of the value
	// of this parameter.
	Pipeline *string `json:"pipeline,omitempty"`
	// RequireAlias If `true`, the request's actions must target an index alias.
	RequireAlias *bool `json:"require_alias,omitempty"`
	// Routing A custom value used to route operations to a specific shard.
	Routing     *string                  `json:"routing,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

CreateOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L140-L140

func NewCreateOperation added in v8.9.0 

func NewCreateOperation() *CreateOperation

NewCreateOperation returns a CreateOperation.

func (*CreateOperation) UnmarshalJSON added in v8.9.0 

func (s *CreateOperation) UnmarshalJSON(data []byte) error

type CreatedStatus 

type CreatedStatus struct {
	Created bool `json:"created"`
}

CreatedStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/CreatedStatus.ts#L20-L22

func NewCreatedStatus added in v8.5.0 

func NewCreatedStatus() *CreatedStatus

NewCreatedStatus returns a CreatedStatus.

func (*CreatedStatus) UnmarshalJSON added in v8.7.1 

func (s *CreatedStatus) UnmarshalJSON(data []byte) error

type CsvProcessor 

type CsvProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// EmptyValue Value used to fill empty fields.
	// Empty fields are skipped if this is not provided.
	// An empty field is one with no value (2 consecutive separators) or empty
	// quotes (`""`).
	EmptyValue json.RawMessage `json:"empty_value,omitempty"`
	// Field The field to extract data from.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Quote Quote used in CSV, has to be single character string.
	Quote *string `json:"quote,omitempty"`
	// Separator Separator used in CSV, has to be single character string.
	Separator *string `json:"separator,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetFields The array of fields to assign extracted values to.
	TargetFields []string `json:"target_fields"`
	// Trim Trim whitespaces in unquoted fields.
	Trim *bool `json:"trim,omitempty"`
}

CsvProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L694-L727

func NewCsvProcessor added in v8.5.0 

func NewCsvProcessor() *CsvProcessor

NewCsvProcessor returns a CsvProcessor.

func (*CsvProcessor) UnmarshalJSON added in v8.7.1 

func (s *CsvProcessor) UnmarshalJSON(data []byte) error

type CumulativeCardinalityAggregate 

type CumulativeCardinalityAggregate struct {
	Meta          Metadata `json:"meta,omitempty"`
	Value         int64    `json:"value"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

CumulativeCardinalityAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L856-L864

func NewCumulativeCardinalityAggregate added in v8.5.0 

func NewCumulativeCardinalityAggregate() *CumulativeCardinalityAggregate

NewCumulativeCardinalityAggregate returns a CumulativeCardinalityAggregate.

func (*CumulativeCardinalityAggregate) UnmarshalJSON added in v8.7.1 

func (s *CumulativeCardinalityAggregate) UnmarshalJSON(data []byte) error

type CumulativeCardinalityAggregation 

type CumulativeCardinalityAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

CumulativeCardinalityAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L206-L209

func NewCumulativeCardinalityAggregation added in v8.5.0 

func NewCumulativeCardinalityAggregation() *CumulativeCardinalityAggregation

NewCumulativeCardinalityAggregation returns a CumulativeCardinalityAggregation.

func (*CumulativeCardinalityAggregation) UnmarshalJSON added in v8.7.0 

func (s *CumulativeCardinalityAggregation) UnmarshalJSON(data []byte) error

type CumulativeSumAggregation 

type CumulativeSumAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

CumulativeSumAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L211-L214

func NewCumulativeSumAggregation added in v8.5.0 

func NewCumulativeSumAggregation() *CumulativeSumAggregation

NewCumulativeSumAggregation returns a CumulativeSumAggregation.

func (*CumulativeSumAggregation) UnmarshalJSON added in v8.7.0 

func (s *CumulativeSumAggregation) UnmarshalJSON(data []byte) error

type CurrentNode 

type CurrentNode struct {
	Attributes       map[string]string   `json:"attributes"`
	Id               string              `json:"id"`
	Name             string              `json:"name"`
	Roles            []noderole.NodeRole `json:"roles"`
	TransportAddress string              `json:"transport_address"`
	WeightRanking    int                 `json:"weight_ranking"`
}

CurrentNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L79-L90

func NewCurrentNode added in v8.5.0 

func NewCurrentNode() *CurrentNode

NewCurrentNode returns a CurrentNode.

func (*CurrentNode) UnmarshalJSON added in v8.7.1 

func (s *CurrentNode) UnmarshalJSON(data []byte) error

type CustomAnalyzer 

type CustomAnalyzer struct {
	CharFilter           []string `json:"char_filter,omitempty"`
	Filter               []string `json:"filter,omitempty"`
	PositionIncrementGap *int     `json:"position_increment_gap,omitempty"`
	PositionOffsetGap    *int     `json:"position_offset_gap,omitempty"`
	Tokenizer            string   `json:"tokenizer"`
	Type                 string   `json:"type,omitempty"`
}

CustomAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L28-L35

func NewCustomAnalyzer added in v8.5.0 

func NewCustomAnalyzer() *CustomAnalyzer

NewCustomAnalyzer returns a CustomAnalyzer.

func (CustomAnalyzer) MarshalJSON added in v8.9.0 

func (s CustomAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CustomAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *CustomAnalyzer) UnmarshalJSON(data []byte) error

type CustomCategorizeTextAnalyzer 

type CustomCategorizeTextAnalyzer struct {
	CharFilter []string `json:"char_filter,omitempty"`
	Filter     []string `json:"filter,omitempty"`
	Tokenizer  *string  `json:"tokenizer,omitempty"`
}

CustomCategorizeTextAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1190-L1194

func NewCustomCategorizeTextAnalyzer added in v8.5.0 

func NewCustomCategorizeTextAnalyzer() *CustomCategorizeTextAnalyzer

NewCustomCategorizeTextAnalyzer returns a CustomCategorizeTextAnalyzer.

func (*CustomCategorizeTextAnalyzer) UnmarshalJSON added in v8.9.0 

func (s *CustomCategorizeTextAnalyzer) UnmarshalJSON(data []byte) error

type CustomNormalizer 

type CustomNormalizer struct {
	CharFilter []string `json:"char_filter,omitempty"`
	Filter     []string `json:"filter,omitempty"`
	Type       string   `json:"type,omitempty"`
}

CustomNormalizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/normalizers.ts#L30-L34

func NewCustomNormalizer added in v8.5.0 

func NewCustomNormalizer() *CustomNormalizer

NewCustomNormalizer returns a CustomNormalizer.

func (CustomNormalizer) MarshalJSON added in v8.9.0 

func (s CustomNormalizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type CustomScheduling added in v8.15.0 

type CustomScheduling struct {
	ConfigurationOverrides CustomSchedulingConfigurationOverrides `json:"configuration_overrides"`
	Enabled                bool                                   `json:"enabled"`
	Interval               string                                 `json:"interval"`
	LastSynced             DateTime                               `json:"last_synced,omitempty"`
	Name                   string                                 `json:"name"`
}

CustomScheduling type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L120-L126

func NewCustomScheduling added in v8.15.0 

func NewCustomScheduling() *CustomScheduling

NewCustomScheduling returns a CustomScheduling.

func (*CustomScheduling) UnmarshalJSON added in v8.15.0 

func (s *CustomScheduling) UnmarshalJSON(data []byte) error

type CustomSchedulingConfigurationOverrides added in v8.15.0 

type CustomSchedulingConfigurationOverrides struct {
	DomainAllowlist          []string `json:"domain_allowlist,omitempty"`
	MaxCrawlDepth            *int     `json:"max_crawl_depth,omitempty"`
	SeedUrls                 []string `json:"seed_urls,omitempty"`
	SitemapDiscoveryDisabled *bool    `json:"sitemap_discovery_disabled,omitempty"`
	SitemapUrls              []string `json:"sitemap_urls,omitempty"`
}

CustomSchedulingConfigurationOverrides type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L112-L118

func NewCustomSchedulingConfigurationOverrides added in v8.15.0 

func NewCustomSchedulingConfigurationOverrides() *CustomSchedulingConfigurationOverrides

NewCustomSchedulingConfigurationOverrides returns a CustomSchedulingConfigurationOverrides.

func (*CustomSchedulingConfigurationOverrides) UnmarshalJSON added in v8.15.0 

func (s *CustomSchedulingConfigurationOverrides) UnmarshalJSON(data []byte) error

type CzechAnalyzer added in v8.16.0 

type CzechAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

CzechAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L112-L117

func NewCzechAnalyzer added in v8.16.0 

func NewCzechAnalyzer() *CzechAnalyzer

NewCzechAnalyzer returns a CzechAnalyzer.

func (CzechAnalyzer) MarshalJSON added in v8.16.0 

func (s CzechAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*CzechAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *CzechAnalyzer) UnmarshalJSON(data []byte) error

type DailySchedule 

type DailySchedule struct {
	At []ScheduleTimeOfDay `json:"at"`
}

DailySchedule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L33-L35

func NewDailySchedule added in v8.5.0 

func NewDailySchedule() *DailySchedule

NewDailySchedule returns a DailySchedule.

type DanglingIndex 

type DanglingIndex struct {
	CreationDateMillis int64    `json:"creation_date_millis"`
	IndexName          string   `json:"index_name"`
	IndexUuid          string   `json:"index_uuid"`
	NodeIds            []string `json:"node_ids"`
}

DanglingIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34

func NewDanglingIndex added in v8.5.0 

func NewDanglingIndex() *DanglingIndex

NewDanglingIndex returns a DanglingIndex.

func (*DanglingIndex) UnmarshalJSON added in v8.7.1 

func (s *DanglingIndex) UnmarshalJSON(data []byte) error

type DanishAnalyzer added in v8.16.0 

type DanishAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

DanishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L119-L123

func NewDanishAnalyzer added in v8.16.0 

func NewDanishAnalyzer() *DanishAnalyzer

NewDanishAnalyzer returns a DanishAnalyzer.

func (DanishAnalyzer) MarshalJSON added in v8.16.0 

func (s DanishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DanishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *DanishAnalyzer) UnmarshalJSON(data []byte) error

type DataCounts 

type DataCounts struct {
	BucketCount                 int64  `json:"bucket_count"`
	EarliestRecordTimestamp     *int64 `json:"earliest_record_timestamp,omitempty"`
	EmptyBucketCount            int64  `json:"empty_bucket_count"`
	InputBytes                  int64  `json:"input_bytes"`
	InputFieldCount             int64  `json:"input_field_count"`
	InputRecordCount            int64  `json:"input_record_count"`
	InvalidDateCount            int64  `json:"invalid_date_count"`
	JobId                       string `json:"job_id"`
	LastDataTime                *int64 `json:"last_data_time,omitempty"`
	LatestBucketTimestamp       *int64 `json:"latest_bucket_timestamp,omitempty"`
	LatestEmptyBucketTimestamp  *int64 `json:"latest_empty_bucket_timestamp,omitempty"`
	LatestRecordTimestamp       *int64 `json:"latest_record_timestamp,omitempty"`
	LatestSparseBucketTimestamp *int64 `json:"latest_sparse_bucket_timestamp,omitempty"`
	LogTime                     *int64 `json:"log_time,omitempty"`
	MissingFieldCount           int64  `json:"missing_field_count"`
	OutOfOrderTimestampCount    int64  `json:"out_of_order_timestamp_count"`
	ProcessedFieldCount         int64  `json:"processed_field_count"`
	ProcessedRecordCount        int64  `json:"processed_record_count"`
	SparseBucketCount           int64  `json:"sparse_bucket_count"`
}

DataCounts type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L352-L372

func NewDataCounts added in v8.5.0 

func NewDataCounts() *DataCounts

NewDataCounts returns a DataCounts.

func (*DataCounts) UnmarshalJSON added in v8.7.1 

func (s *DataCounts) UnmarshalJSON(data []byte) error

type DataDescription 

type DataDescription struct {
	FieldDelimiter *string `json:"field_delimiter,omitempty"`
	// Format Only JSON format is supported at this time.
	Format *string `json:"format,omitempty"`
	// TimeField The name of the field that contains the timestamp.
	TimeField *string `json:"time_field,omitempty"`
	// TimeFormat The time format, which can be `epoch`, `epoch_ms`, or a custom pattern. The
	// value `epoch` refers to UNIX or Epoch time (the number of seconds since 1 Jan
	// 1970). The value `epoch_ms` indicates that time is measured in milliseconds
	// since the epoch. The `epoch` and `epoch_ms` time formats accept either
	// integer or real values. Custom patterns must conform to the Java
	// DateTimeFormatter class. When you use date-time formatting patterns, it is
	// recommended that you provide the full date, time and time zone. For example:
	// `yyyy-MM-dd'T'HH:mm:ssX`. If the pattern that you specify is not sufficient
	// to produce a complete timestamp, job creation fails.
	TimeFormat *string `json:"time_format,omitempty"`
}

DataDescription type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L374-L390

func NewDataDescription added in v8.5.0 

func NewDataDescription() *DataDescription

NewDataDescription returns a DataDescription.

func (*DataDescription) UnmarshalJSON added in v8.7.1 

func (s *DataDescription) UnmarshalJSON(data []byte) error

type DataEmailAttachment 

type DataEmailAttachment struct {
	Format *dataattachmentformat.DataAttachmentFormat `json:"format,omitempty"`
}

DataEmailAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L234-L236

func NewDataEmailAttachment added in v8.5.0 

func NewDataEmailAttachment() *DataEmailAttachment

NewDataEmailAttachment returns a DataEmailAttachment.

type DataFrameAnalyticsRecord 

type DataFrameAnalyticsRecord struct {
	// AssignmentExplanation Messages related to the selection of a node.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// CreateTime The time when the job was created.
	CreateTime *string `json:"create_time,omitempty"`
	// Description A description of the job.
	Description *string `json:"description,omitempty"`
	// DestIndex The name of the destination index.
	DestIndex *string `json:"dest_index,omitempty"`
	// FailureReason Messages about the reason why the job failed.
	FailureReason *string `json:"failure_reason,omitempty"`
	// Id The identifier for the job.
	Id *string `json:"id,omitempty"`
	// ModelMemoryLimit The approximate maximum amount of memory resources that are permitted for the
	// job.
	ModelMemoryLimit *string `json:"model_memory_limit,omitempty"`
	// NodeAddress The network address of the assigned node.
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId The ephemeral identifier of the assigned node.
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId The unique identifier of the assigned node.
	NodeId *string `json:"node.id,omitempty"`
	// NodeName The name of the assigned node.
	NodeName *string `json:"node.name,omitempty"`
	// Progress The progress report for the job by phase.
	Progress *string `json:"progress,omitempty"`
	// SourceIndex The name of the source index.
	SourceIndex *string `json:"source_index,omitempty"`
	// State The current status of the job.
	State *string `json:"state,omitempty"`
	// Type The type of analysis that the job performs.
	Type *string `json:"type,omitempty"`
	// Version The version of Elasticsearch when the job was created.
	Version *string `json:"version,omitempty"`
}

DataFrameAnalyticsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/ml_data_frame_analytics/types.ts#L22-L102

func NewDataFrameAnalyticsRecord added in v8.5.0 

func NewDataFrameAnalyticsRecord() *DataFrameAnalyticsRecord

NewDataFrameAnalyticsRecord returns a DataFrameAnalyticsRecord.

func (*DataFrameAnalyticsRecord) UnmarshalJSON added in v8.7.1 

func (s *DataFrameAnalyticsRecord) UnmarshalJSON(data []byte) error

type DataPathStats 

type DataPathStats struct {
	// Available Total amount of disk space available to this Java virtual machine on this
	// file store.
	Available *string `json:"available,omitempty"`
	// AvailableInBytes Total number of bytes available to this Java virtual machine on this file
	// store.
	AvailableInBytes     *int64  `json:"available_in_bytes,omitempty"`
	DiskQueue            *string `json:"disk_queue,omitempty"`
	DiskReadSize         *string `json:"disk_read_size,omitempty"`
	DiskReadSizeInBytes  *int64  `json:"disk_read_size_in_bytes,omitempty"`
	DiskReads            *int64  `json:"disk_reads,omitempty"`
	DiskWriteSize        *string `json:"disk_write_size,omitempty"`
	DiskWriteSizeInBytes *int64  `json:"disk_write_size_in_bytes,omitempty"`
	DiskWrites           *int64  `json:"disk_writes,omitempty"`
	// Free Total amount of unallocated disk space in the file store.
	Free *string `json:"free,omitempty"`
	// FreeInBytes Total number of unallocated bytes in the file store.
	FreeInBytes *int64 `json:"free_in_bytes,omitempty"`
	// Mount Mount point of the file store (for example: `/dev/sda2`).
	Mount *string `json:"mount,omitempty"`
	// Path Path to the file store.
	Path *string `json:"path,omitempty"`
	// Total Total size of the file store.
	Total *string `json:"total,omitempty"`
	// TotalInBytes Total size of the file store in bytes.
	TotalInBytes *int64 `json:"total_in_bytes,omitempty"`
	// Type Type of the file store (ex: ext4).
	Type *string `json:"type,omitempty"`
}

DataPathStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L586-L630

func NewDataPathStats added in v8.5.0 

func NewDataPathStats() *DataPathStats

NewDataPathStats returns a DataPathStats.

func (*DataPathStats) UnmarshalJSON added in v8.7.1 

func (s *DataPathStats) UnmarshalJSON(data []byte) error

type DataStream 

type DataStream struct {
	// AllowCustomRouting If `true`, the data stream allows custom routing on write request.
	AllowCustomRouting *bool `json:"allow_custom_routing,omitempty"`
	// FailureStore Information about failure store backing indices
	FailureStore *FailureStore `json:"failure_store,omitempty"`
	// Generation Current generation for the data stream. This number acts as a cumulative
	// count of the stream’s rollovers, starting at 1.
	Generation int `json:"generation"`
	// Hidden If `true`, the data stream is hidden.
	Hidden bool `json:"hidden"`
	// IlmPolicy Name of the current ILM lifecycle policy in the stream’s matching index
	// template.
	// This lifecycle policy is set in the `index.lifecycle.name` setting.
	// If the template does not include a lifecycle policy, this property is not
	// included in the response.
	// NOTE: A data stream’s backing indices may be assigned different lifecycle
	// policies. To retrieve the lifecycle policy for individual backing indices,
	// use the get index settings API.
	IlmPolicy *string `json:"ilm_policy,omitempty"`
	// Indices Array of objects containing information about the data stream’s backing
	// indices.
	// The last item in this array contains information about the stream’s current
	// write index.
	Indices []DataStreamIndex `json:"indices"`
	// Lifecycle Contains the configuration for the data stream lifecycle of this data stream.
	Lifecycle *DataStreamLifecycleWithRollover `json:"lifecycle,omitempty"`
	// Meta_ Custom metadata for the stream, copied from the `_meta` object of the
	// stream’s matching index template.
	// If empty, the response omits this property.
	Meta_ Metadata `json:"_meta,omitempty"`
	// Name Name of the data stream.
	Name string `json:"name"`
	// NextGenerationManagedBy Name of the lifecycle system that'll manage the next generation of the data
	// stream.
	NextGenerationManagedBy managedby.ManagedBy `json:"next_generation_managed_by"`
	// PreferIlm Indicates if ILM should take precedence over DSL in case both are configured
	// to managed this data stream.
	PreferIlm bool `json:"prefer_ilm"`
	// Replicated If `true`, the data stream is created and managed by cross-cluster
	// replication and the local cluster can not write into this data stream or
	// change its mappings.
	Replicated *bool `json:"replicated,omitempty"`
	// RolloverOnWrite If `true`, the next write to this data stream will trigger a rollover first
	// and the document will be indexed in the new backing index. If the rollover
	// fails the indexing request will fail too.
	RolloverOnWrite bool `json:"rollover_on_write"`
	// Status Health status of the data stream.
	// This health status is based on the state of the primary and replica shards of
	// the stream’s backing indices.
	Status healthstatus.HealthStatus `json:"status"`
	// System If `true`, the data stream is created and managed by an Elastic stack
	// component and cannot be modified through normal user interaction.
	System *bool `json:"system,omitempty"`
	// Template Name of the index template used to create the data stream’s backing indices.
	// The template’s index pattern must match the name of this data stream.
	Template string `json:"template"`
	// TimestampField Information about the `@timestamp` field in the data stream.
	TimestampField DataStreamTimestampField `json:"timestamp_field"`
}

DataStream type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStream.ts#L45-L127

func NewDataStream added in v8.5.0 

func NewDataStream() *DataStream

NewDataStream returns a DataStream.

func (*DataStream) UnmarshalJSON added in v8.7.1 

func (s *DataStream) UnmarshalJSON(data []byte) error

type DataStreamIndex 

type DataStreamIndex struct {
	// IlmPolicy Name of the current ILM lifecycle policy configured for this backing index.
	IlmPolicy *string `json:"ilm_policy,omitempty"`
	// IndexName Name of the backing index.
	IndexName string `json:"index_name"`
	// IndexUuid Universally unique identifier (UUID) for the index.
	IndexUuid string `json:"index_uuid"`
	// ManagedBy Name of the lifecycle system that's currently managing this backing index.
	ManagedBy *managedby.ManagedBy `json:"managed_by,omitempty"`
	// PreferIlm Indicates if ILM should take precedence over DSL in case both are configured
	// to manage this index.
	PreferIlm *bool `json:"prefer_ilm,omitempty"`
}

DataStreamIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStream.ts#L136-L157

func NewDataStreamIndex added in v8.5.0 

func NewDataStreamIndex() *DataStreamIndex

NewDataStreamIndex returns a DataStreamIndex.

func (*DataStreamIndex) UnmarshalJSON added in v8.7.1 

func (s *DataStreamIndex) UnmarshalJSON(data []byte) error

type DataStreamLifecycle added in v8.8.0 

type DataStreamLifecycle struct {
	// DataRetention If defined, every document added to this data stream will be stored at least
	// for this time frame.
	// Any time after this duration the document could be deleted.
	// When empty, every document in this data stream will be stored indefinitely.
	DataRetention Duration `json:"data_retention,omitempty"`
	// Downsampling The downsampling configuration to execute for the managed backing index after
	// rollover.
	Downsampling *DataStreamLifecycleDownsampling `json:"downsampling,omitempty"`
	// Enabled If defined, it turns data stream lifecycle on/off (`true`/`false`) for this
	// data stream. A data stream lifecycle
	// that's disabled (enabled: `false`) will have no effect on the data stream.
	Enabled *bool `json:"enabled,omitempty"`
}

DataStreamLifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStreamLifecycle.ts#L25-L45

func NewDataStreamLifecycle added in v8.8.0 

func NewDataStreamLifecycle() *DataStreamLifecycle

NewDataStreamLifecycle returns a DataStreamLifecycle.

func (*DataStreamLifecycle) UnmarshalJSON added in v8.8.0 

func (s *DataStreamLifecycle) UnmarshalJSON(data []byte) error

type DataStreamLifecycleDetails added in v8.16.0 

type DataStreamLifecycleDetails struct {
	StagnatingBackingIndices      []StagnatingBackingIndices `json:"stagnating_backing_indices,omitempty"`
	StagnatingBackingIndicesCount int                        `json:"stagnating_backing_indices_count"`
	TotalBackingIndicesInError    int                        `json:"total_backing_indices_in_error"`
}

DataStreamLifecycleDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L152-L156

func NewDataStreamLifecycleDetails added in v8.16.0 

func NewDataStreamLifecycleDetails() *DataStreamLifecycleDetails

NewDataStreamLifecycleDetails returns a DataStreamLifecycleDetails.

func (*DataStreamLifecycleDetails) UnmarshalJSON added in v8.16.0 

func (s *DataStreamLifecycleDetails) UnmarshalJSON(data []byte) error

type DataStreamLifecycleDownsampling added in v8.11.0 

type DataStreamLifecycleDownsampling struct {
	// Rounds The list of downsampling rounds to execute as part of this downsampling
	// configuration
	Rounds []DownsamplingRound `json:"rounds"`
}

DataStreamLifecycleDownsampling type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStreamLifecycleDownsampling.ts#L22-L27

func NewDataStreamLifecycleDownsampling added in v8.11.0 

func NewDataStreamLifecycleDownsampling() *DataStreamLifecycleDownsampling

NewDataStreamLifecycleDownsampling returns a DataStreamLifecycleDownsampling.

type DataStreamLifecycleExplain added in v8.11.0 

type DataStreamLifecycleExplain struct {
	Error                   *string                          `json:"error,omitempty"`
	GenerationTime          Duration                         `json:"generation_time,omitempty"`
	Index                   string                           `json:"index"`
	IndexCreationDateMillis *int64                           `json:"index_creation_date_millis,omitempty"`
	Lifecycle               *DataStreamLifecycleWithRollover `json:"lifecycle,omitempty"`
	ManagedByLifecycle      bool                             `json:"managed_by_lifecycle"`
	RolloverDateMillis      *int64                           `json:"rollover_date_millis,omitempty"`
	TimeSinceIndexCreation  Duration                         `json:"time_since_index_creation,omitempty"`
	TimeSinceRollover       Duration                         `json:"time_since_rollover,omitempty"`
}

DataStreamLifecycleExplain type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponse.ts#L31-L41

func NewDataStreamLifecycleExplain added in v8.11.0 

func NewDataStreamLifecycleExplain() *DataStreamLifecycleExplain

NewDataStreamLifecycleExplain returns a DataStreamLifecycleExplain.

func (*DataStreamLifecycleExplain) UnmarshalJSON added in v8.11.0 

func (s *DataStreamLifecycleExplain) UnmarshalJSON(data []byte) error

type DataStreamLifecycleIndicator added in v8.16.0 

type DataStreamLifecycleIndicator struct {
	Details   *DataStreamLifecycleDetails                 `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

DataStreamLifecycleIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L147-L151

func NewDataStreamLifecycleIndicator added in v8.16.0 

func NewDataStreamLifecycleIndicator() *DataStreamLifecycleIndicator

NewDataStreamLifecycleIndicator returns a DataStreamLifecycleIndicator.

func (*DataStreamLifecycleIndicator) UnmarshalJSON added in v8.16.0 

func (s *DataStreamLifecycleIndicator) UnmarshalJSON(data []byte) error

type DataStreamLifecycleRolloverConditions added in v8.11.0 

type DataStreamLifecycleRolloverConditions struct {
	MaxAge              *string  `json:"max_age,omitempty"`
	MaxDocs             *int64   `json:"max_docs,omitempty"`
	MaxPrimaryShardDocs *int64   `json:"max_primary_shard_docs,omitempty"`
	MaxPrimaryShardSize ByteSize `json:"max_primary_shard_size,omitempty"`
	MaxSize             ByteSize `json:"max_size,omitempty"`
	MinAge              Duration `json:"min_age,omitempty"`
	MinDocs             *int64   `json:"min_docs,omitempty"`
	MinPrimaryShardDocs *int64   `json:"min_primary_shard_docs,omitempty"`
	MinPrimaryShardSize ByteSize `json:"min_primary_shard_size,omitempty"`
	MinSize             ByteSize `json:"min_size,omitempty"`
}

DataStreamLifecycleRolloverConditions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStreamLifecycle.ts#L60-L72

func NewDataStreamLifecycleRolloverConditions added in v8.11.0 

func NewDataStreamLifecycleRolloverConditions() *DataStreamLifecycleRolloverConditions

NewDataStreamLifecycleRolloverConditions returns a DataStreamLifecycleRolloverConditions.

func (*DataStreamLifecycleRolloverConditions) UnmarshalJSON added in v8.11.0 

func (s *DataStreamLifecycleRolloverConditions) UnmarshalJSON(data []byte) error

type DataStreamLifecycleWithRollover added in v8.11.0 

type DataStreamLifecycleWithRollover struct {
	// DataRetention If defined, every document added to this data stream will be stored at least
	// for this time frame.
	// Any time after this duration the document could be deleted.
	// When empty, every document in this data stream will be stored indefinitely.
	DataRetention Duration `json:"data_retention,omitempty"`
	// Downsampling The downsampling configuration to execute for the managed backing index after
	// rollover.
	Downsampling *DataStreamLifecycleDownsampling `json:"downsampling,omitempty"`
	// Enabled If defined, it turns data stream lifecycle on/off (`true`/`false`) for this
	// data stream. A data stream lifecycle
	// that's disabled (enabled: `false`) will have no effect on the data stream.
	Enabled *bool `json:"enabled,omitempty"`
	// Rollover The conditions which will trigger the rollover of a backing index as
	// configured by the cluster setting `cluster.lifecycle.default.rollover`.
	// This property is an implementation detail and it will only be retrieved when
	// the query param `include_defaults` is set to true.
	// The contents of this field are subject to change.
	Rollover *DataStreamLifecycleRolloverConditions `json:"rollover,omitempty"`
}

DataStreamLifecycleWithRollover type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStreamLifecycle.ts#L47-L58

func NewDataStreamLifecycleWithRollover added in v8.11.0 

func NewDataStreamLifecycleWithRollover() *DataStreamLifecycleWithRollover

NewDataStreamLifecycleWithRollover returns a DataStreamLifecycleWithRollover.

func (*DataStreamLifecycleWithRollover) UnmarshalJSON added in v8.11.0 

func (s *DataStreamLifecycleWithRollover) UnmarshalJSON(data []byte) error

type DataStreamNames 

type DataStreamNames []string

DataStreamNames type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L95-L95

type DataStreamStats added in v8.18.0 

type DataStreamStats struct {
	// BackingIndicesInError The count of the backing indices for the data stream.
	BackingIndicesInError int `json:"backing_indices_in_error"`
	// BackingIndicesInTotal The count of the backing indices for the data stream that have encountered an
	// error.
	BackingIndicesInTotal int `json:"backing_indices_in_total"`
	// Name The name of the data stream.
	Name string `json:"name"`
}

DataStreamStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_data_lifecycle_stats/IndicesGetDataLifecycleStatsResponse.ts#L46-L59

func NewDataStreamStats added in v8.18.0 

func NewDataStreamStats() *DataStreamStats

NewDataStreamStats returns a DataStreamStats.

func (*DataStreamStats) UnmarshalJSON added in v8.18.0 

func (s *DataStreamStats) UnmarshalJSON(data []byte) error

type DataStreamTimestamp 

type DataStreamTimestamp struct {
	Enabled bool `json:"enabled"`
}

DataStreamTimestamp type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/TypeMapping.ts#L59-L61

func NewDataStreamTimestamp added in v8.5.0 

func NewDataStreamTimestamp() *DataStreamTimestamp

NewDataStreamTimestamp returns a DataStreamTimestamp.

func (*DataStreamTimestamp) UnmarshalJSON added in v8.7.1 

func (s *DataStreamTimestamp) UnmarshalJSON(data []byte) error

type DataStreamTimestampField 

type DataStreamTimestampField struct {
	// Name Name of the timestamp field for the data stream, which must be `@timestamp`.
	// The `@timestamp` field must be included in every document indexed to the data
	// stream.
	Name string `json:"name"`
}

DataStreamTimestampField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStream.ts#L129-L134

func NewDataStreamTimestampField added in v8.5.0 

func NewDataStreamTimestampField() *DataStreamTimestampField

NewDataStreamTimestampField returns a DataStreamTimestampField.

func (*DataStreamTimestampField) UnmarshalJSON added in v8.7.1 

func (s *DataStreamTimestampField) UnmarshalJSON(data []byte) error

type DataStreamVisibility 

type DataStreamVisibility struct {
	AllowCustomRouting *bool `json:"allow_custom_routing,omitempty"`
	Hidden             *bool `json:"hidden,omitempty"`
}

DataStreamVisibility type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStream.ts#L159-L162

func NewDataStreamVisibility added in v8.5.0 

func NewDataStreamVisibility() *DataStreamVisibility

NewDataStreamVisibility returns a DataStreamVisibility.

func (*DataStreamVisibility) UnmarshalJSON added in v8.7.1 

func (s *DataStreamVisibility) UnmarshalJSON(data []byte) error

type DataStreamWithLifecycle added in v8.11.0 

type DataStreamWithLifecycle struct {
	Lifecycle *DataStreamLifecycleWithRollover `json:"lifecycle,omitempty"`
	Name      string                           `json:"name"`
}

DataStreamWithLifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponse.ts#L27-L30

func NewDataStreamWithLifecycle added in v8.11.0 

func NewDataStreamWithLifecycle() *DataStreamWithLifecycle

NewDataStreamWithLifecycle returns a DataStreamWithLifecycle.

func (*DataStreamWithLifecycle) UnmarshalJSON added in v8.11.0 

func (s *DataStreamWithLifecycle) UnmarshalJSON(data []byte) error

type DataStreams 

type DataStreams struct {
	Available    bool  `json:"available"`
	DataStreams  int64 `json:"data_streams"`
	Enabled      bool  `json:"enabled"`
	IndicesCount int64 `json:"indices_count"`
}

DataStreams type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L78-L81

func NewDataStreams added in v8.5.0 

func NewDataStreams() *DataStreams

NewDataStreams returns a DataStreams.

func (*DataStreams) UnmarshalJSON added in v8.7.1 

func (s *DataStreams) UnmarshalJSON(data []byte) error

type DataStreamsStatsItem 

type DataStreamsStatsItem struct {
	// BackingIndices Current number of backing indices for the data stream.
	BackingIndices int `json:"backing_indices"`
	// DataStream Name of the data stream.
	DataStream string `json:"data_stream"`
	// MaximumTimestamp The data stream’s highest `@timestamp` value, converted to milliseconds since
	// the Unix epoch.
	// NOTE: This timestamp is provided as a best effort.
	// The data stream may contain `@timestamp` values higher than this if one or
	// more of the following conditions are met:
	// The stream contains closed backing indices;
	// Backing indices with a lower generation contain higher `@timestamp` values.
	MaximumTimestamp int64 `json:"maximum_timestamp"`
	// StoreSize Total size of all shards for the data stream’s backing indices.
	// This parameter is only returned if the `human` query parameter is `true`.
	StoreSize ByteSize `json:"store_size,omitempty"`
	// StoreSizeBytes Total size, in bytes, of all shards for the data stream’s backing indices.
	StoreSizeBytes int64 `json:"store_size_bytes"`
}

DataStreamsStatsItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts#L45-L65

func NewDataStreamsStatsItem added in v8.5.0 

func NewDataStreamsStatsItem() *DataStreamsStatsItem

NewDataStreamsStatsItem returns a DataStreamsStatsItem.

func (*DataStreamsStatsItem) UnmarshalJSON added in v8.7.1 

func (s *DataStreamsStatsItem) UnmarshalJSON(data []byte) error

type DataTierPhaseStatistics 

type DataTierPhaseStatistics struct {
	DocCount                    int64 `json:"doc_count"`
	IndexCount                  int64 `json:"index_count"`
	NodeCount                   int64 `json:"node_count"`
	PrimaryShardCount           int64 `json:"primary_shard_count"`
	PrimaryShardSizeAvgBytes    int64 `json:"primary_shard_size_avg_bytes"`
	PrimaryShardSizeMadBytes    int64 `json:"primary_shard_size_mad_bytes"`
	PrimaryShardSizeMedianBytes int64 `json:"primary_shard_size_median_bytes"`
	PrimarySizeBytes            int64 `json:"primary_size_bytes"`
	TotalShardCount             int64 `json:"total_shard_count"`
	TotalSizeBytes              int64 `json:"total_size_bytes"`
}

DataTierPhaseStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L83-L94

func NewDataTierPhaseStatistics added in v8.5.0 

func NewDataTierPhaseStatistics() *DataTierPhaseStatistics

NewDataTierPhaseStatistics returns a DataTierPhaseStatistics.

func (*DataTierPhaseStatistics) UnmarshalJSON added in v8.7.1 

func (s *DataTierPhaseStatistics) UnmarshalJSON(data []byte) error

type DataTiers 

type DataTiers struct {
	Available   bool                     `json:"available"`
	DataCold    DataTierPhaseStatistics  `json:"data_cold"`
	DataContent DataTierPhaseStatistics  `json:"data_content"`
	DataFrozen  *DataTierPhaseStatistics `json:"data_frozen,omitempty"`
	DataHot     DataTierPhaseStatistics  `json:"data_hot"`
	DataWarm    DataTierPhaseStatistics  `json:"data_warm"`
	Enabled     bool                     `json:"enabled"`
}

DataTiers type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L349-L359

func NewDataTiers added in v8.5.0 

func NewDataTiers() *DataTiers

NewDataTiers returns a DataTiers.

func (*DataTiers) UnmarshalJSON added in v8.7.1 

func (s *DataTiers) UnmarshalJSON(data []byte) error

type DatabaseConfiguration added in v8.16.0 

type DatabaseConfiguration struct {
	Ipinfo  *Ipinfo  `json:"ipinfo,omitempty"`
	Maxmind *Maxmind `json:"maxmind,omitempty"`
	// Name The provider-assigned name of the IP geolocation database to download.
	Name string `json:"name"`
}

DatabaseConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L22-L37

func NewDatabaseConfiguration added in v8.16.0 

func NewDatabaseConfiguration() *DatabaseConfiguration

NewDatabaseConfiguration returns a DatabaseConfiguration.

func (*DatabaseConfiguration) UnmarshalJSON added in v8.16.0 

func (s *DatabaseConfiguration) UnmarshalJSON(data []byte) error

type DatabaseConfigurationFull added in v8.18.0 

type DatabaseConfigurationFull struct {
	Ipinfo  *Ipinfo  `json:"ipinfo,omitempty"`
	Local   *Local   `json:"local,omitempty"`
	Maxmind *Maxmind `json:"maxmind,omitempty"`
	// Name The provider-assigned name of the IP geolocation database to download.
	Name string `json:"name"`
	Web  *Web   `json:"web,omitempty"`
}

DatabaseConfigurationFull type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L39-L53

func NewDatabaseConfigurationFull added in v8.18.0 

func NewDatabaseConfigurationFull() *DatabaseConfigurationFull

NewDatabaseConfigurationFull returns a DatabaseConfigurationFull.

func (*DatabaseConfigurationFull) UnmarshalJSON added in v8.18.0 

func (s *DatabaseConfigurationFull) UnmarshalJSON(data []byte) error

type DatafeedAuthorization 

type DatafeedAuthorization struct {
	// ApiKey If an API key was used for the most recent update to the datafeed, its name
	// and identifier are listed in the response.
	ApiKey *ApiKeyAuthorization `json:"api_key,omitempty"`
	// Roles If a user ID was used for the most recent update to the datafeed, its roles
	// at the time of the update are listed in the response.
	Roles []string `json:"roles,omitempty"`
	// ServiceAccount If a service account was used for the most recent update to the datafeed, the
	// account name is listed in the response.
	ServiceAccount *string `json:"service_account,omitempty"`
}

DatafeedAuthorization type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Authorization.ts#L31-L43

func NewDatafeedAuthorization added in v8.5.0 

func NewDatafeedAuthorization() *DatafeedAuthorization

NewDatafeedAuthorization returns a DatafeedAuthorization.

func (*DatafeedAuthorization) UnmarshalJSON added in v8.9.0 

func (s *DatafeedAuthorization) UnmarshalJSON(data []byte) error

type DatafeedConfig 

type DatafeedConfig struct {
	// Aggregations If set, the datafeed performs aggregation searches. Support for aggregations
	// is limited and should be used only with low cardinality data.
	Aggregations map[string]Aggregations `json:"aggregations,omitempty"`
	// ChunkingConfig Datafeeds might be required to search over long time periods, for several
	// months or years. This search is split into time chunks in order to ensure the
	// load on Elasticsearch is managed. Chunking configuration controls how the
	// size of these time chunks are calculated and is an advanced configuration
	// option.
	ChunkingConfig *ChunkingConfig `json:"chunking_config,omitempty"`
	// DatafeedId A numerical character string that uniquely identifies the datafeed. This
	// identifier can contain lowercase alphanumeric characters (a-z and 0-9),
	// hyphens, and underscores. It must start and end with alphanumeric characters.
	// The default value is the job identifier.
	DatafeedId *string `json:"datafeed_id,omitempty"`
	// DelayedDataCheckConfig Specifies whether the datafeed checks for missing data and the size of the
	// window. The datafeed can optionally search over indices that have already
	// been read in an effort to determine whether any data has subsequently been
	// added to the index. If missing data is found, it is a good indication that
	// the `query_delay` option is set too low and the data is being indexed after
	// the datafeed has passed that moment in time. This check runs only on
	// real-time datafeeds.
	DelayedDataCheckConfig *DelayedDataCheckConfig `json:"delayed_data_check_config,omitempty"`
	// Frequency The interval at which scheduled queries are made while the datafeed runs in
	// real time. The default value is either the bucket span for short bucket
	// spans, or, for longer bucket spans, a sensible fraction of the bucket span.
	// For example: `150s`. When `frequency` is shorter than the bucket span,
	// interim results for the last (partial) bucket are written then eventually
	// overwritten by the full bucket results. If the datafeed uses aggregations,
	// this value must be divisible by the interval of the date histogram
	// aggregation.
	Frequency Duration `json:"frequency,omitempty"`
	// Indices An array of index names. Wildcards are supported. If any indices are in
	// remote clusters, the machine learning nodes must have the
	// `remote_cluster_client` role.
	Indices []string `json:"indices,omitempty"`
	// IndicesOptions Specifies index expansion options that are used during search.
	IndicesOptions *IndicesOptions `json:"indices_options,omitempty"`
	JobId          *string         `json:"job_id,omitempty"`
	// MaxEmptySearches If a real-time datafeed has never seen any data (including during any initial
	// training period) then it will automatically stop itself and close its
	// associated job after this many real-time searches that return no documents.
	// In other words, it will stop after `frequency` times `max_empty_searches` of
	// real-time operation. If not set then a datafeed with no end time that sees no
	// data will remain started until it is explicitly stopped.
	MaxEmptySearches *int `json:"max_empty_searches,omitempty"`
	// Query The Elasticsearch query domain-specific language (DSL). This value
	// corresponds to the query object in an Elasticsearch search POST body. All the
	// options that are supported by Elasticsearch can be used, as this object is
	// passed verbatim to Elasticsearch.
	Query *Query `json:"query,omitempty"`
	// QueryDelay The number of seconds behind real time that data is queried. For example, if
	// data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06
	// a.m., set this property to 120 seconds. The default value is randomly
	// selected between `60s` and `120s`. This randomness improves the query
	// performance when there are multiple jobs running on the same node.
	QueryDelay Duration `json:"query_delay,omitempty"`
	// RuntimeMappings Specifies runtime fields for the datafeed search.
	RuntimeMappings RuntimeFields `json:"runtime_mappings,omitempty"`
	// ScriptFields Specifies scripts that evaluate custom expressions and returns script fields
	// to the datafeed. The detector configuration objects in a job can contain
	// functions that use these script fields.
	ScriptFields map[string]ScriptField `json:"script_fields,omitempty"`
	// ScrollSize The size parameter that is used in Elasticsearch searches when the datafeed
	// does not use aggregations. The maximum value is the value of
	// `index.max_result_window`, which is 10,000 by default.
	ScrollSize *int `json:"scroll_size,omitempty"`
}

DatafeedConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L63-L120

func NewDatafeedConfig added in v8.5.0 

func NewDatafeedConfig() *DatafeedConfig

NewDatafeedConfig returns a DatafeedConfig.

func (*DatafeedConfig) UnmarshalJSON added in v8.7.1 

func (s *DatafeedConfig) UnmarshalJSON(data []byte) error

type DatafeedRunningState 

type DatafeedRunningState struct {
	// RealTimeConfigured Indicates if the datafeed is "real-time"; meaning that the datafeed has no
	// configured `end` time.
	RealTimeConfigured bool `json:"real_time_configured"`
	// RealTimeRunning Indicates whether the datafeed has finished running on the available past
	// data.
	// For datafeeds without a configured `end` time, this means that the datafeed
	// is now running on "real-time" data.
	RealTimeRunning bool `json:"real_time_running"`
	// SearchInterval Provides the latest time interval the datafeed has searched.
	SearchInterval *RunningStateSearchInterval `json:"search_interval,omitempty"`
}

DatafeedRunningState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L210-L224

func NewDatafeedRunningState added in v8.5.0 

func NewDatafeedRunningState() *DatafeedRunningState

NewDatafeedRunningState returns a DatafeedRunningState.

func (*DatafeedRunningState) UnmarshalJSON added in v8.7.1 

func (s *DatafeedRunningState) UnmarshalJSON(data []byte) error

type DatafeedStats 

type DatafeedStats struct {
	// AssignmentExplanation For started datafeeds only, contains messages relating to the selection of a
	// node.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// DatafeedId A numerical character string that uniquely identifies the datafeed.
	// This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
	// hyphens, and underscores.
	// It must start and end with alphanumeric characters.
	DatafeedId string `json:"datafeed_id"`
	// Node For started datafeeds only, this information pertains to the node upon which
	// the datafeed is started.
	Node *DiscoveryNodeCompact `json:"node,omitempty"`
	// RunningState An object containing the running state for this datafeed.
	// It is only provided if the datafeed is started.
	RunningState *DatafeedRunningState `json:"running_state,omitempty"`
	// State The status of the datafeed, which can be one of the following values:
	// `starting`, `started`, `stopping`, `stopped`.
	State datafeedstate.DatafeedState `json:"state"`
	// TimingStats An object that provides statistical information about timing aspect of this
	// datafeed.
	TimingStats *DatafeedTimingStats `json:"timing_stats,omitempty"`
}

DatafeedStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L143-L172

func NewDatafeedStats added in v8.5.0 

func NewDatafeedStats() *DatafeedStats

NewDatafeedStats returns a DatafeedStats.

func (*DatafeedStats) UnmarshalJSON added in v8.7.1 

func (s *DatafeedStats) UnmarshalJSON(data []byte) error

type DatafeedTimingStats 

type DatafeedTimingStats struct {
	// AverageSearchTimePerBucketMs The average search time per bucket, in milliseconds.
	AverageSearchTimePerBucketMs Float64 `json:"average_search_time_per_bucket_ms,omitempty"`
	// BucketCount The number of buckets processed.
	BucketCount                          int64                                 `json:"bucket_count"`
	ExponentialAverageCalculationContext *ExponentialAverageCalculationContext `json:"exponential_average_calculation_context,omitempty"`
	// ExponentialAverageSearchTimePerHourMs The exponential average search time per hour, in milliseconds.
	ExponentialAverageSearchTimePerHourMs Float64 `json:"exponential_average_search_time_per_hour_ms"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// SearchCount The number of searches run by the datafeed.
	SearchCount int64 `json:"search_count"`
	// TotalSearchTimeMs The total time the datafeed spent searching, in milliseconds.
	TotalSearchTimeMs Float64 `json:"total_search_time_ms"`
}

DatafeedTimingStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L174-L202

func NewDatafeedTimingStats added in v8.5.0 

func NewDatafeedTimingStats() *DatafeedTimingStats

NewDatafeedTimingStats returns a DatafeedTimingStats.

func (*DatafeedTimingStats) UnmarshalJSON added in v8.7.1 

func (s *DatafeedTimingStats) UnmarshalJSON(data []byte) error

type Datafeeds 

type Datafeeds struct {
	ScrollSize int `json:"scroll_size"`
}

Datafeeds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/info/types.ts#L42-L44

func NewDatafeeds added in v8.5.0 

func NewDatafeeds() *Datafeeds

NewDatafeeds returns a Datafeeds.

func (*Datafeeds) UnmarshalJSON added in v8.7.1 

func (s *Datafeeds) UnmarshalJSON(data []byte) error

type DatafeedsRecord 

type DatafeedsRecord struct {
	// AssignmentExplanation For started datafeeds only, contains messages relating to the selection of a
	// node.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// BucketsCount The number of buckets processed.
	BucketsCount *string `json:"buckets.count,omitempty"`
	// Id The datafeed identifier.
	Id *string `json:"id,omitempty"`
	// NodeAddress The network address of the assigned node.
	// For started datafeeds only, this information pertains to the node upon which
	// the datafeed is started.
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId The ephemeral identifier of the assigned node.
	// For started datafeeds only, this information pertains to the node upon which
	// the datafeed is started.
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId The unique identifier of the assigned node.
	// For started datafeeds only, this information pertains to the node upon which
	// the datafeed is started.
	NodeId *string `json:"node.id,omitempty"`
	// NodeName The name of the assigned node.
	// For started datafeeds only, this information pertains to the node upon which
	// the datafeed is started.
	NodeName *string `json:"node.name,omitempty"`
	// SearchBucketAvg The average search time per bucket, in milliseconds.
	SearchBucketAvg *string `json:"search.bucket_avg,omitempty"`
	// SearchCount The number of searches run by the datafeed.
	SearchCount *string `json:"search.count,omitempty"`
	// SearchExpAvgHour The exponential average search time per hour, in milliseconds.
	SearchExpAvgHour *string `json:"search.exp_avg_hour,omitempty"`
	// SearchTime The total time the datafeed spent searching, in milliseconds.
	SearchTime *string `json:"search.time,omitempty"`
	// State The status of the datafeed.
	State *datafeedstate.DatafeedState `json:"state,omitempty"`
}

DatafeedsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/ml_datafeeds/types.ts#L22-L87

func NewDatafeedsRecord added in v8.5.0 

func NewDatafeedsRecord() *DatafeedsRecord

NewDatafeedsRecord returns a DatafeedsRecord.

func (*DatafeedsRecord) UnmarshalJSON added in v8.9.0 

func (s *DatafeedsRecord) UnmarshalJSON(data []byte) error

type DataframeAnalysis 

type DataframeAnalysis struct {
	// Alpha Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This parameter affects loss calculations by acting as
	// a multiplier of the tree depth. Higher alpha values result in shallower trees
	// and faster training times. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to zero.
	Alpha *Float64 `json:"alpha,omitempty"`
	// DependentVariable Defines which field of the document is to be predicted. It must match one of
	// the fields in the index being used to train. If this field is missing from a
	// document, then that document will not be used for training, but a prediction
	// with the trained model will be generated for it. It is also known as
	// continuous target variable.
	// For classification analysis, the data type of the field must be numeric
	// (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or
	// `boolean`. There must be no more than 30 different values in this field.
	// For regression analysis, the data type of the field must be numeric.
	DependentVariable string `json:"dependent_variable"`
	// DownsampleFactor Advanced configuration option. Controls the fraction of data that is used to
	// compute the derivatives of the loss function for tree training. A small value
	// results in the use of a small fraction of the data. If this value is set to
	// be less than 1, accuracy typically improves. However, too small a value may
	// result in poor convergence for the ensemble and so require more trees. By
	// default, this value is calculated during hyperparameter optimization. It must
	// be greater than zero and less than or equal to 1.
	DownsampleFactor *Float64 `json:"downsample_factor,omitempty"`
	// EarlyStoppingEnabled Advanced configuration option. Specifies whether the training process should
	// finish if it is not finding any better performing models. If disabled, the
	// training process can take significantly longer and the chance of finding a
	// better performing model is unremarkable.
	EarlyStoppingEnabled *bool `json:"early_stopping_enabled,omitempty"`
	// Eta Advanced configuration option. The shrinkage applied to the weights. Smaller
	// values result in larger forests which have a better generalization error.
	// However, larger forests cause slower training. By default, this value is
	// calculated during hyperparameter optimization. It must be a value between
	// 0.001 and 1.
	Eta *Float64 `json:"eta,omitempty"`
	// EtaGrowthRatePerTree Advanced configuration option. Specifies the rate at which `eta` increases
	// for each new tree that is added to the forest. For example, a rate of 1.05
	// increases `eta` by 5% for each extra tree. By default, this value is
	// calculated during hyperparameter optimization. It must be between 0.5 and 2.
	EtaGrowthRatePerTree *Float64 `json:"eta_growth_rate_per_tree,omitempty"`
	// FeatureBagFraction Advanced configuration option. Defines the fraction of features that will be
	// used when selecting a random bag for each candidate split. By default, this
	// value is calculated during hyperparameter optimization.
	FeatureBagFraction *Float64 `json:"feature_bag_fraction,omitempty"`
	// FeatureProcessors Advanced configuration option. A collection of feature preprocessors that
	// modify one or more included fields. The analysis uses the resulting one or
	// more features instead of the original document field. However, these features
	// are ephemeral; they are not stored in the destination index. Multiple
	// `feature_processors` entries can refer to the same document fields. Automatic
	// categorical feature encoding still occurs for the fields that are unprocessed
	// by a custom processor or that have categorical values. Use this property only
	// if you want to override the automatic feature encoding of the specified
	// fields.
	FeatureProcessors []DataframeAnalysisFeatureProcessor `json:"feature_processors,omitempty"`
	// Gamma Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies a linear penalty associated
	// with the size of individual trees in the forest. A high gamma value causes
	// training to prefer small trees. A small gamma value results in larger
	// individual trees and slower training. By default, this value is calculated
	// during hyperparameter optimization. It must be a nonnegative value.
	Gamma *Float64 `json:"gamma,omitempty"`
	// Lambda Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies an L2 regularization term
	// which applies to leaf weights of the individual trees in the forest. A high
	// lambda value causes training to favor small leaf weights. This behavior makes
	// the prediction function smoother at the expense of potentially not being able
	// to capture relevant relationships between the features and the dependent
	// variable. A small lambda value results in large individual trees and slower
	// training. By default, this value is calculated during hyperparameter
	// optimization. It must be a nonnegative value.
	Lambda *Float64 `json:"lambda,omitempty"`
	// MaxOptimizationRoundsPerHyperparameter Advanced configuration option. A multiplier responsible for determining the
	// maximum number of hyperparameter optimization steps in the Bayesian
	// optimization procedure. The maximum number of steps is determined based on
	// the number of undefined hyperparameters times the maximum optimization rounds
	// per hyperparameter. By default, this value is calculated during
	// hyperparameter optimization.
	MaxOptimizationRoundsPerHyperparameter *int `json:"max_optimization_rounds_per_hyperparameter,omitempty"`
	// MaxTrees Advanced configuration option. Defines the maximum number of decision trees
	// in the forest. The maximum value is 2000. By default, this value is
	// calculated during hyperparameter optimization.
	MaxTrees *int `json:"max_trees,omitempty"`
	// NumTopFeatureImportanceValues Advanced configuration option. Specifies the maximum number of feature
	// importance values per document to return. By default, no feature importance
	// calculation occurs.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// PredictionFieldName Defines the name of the prediction field in the results. Defaults to
	// `<dependent_variable>_prediction`.
	PredictionFieldName *string `json:"prediction_field_name,omitempty"`
	// RandomizeSeed Defines the seed for the random generator that is used to pick training data.
	// By default, it is randomly generated. Set it to a specific value to use the
	// same training data each time you start a job (assuming other related
	// parameters such as `source` and `analyzed_fields` are the same).
	RandomizeSeed *Float64 `json:"randomize_seed,omitempty"`
	// SoftTreeDepthLimit Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This soft limit combines with the
	// `soft_tree_depth_tolerance` to penalize trees that exceed the specified
	// depth; the regularized loss increases quickly beyond this depth. By default,
	// this value is calculated during hyperparameter optimization. It must be
	// greater than or equal to 0.
	SoftTreeDepthLimit *int `json:"soft_tree_depth_limit,omitempty"`
	// SoftTreeDepthTolerance Advanced configuration option. This option controls how quickly the
	// regularized loss increases when the tree depth exceeds
	// `soft_tree_depth_limit`. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to 0.01.
	SoftTreeDepthTolerance *Float64 `json:"soft_tree_depth_tolerance,omitempty"`
	// TrainingPercent Defines what percentage of the eligible documents that will be used for
	// training. Documents that are ignored by the analysis (for example those that
	// contain arrays with more than one value) won’t be included in the calculation
	// for used percentage.
	TrainingPercent Percentage `json:"training_percent,omitempty"`
}

DataframeAnalysis type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L134-L213

func NewDataframeAnalysis added in v8.5.0 

func NewDataframeAnalysis() *DataframeAnalysis

NewDataframeAnalysis returns a DataframeAnalysis.

func (*DataframeAnalysis) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysis) UnmarshalJSON(data []byte) error

type DataframeAnalysisAnalyzedFields 

type DataframeAnalysisAnalyzedFields struct {
	// Excludes An array of strings that defines the fields that will be included in the
	// analysis.
	Excludes []string `json:"excludes"`
	// Includes An array of strings that defines the fields that will be excluded from the
	// analysis. You do not need to add fields with unsupported data types to
	// excludes, these fields are excluded from the analysis automatically.
	Includes []string `json:"includes"`
}

DataframeAnalysisAnalyzedFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L238-L244

func NewDataframeAnalysisAnalyzedFields added in v8.5.0 

func NewDataframeAnalysisAnalyzedFields() *DataframeAnalysisAnalyzedFields

NewDataframeAnalysisAnalyzedFields returns a DataframeAnalysisAnalyzedFields.

func (*DataframeAnalysisAnalyzedFields) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisAnalyzedFields) UnmarshalJSON(data []byte) error

type DataframeAnalysisClassification 

type DataframeAnalysisClassification struct {
	// Alpha Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This parameter affects loss calculations by acting as
	// a multiplier of the tree depth. Higher alpha values result in shallower trees
	// and faster training times. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to zero.
	Alpha                    *Float64 `json:"alpha,omitempty"`
	ClassAssignmentObjective *string  `json:"class_assignment_objective,omitempty"`
	// DependentVariable Defines which field of the document is to be predicted. It must match one of
	// the fields in the index being used to train. If this field is missing from a
	// document, then that document will not be used for training, but a prediction
	// with the trained model will be generated for it. It is also known as
	// continuous target variable.
	// For classification analysis, the data type of the field must be numeric
	// (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or
	// `boolean`. There must be no more than 30 different values in this field.
	// For regression analysis, the data type of the field must be numeric.
	DependentVariable string `json:"dependent_variable"`
	// DownsampleFactor Advanced configuration option. Controls the fraction of data that is used to
	// compute the derivatives of the loss function for tree training. A small value
	// results in the use of a small fraction of the data. If this value is set to
	// be less than 1, accuracy typically improves. However, too small a value may
	// result in poor convergence for the ensemble and so require more trees. By
	// default, this value is calculated during hyperparameter optimization. It must
	// be greater than zero and less than or equal to 1.
	DownsampleFactor *Float64 `json:"downsample_factor,omitempty"`
	// EarlyStoppingEnabled Advanced configuration option. Specifies whether the training process should
	// finish if it is not finding any better performing models. If disabled, the
	// training process can take significantly longer and the chance of finding a
	// better performing model is unremarkable.
	EarlyStoppingEnabled *bool `json:"early_stopping_enabled,omitempty"`
	// Eta Advanced configuration option. The shrinkage applied to the weights. Smaller
	// values result in larger forests which have a better generalization error.
	// However, larger forests cause slower training. By default, this value is
	// calculated during hyperparameter optimization. It must be a value between
	// 0.001 and 1.
	Eta *Float64 `json:"eta,omitempty"`
	// EtaGrowthRatePerTree Advanced configuration option. Specifies the rate at which `eta` increases
	// for each new tree that is added to the forest. For example, a rate of 1.05
	// increases `eta` by 5% for each extra tree. By default, this value is
	// calculated during hyperparameter optimization. It must be between 0.5 and 2.
	EtaGrowthRatePerTree *Float64 `json:"eta_growth_rate_per_tree,omitempty"`
	// FeatureBagFraction Advanced configuration option. Defines the fraction of features that will be
	// used when selecting a random bag for each candidate split. By default, this
	// value is calculated during hyperparameter optimization.
	FeatureBagFraction *Float64 `json:"feature_bag_fraction,omitempty"`
	// FeatureProcessors Advanced configuration option. A collection of feature preprocessors that
	// modify one or more included fields. The analysis uses the resulting one or
	// more features instead of the original document field. However, these features
	// are ephemeral; they are not stored in the destination index. Multiple
	// `feature_processors` entries can refer to the same document fields. Automatic
	// categorical feature encoding still occurs for the fields that are unprocessed
	// by a custom processor or that have categorical values. Use this property only
	// if you want to override the automatic feature encoding of the specified
	// fields.
	FeatureProcessors []DataframeAnalysisFeatureProcessor `json:"feature_processors,omitempty"`
	// Gamma Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies a linear penalty associated
	// with the size of individual trees in the forest. A high gamma value causes
	// training to prefer small trees. A small gamma value results in larger
	// individual trees and slower training. By default, this value is calculated
	// during hyperparameter optimization. It must be a nonnegative value.
	Gamma *Float64 `json:"gamma,omitempty"`
	// Lambda Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies an L2 regularization term
	// which applies to leaf weights of the individual trees in the forest. A high
	// lambda value causes training to favor small leaf weights. This behavior makes
	// the prediction function smoother at the expense of potentially not being able
	// to capture relevant relationships between the features and the dependent
	// variable. A small lambda value results in large individual trees and slower
	// training. By default, this value is calculated during hyperparameter
	// optimization. It must be a nonnegative value.
	Lambda *Float64 `json:"lambda,omitempty"`
	// MaxOptimizationRoundsPerHyperparameter Advanced configuration option. A multiplier responsible for determining the
	// maximum number of hyperparameter optimization steps in the Bayesian
	// optimization procedure. The maximum number of steps is determined based on
	// the number of undefined hyperparameters times the maximum optimization rounds
	// per hyperparameter. By default, this value is calculated during
	// hyperparameter optimization.
	MaxOptimizationRoundsPerHyperparameter *int `json:"max_optimization_rounds_per_hyperparameter,omitempty"`
	// MaxTrees Advanced configuration option. Defines the maximum number of decision trees
	// in the forest. The maximum value is 2000. By default, this value is
	// calculated during hyperparameter optimization.
	MaxTrees *int `json:"max_trees,omitempty"`
	// NumTopClasses Defines the number of categories for which the predicted probabilities are
	// reported. It must be non-negative or -1. If it is -1 or greater than the
	// total number of categories, probabilities are reported for all categories; if
	// you have a large number of categories, there could be a significant effect on
	// the size of your destination index. NOTE: To use the AUC ROC evaluation
	// method, `num_top_classes` must be set to -1 or a value greater than or equal
	// to the total number of categories.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// NumTopFeatureImportanceValues Advanced configuration option. Specifies the maximum number of feature
	// importance values per document to return. By default, no feature importance
	// calculation occurs.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// PredictionFieldName Defines the name of the prediction field in the results. Defaults to
	// `<dependent_variable>_prediction`.
	PredictionFieldName *string `json:"prediction_field_name,omitempty"`
	// RandomizeSeed Defines the seed for the random generator that is used to pick training data.
	// By default, it is randomly generated. Set it to a specific value to use the
	// same training data each time you start a job (assuming other related
	// parameters such as `source` and `analyzed_fields` are the same).
	RandomizeSeed *Float64 `json:"randomize_seed,omitempty"`
	// SoftTreeDepthLimit Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This soft limit combines with the
	// `soft_tree_depth_tolerance` to penalize trees that exceed the specified
	// depth; the regularized loss increases quickly beyond this depth. By default,
	// this value is calculated during hyperparameter optimization. It must be
	// greater than or equal to 0.
	SoftTreeDepthLimit *int `json:"soft_tree_depth_limit,omitempty"`
	// SoftTreeDepthTolerance Advanced configuration option. This option controls how quickly the
	// regularized loss increases when the tree depth exceeds
	// `soft_tree_depth_limit`. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to 0.01.
	SoftTreeDepthTolerance *Float64 `json:"soft_tree_depth_tolerance,omitempty"`
	// TrainingPercent Defines what percentage of the eligible documents that will be used for
	// training. Documents that are ignored by the analysis (for example those that
	// contain arrays with more than one value) won’t be included in the calculation
	// for used percentage.
	TrainingPercent Percentage `json:"training_percent,omitempty"`
}

DataframeAnalysisClassification type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L227-L236

func NewDataframeAnalysisClassification added in v8.5.0 

func NewDataframeAnalysisClassification() *DataframeAnalysisClassification

NewDataframeAnalysisClassification returns a DataframeAnalysisClassification.

func (*DataframeAnalysisClassification) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisClassification) UnmarshalJSON(data []byte) error

type DataframeAnalysisContainer 

type DataframeAnalysisContainer struct {
	// Classification The configuration information necessary to perform classification.
	Classification *DataframeAnalysisClassification `json:"classification,omitempty"`
	// OutlierDetection The configuration information necessary to perform outlier detection. NOTE:
	// Advanced parameters are for fine-tuning classification analysis. They are set
	// automatically by hyperparameter optimization to give the minimum validation
	// error. It is highly recommended to use the default values unless you fully
	// understand the function of these parameters.
	OutlierDetection *DataframeAnalysisOutlierDetection `json:"outlier_detection,omitempty"`
	// Regression The configuration information necessary to perform regression. NOTE: Advanced
	// parameters are for fine-tuning regression analysis. They are set
	// automatically by hyperparameter optimization to give the minimum validation
	// error. It is highly recommended to use the default values unless you fully
	// understand the function of these parameters.
	Regression *DataframeAnalysisRegression `json:"regression,omitempty"`
}

DataframeAnalysisContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L84-L101

func NewDataframeAnalysisContainer added in v8.5.0 

func NewDataframeAnalysisContainer() *DataframeAnalysisContainer

NewDataframeAnalysisContainer returns a DataframeAnalysisContainer.

type DataframeAnalysisFeatureProcessor 

type DataframeAnalysisFeatureProcessor struct {
	// FrequencyEncoding The configuration information necessary to perform frequency encoding.
	FrequencyEncoding *DataframeAnalysisFeatureProcessorFrequencyEncoding `json:"frequency_encoding,omitempty"`
	// MultiEncoding The configuration information necessary to perform multi encoding. It allows
	// multiple processors to be changed together. This way the output of a
	// processor can then be passed to another as an input.
	MultiEncoding *DataframeAnalysisFeatureProcessorMultiEncoding `json:"multi_encoding,omitempty"`
	// NGramEncoding The configuration information necessary to perform n-gram encoding. Features
	// created by this encoder have the following name format:
	// <feature_prefix>.<ngram><string position>. For example, if the feature_prefix
	// is f, the feature name for the second unigram in a string is f.11.
	NGramEncoding *DataframeAnalysisFeatureProcessorNGramEncoding `json:"n_gram_encoding,omitempty"`
	// OneHotEncoding The configuration information necessary to perform one hot encoding.
	OneHotEncoding *DataframeAnalysisFeatureProcessorOneHotEncoding `json:"one_hot_encoding,omitempty"`
	// TargetMeanEncoding The configuration information necessary to perform target mean encoding.
	TargetMeanEncoding *DataframeAnalysisFeatureProcessorTargetMeanEncoding `json:"target_mean_encoding,omitempty"`
}

DataframeAnalysisFeatureProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L246-L258

func NewDataframeAnalysisFeatureProcessor added in v8.5.0 

func NewDataframeAnalysisFeatureProcessor() *DataframeAnalysisFeatureProcessor

NewDataframeAnalysisFeatureProcessor returns a DataframeAnalysisFeatureProcessor.

type DataframeAnalysisFeatureProcessorFrequencyEncoding 

type DataframeAnalysisFeatureProcessorFrequencyEncoding struct {
	// FeatureName The resulting feature name.
	FeatureName string `json:"feature_name"`
	Field       string `json:"field"`
	// FrequencyMap The resulting frequency map for the field value. If the field value is
	// missing from the frequency_map, the resulting value is 0.
	FrequencyMap map[string]Float64 `json:"frequency_map"`
}

DataframeAnalysisFeatureProcessorFrequencyEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L260-L267

func NewDataframeAnalysisFeatureProcessorFrequencyEncoding added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorFrequencyEncoding() *DataframeAnalysisFeatureProcessorFrequencyEncoding

NewDataframeAnalysisFeatureProcessorFrequencyEncoding returns a DataframeAnalysisFeatureProcessorFrequencyEncoding.

func (*DataframeAnalysisFeatureProcessorFrequencyEncoding) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisFeatureProcessorFrequencyEncoding) UnmarshalJSON(data []byte) error

type DataframeAnalysisFeatureProcessorMultiEncoding 

type DataframeAnalysisFeatureProcessorMultiEncoding struct {
	// Processors The ordered array of custom processors to execute. Must be more than 1.
	Processors []int `json:"processors"`
}

DataframeAnalysisFeatureProcessorMultiEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L269-L272

func NewDataframeAnalysisFeatureProcessorMultiEncoding added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorMultiEncoding() *DataframeAnalysisFeatureProcessorMultiEncoding

NewDataframeAnalysisFeatureProcessorMultiEncoding returns a DataframeAnalysisFeatureProcessorMultiEncoding.

type DataframeAnalysisFeatureProcessorNGramEncoding 

type DataframeAnalysisFeatureProcessorNGramEncoding struct {
	Custom *bool `json:"custom,omitempty"`
	// FeaturePrefix The feature name prefix. Defaults to ngram_<start>_<length>.
	FeaturePrefix *string `json:"feature_prefix,omitempty"`
	// Field The name of the text field to encode.
	Field string `json:"field"`
	// Length Specifies the length of the n-gram substring. Defaults to 50. Must be greater
	// than 0.
	Length *int `json:"length,omitempty"`
	// NGrams Specifies which n-grams to gather. It’s an array of integer values where the
	// minimum value is 1, and a maximum value is 5.
	NGrams []int `json:"n_grams"`
	// Start Specifies the zero-indexed start of the n-gram substring. Negative values are
	// allowed for encoding n-grams of string suffixes. Defaults to 0.
	Start *int `json:"start,omitempty"`
}

DataframeAnalysisFeatureProcessorNGramEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L274-L286

func NewDataframeAnalysisFeatureProcessorNGramEncoding added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorNGramEncoding() *DataframeAnalysisFeatureProcessorNGramEncoding

NewDataframeAnalysisFeatureProcessorNGramEncoding returns a DataframeAnalysisFeatureProcessorNGramEncoding.

func (*DataframeAnalysisFeatureProcessorNGramEncoding) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisFeatureProcessorNGramEncoding) UnmarshalJSON(data []byte) error

type DataframeAnalysisFeatureProcessorOneHotEncoding 

type DataframeAnalysisFeatureProcessorOneHotEncoding struct {
	// Field The name of the field to encode.
	Field string `json:"field"`
	// HotMap The one hot map mapping the field value with the column name.
	HotMap string `json:"hot_map"`
}

DataframeAnalysisFeatureProcessorOneHotEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L288-L293

func NewDataframeAnalysisFeatureProcessorOneHotEncoding added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorOneHotEncoding() *DataframeAnalysisFeatureProcessorOneHotEncoding

NewDataframeAnalysisFeatureProcessorOneHotEncoding returns a DataframeAnalysisFeatureProcessorOneHotEncoding.

func (*DataframeAnalysisFeatureProcessorOneHotEncoding) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisFeatureProcessorOneHotEncoding) UnmarshalJSON(data []byte) error

type DataframeAnalysisFeatureProcessorTargetMeanEncoding 

type DataframeAnalysisFeatureProcessorTargetMeanEncoding struct {
	// DefaultValue The default value if field value is not found in the target_map.
	DefaultValue int `json:"default_value"`
	// FeatureName The resulting feature name.
	FeatureName string `json:"feature_name"`
	// Field The name of the field to encode.
	Field string `json:"field"`
	// TargetMap The field value to target mean transition map.
	TargetMap map[string]json.RawMessage `json:"target_map"`
}

DataframeAnalysisFeatureProcessorTargetMeanEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L295-L304

func NewDataframeAnalysisFeatureProcessorTargetMeanEncoding added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorTargetMeanEncoding() *DataframeAnalysisFeatureProcessorTargetMeanEncoding

NewDataframeAnalysisFeatureProcessorTargetMeanEncoding returns a DataframeAnalysisFeatureProcessorTargetMeanEncoding.

func (*DataframeAnalysisFeatureProcessorTargetMeanEncoding) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisFeatureProcessorTargetMeanEncoding) UnmarshalJSON(data []byte) error

type DataframeAnalysisOutlierDetection 

type DataframeAnalysisOutlierDetection struct {
	// ComputeFeatureInfluence Specifies whether the feature influence calculation is enabled.
	ComputeFeatureInfluence *bool `json:"compute_feature_influence,omitempty"`
	// FeatureInfluenceThreshold The minimum outlier score that a document needs to have in order to calculate
	// its feature influence score. Value range: 0-1.
	FeatureInfluenceThreshold *Float64 `json:"feature_influence_threshold,omitempty"`
	// Method The method that outlier detection uses. Available methods are `lof`, `ldof`,
	// `distance_kth_nn`, `distance_knn`, and `ensemble`. The default value is
	// ensemble, which means that outlier detection uses an ensemble of different
	// methods and normalises and combines their individual outlier scores to obtain
	// the overall outlier score.
	Method *string `json:"method,omitempty"`
	// NNeighbors Defines the value for how many nearest neighbors each method of outlier
	// detection uses to calculate its outlier score. When the value is not set,
	// different values are used for different ensemble members. This default
	// behavior helps improve the diversity in the ensemble; only override it if you
	// are confident that the value you choose is appropriate for the data set.
	NNeighbors *int `json:"n_neighbors,omitempty"`
	// OutlierFraction The proportion of the data set that is assumed to be outlying prior to
	// outlier detection. For example, 0.05 means it is assumed that 5% of values
	// are real outliers and 95% are inliers.
	OutlierFraction *Float64 `json:"outlier_fraction,omitempty"`
	// StandardizationEnabled If true, the following operation is performed on the columns before computing
	// outlier scores: `(x_i - mean(x_i)) / sd(x_i)`.
	StandardizationEnabled *bool `json:"standardization_enabled,omitempty"`
}

DataframeAnalysisOutlierDetection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L103-L132

func NewDataframeAnalysisOutlierDetection added in v8.5.0 

func NewDataframeAnalysisOutlierDetection() *DataframeAnalysisOutlierDetection

NewDataframeAnalysisOutlierDetection returns a DataframeAnalysisOutlierDetection.

func (*DataframeAnalysisOutlierDetection) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisOutlierDetection) UnmarshalJSON(data []byte) error

type DataframeAnalysisRegression 

type DataframeAnalysisRegression struct {
	// Alpha Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This parameter affects loss calculations by acting as
	// a multiplier of the tree depth. Higher alpha values result in shallower trees
	// and faster training times. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to zero.
	Alpha *Float64 `json:"alpha,omitempty"`
	// DependentVariable Defines which field of the document is to be predicted. It must match one of
	// the fields in the index being used to train. If this field is missing from a
	// document, then that document will not be used for training, but a prediction
	// with the trained model will be generated for it. It is also known as
	// continuous target variable.
	// For classification analysis, the data type of the field must be numeric
	// (`integer`, `short`, `long`, `byte`), categorical (`ip` or `keyword`), or
	// `boolean`. There must be no more than 30 different values in this field.
	// For regression analysis, the data type of the field must be numeric.
	DependentVariable string `json:"dependent_variable"`
	// DownsampleFactor Advanced configuration option. Controls the fraction of data that is used to
	// compute the derivatives of the loss function for tree training. A small value
	// results in the use of a small fraction of the data. If this value is set to
	// be less than 1, accuracy typically improves. However, too small a value may
	// result in poor convergence for the ensemble and so require more trees. By
	// default, this value is calculated during hyperparameter optimization. It must
	// be greater than zero and less than or equal to 1.
	DownsampleFactor *Float64 `json:"downsample_factor,omitempty"`
	// EarlyStoppingEnabled Advanced configuration option. Specifies whether the training process should
	// finish if it is not finding any better performing models. If disabled, the
	// training process can take significantly longer and the chance of finding a
	// better performing model is unremarkable.
	EarlyStoppingEnabled *bool `json:"early_stopping_enabled,omitempty"`
	// Eta Advanced configuration option. The shrinkage applied to the weights. Smaller
	// values result in larger forests which have a better generalization error.
	// However, larger forests cause slower training. By default, this value is
	// calculated during hyperparameter optimization. It must be a value between
	// 0.001 and 1.
	Eta *Float64 `json:"eta,omitempty"`
	// EtaGrowthRatePerTree Advanced configuration option. Specifies the rate at which `eta` increases
	// for each new tree that is added to the forest. For example, a rate of 1.05
	// increases `eta` by 5% for each extra tree. By default, this value is
	// calculated during hyperparameter optimization. It must be between 0.5 and 2.
	EtaGrowthRatePerTree *Float64 `json:"eta_growth_rate_per_tree,omitempty"`
	// FeatureBagFraction Advanced configuration option. Defines the fraction of features that will be
	// used when selecting a random bag for each candidate split. By default, this
	// value is calculated during hyperparameter optimization.
	FeatureBagFraction *Float64 `json:"feature_bag_fraction,omitempty"`
	// FeatureProcessors Advanced configuration option. A collection of feature preprocessors that
	// modify one or more included fields. The analysis uses the resulting one or
	// more features instead of the original document field. However, these features
	// are ephemeral; they are not stored in the destination index. Multiple
	// `feature_processors` entries can refer to the same document fields. Automatic
	// categorical feature encoding still occurs for the fields that are unprocessed
	// by a custom processor or that have categorical values. Use this property only
	// if you want to override the automatic feature encoding of the specified
	// fields.
	FeatureProcessors []DataframeAnalysisFeatureProcessor `json:"feature_processors,omitempty"`
	// Gamma Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies a linear penalty associated
	// with the size of individual trees in the forest. A high gamma value causes
	// training to prefer small trees. A small gamma value results in larger
	// individual trees and slower training. By default, this value is calculated
	// during hyperparameter optimization. It must be a nonnegative value.
	Gamma *Float64 `json:"gamma,omitempty"`
	// Lambda Advanced configuration option. Regularization parameter to prevent
	// overfitting on the training data set. Multiplies an L2 regularization term
	// which applies to leaf weights of the individual trees in the forest. A high
	// lambda value causes training to favor small leaf weights. This behavior makes
	// the prediction function smoother at the expense of potentially not being able
	// to capture relevant relationships between the features and the dependent
	// variable. A small lambda value results in large individual trees and slower
	// training. By default, this value is calculated during hyperparameter
	// optimization. It must be a nonnegative value.
	Lambda *Float64 `json:"lambda,omitempty"`
	// LossFunction The loss function used during regression. Available options are `mse` (mean
	// squared error), `msle` (mean squared logarithmic error), `huber`
	// (Pseudo-Huber loss).
	LossFunction *string `json:"loss_function,omitempty"`
	// LossFunctionParameter A positive number that is used as a parameter to the `loss_function`.
	LossFunctionParameter *Float64 `json:"loss_function_parameter,omitempty"`
	// MaxOptimizationRoundsPerHyperparameter Advanced configuration option. A multiplier responsible for determining the
	// maximum number of hyperparameter optimization steps in the Bayesian
	// optimization procedure. The maximum number of steps is determined based on
	// the number of undefined hyperparameters times the maximum optimization rounds
	// per hyperparameter. By default, this value is calculated during
	// hyperparameter optimization.
	MaxOptimizationRoundsPerHyperparameter *int `json:"max_optimization_rounds_per_hyperparameter,omitempty"`
	// MaxTrees Advanced configuration option. Defines the maximum number of decision trees
	// in the forest. The maximum value is 2000. By default, this value is
	// calculated during hyperparameter optimization.
	MaxTrees *int `json:"max_trees,omitempty"`
	// NumTopFeatureImportanceValues Advanced configuration option. Specifies the maximum number of feature
	// importance values per document to return. By default, no feature importance
	// calculation occurs.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// PredictionFieldName Defines the name of the prediction field in the results. Defaults to
	// `<dependent_variable>_prediction`.
	PredictionFieldName *string `json:"prediction_field_name,omitempty"`
	// RandomizeSeed Defines the seed for the random generator that is used to pick training data.
	// By default, it is randomly generated. Set it to a specific value to use the
	// same training data each time you start a job (assuming other related
	// parameters such as `source` and `analyzed_fields` are the same).
	RandomizeSeed *Float64 `json:"randomize_seed,omitempty"`
	// SoftTreeDepthLimit Advanced configuration option. Machine learning uses loss guided tree
	// growing, which means that the decision trees grow where the regularized loss
	// decreases most quickly. This soft limit combines with the
	// `soft_tree_depth_tolerance` to penalize trees that exceed the specified
	// depth; the regularized loss increases quickly beyond this depth. By default,
	// this value is calculated during hyperparameter optimization. It must be
	// greater than or equal to 0.
	SoftTreeDepthLimit *int `json:"soft_tree_depth_limit,omitempty"`
	// SoftTreeDepthTolerance Advanced configuration option. This option controls how quickly the
	// regularized loss increases when the tree depth exceeds
	// `soft_tree_depth_limit`. By default, this value is calculated during
	// hyperparameter optimization. It must be greater than or equal to 0.01.
	SoftTreeDepthTolerance *Float64 `json:"soft_tree_depth_tolerance,omitempty"`
	// TrainingPercent Defines what percentage of the eligible documents that will be used for
	// training. Documents that are ignored by the analysis (for example those that
	// contain arrays with more than one value) won’t be included in the calculation
	// for used percentage.
	TrainingPercent Percentage `json:"training_percent,omitempty"`
}

DataframeAnalysisRegression type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L215-L225

func NewDataframeAnalysisRegression added in v8.5.0 

func NewDataframeAnalysisRegression() *DataframeAnalysisRegression

NewDataframeAnalysisRegression returns a DataframeAnalysisRegression.

func (*DataframeAnalysisRegression) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalysisRegression) UnmarshalJSON(data []byte) error

type DataframeAnalytics 

type DataframeAnalytics struct {
	// AnalysisStats An object containing information about the analysis job.
	AnalysisStats *DataframeAnalyticsStatsContainer `json:"analysis_stats,omitempty"`
	// AssignmentExplanation For running jobs only, contains messages relating to the selection of a node
	// to run the job.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// DataCounts An object that provides counts for the quantity of documents skipped, used in
	// training, or available for testing.
	DataCounts DataframeAnalyticsStatsDataCounts `json:"data_counts"`
	// Id The unique identifier of the data frame analytics job.
	Id string `json:"id"`
	// MemoryUsage An object describing memory usage of the analytics. It is present only after
	// the job is started and memory usage is reported.
	MemoryUsage DataframeAnalyticsStatsMemoryUsage `json:"memory_usage"`
	// Node Contains properties for the node that runs the job. This information is
	// available only for running jobs.
	Node *NodeAttributes `json:"node,omitempty"`
	// Progress The progress report of the data frame analytics job by phase.
	Progress []DataframeAnalyticsStatsProgress `json:"progress"`
	// State The status of the data frame analytics job, which can be one of the following
	// values: failed, started, starting, stopping, stopped.
	State dataframestate.DataframeState `json:"state"`
}

DataframeAnalytics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L325-L345

func NewDataframeAnalytics added in v8.5.0 

func NewDataframeAnalytics() *DataframeAnalytics

NewDataframeAnalytics returns a DataframeAnalytics.

func (*DataframeAnalytics) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalytics) UnmarshalJSON(data []byte) error

type DataframeAnalyticsAuthorization 

type DataframeAnalyticsAuthorization struct {
	// ApiKey If an API key was used for the most recent update to the job, its name and
	// identifier are listed in the response.
	ApiKey *ApiKeyAuthorization `json:"api_key,omitempty"`
	// Roles If a user ID was used for the most recent update to the job, its roles at the
	// time of the update are listed in the response.
	Roles []string `json:"roles,omitempty"`
	// ServiceAccount If a service account was used for the most recent update to the job, the
	// account name is listed in the response.
	ServiceAccount *string `json:"service_account,omitempty"`
}

DataframeAnalyticsAuthorization type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Authorization.ts#L45-L57

func NewDataframeAnalyticsAuthorization added in v8.5.0 

func NewDataframeAnalyticsAuthorization() *DataframeAnalyticsAuthorization

NewDataframeAnalyticsAuthorization returns a DataframeAnalyticsAuthorization.

func (*DataframeAnalyticsAuthorization) UnmarshalJSON added in v8.9.0 

func (s *DataframeAnalyticsAuthorization) UnmarshalJSON(data []byte) error

type DataframeAnalyticsDestination 

type DataframeAnalyticsDestination struct {
	// Index Defines the destination index to store the results of the data frame
	// analytics job.
	Index string `json:"index"`
	// ResultsField Defines the name of the field in which to store the results of the analysis.
	// Defaults to `ml`.
	ResultsField *string `json:"results_field,omitempty"`
}

DataframeAnalyticsDestination type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L77-L82

func NewDataframeAnalyticsDestination added in v8.5.0 

func NewDataframeAnalyticsDestination() *DataframeAnalyticsDestination

NewDataframeAnalyticsDestination returns a DataframeAnalyticsDestination.

func (*DataframeAnalyticsDestination) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsDestination) UnmarshalJSON(data []byte) error

type DataframeAnalyticsFieldSelection 

type DataframeAnalyticsFieldSelection struct {
	// FeatureType The feature type of this field for the analysis. May be categorical or
	// numerical.
	FeatureType *string `json:"feature_type,omitempty"`
	// IsIncluded Whether the field is selected to be included in the analysis.
	IsIncluded bool `json:"is_included"`
	// IsRequired Whether the field is required.
	IsRequired bool `json:"is_required"`
	// MappingTypes The mapping types of the field.
	MappingTypes []string `json:"mapping_types"`
	// Name The field name.
	Name string `json:"name"`
	// Reason The reason a field is not selected to be included in the analysis.
	Reason *string `json:"reason,omitempty"`
}

DataframeAnalyticsFieldSelection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L55-L68

func NewDataframeAnalyticsFieldSelection added in v8.5.0 

func NewDataframeAnalyticsFieldSelection() *DataframeAnalyticsFieldSelection

NewDataframeAnalyticsFieldSelection returns a DataframeAnalyticsFieldSelection.

func (*DataframeAnalyticsFieldSelection) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsFieldSelection) UnmarshalJSON(data []byte) error

type DataframeAnalyticsMemoryEstimation 

type DataframeAnalyticsMemoryEstimation struct {
	// ExpectedMemoryWithDisk Estimated memory usage under the assumption that overflowing to disk is
	// allowed during data frame analytics. expected_memory_with_disk is usually
	// smaller than expected_memory_without_disk as using disk allows to limit the
	// main memory needed to perform data frame analytics.
	ExpectedMemoryWithDisk string `json:"expected_memory_with_disk"`
	// ExpectedMemoryWithoutDisk Estimated memory usage under the assumption that the whole data frame
	// analytics should happen in memory (i.e. without overflowing to disk).
	ExpectedMemoryWithoutDisk string `json:"expected_memory_without_disk"`
}

DataframeAnalyticsMemoryEstimation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L70-L75

func NewDataframeAnalyticsMemoryEstimation added in v8.5.0 

func NewDataframeAnalyticsMemoryEstimation() *DataframeAnalyticsMemoryEstimation

NewDataframeAnalyticsMemoryEstimation returns a DataframeAnalyticsMemoryEstimation.

func (*DataframeAnalyticsMemoryEstimation) UnmarshalJSON added in v8.9.0 

func (s *DataframeAnalyticsMemoryEstimation) UnmarshalJSON(data []byte) error

type DataframeAnalyticsSource 

type DataframeAnalyticsSource struct {
	// Index Index or indices on which to perform the analysis. It can be a single index
	// or index pattern as well as an array of indices or patterns. NOTE: If your
	// source indices contain documents with the same IDs, only the document that is
	// indexed last appears in the destination index.
	Index []string `json:"index"`
	// Query The Elasticsearch query domain-specific language (DSL). This value
	// corresponds to the query object in an Elasticsearch search POST body. All the
	// options that are supported by Elasticsearch can be used, as this object is
	// passed verbatim to Elasticsearch. By default, this property has the following
	// value: {"match_all": {}}.
	Query *Query `json:"query,omitempty"`
	// RuntimeMappings Definitions of runtime fields that will become part of the mapping of the
	// destination index.
	RuntimeMappings RuntimeFields `json:"runtime_mappings,omitempty"`
	// Source_ Specify `includes` and/or `excludes patterns to select which fields will be
	// present in the destination. Fields that are excluded cannot be included in
	// the analysis.
	Source_ *DataframeAnalysisAnalyzedFields `json:"_source,omitempty"`
}

DataframeAnalyticsSource type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L39-L53

func NewDataframeAnalyticsSource added in v8.5.0 

func NewDataframeAnalyticsSource() *DataframeAnalyticsSource

NewDataframeAnalyticsSource returns a DataframeAnalyticsSource.

func (*DataframeAnalyticsSource) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsSource) UnmarshalJSON(data []byte) error

type DataframeAnalyticsStatsContainer 

type DataframeAnalyticsStatsContainer struct {
	// ClassificationStats An object containing information about the classification analysis job.
	ClassificationStats *DataframeAnalyticsStatsHyperparameters `json:"classification_stats,omitempty"`
	// OutlierDetectionStats An object containing information about the outlier detection job.
	OutlierDetectionStats *DataframeAnalyticsStatsOutlierDetection `json:"outlier_detection_stats,omitempty"`
	// RegressionStats An object containing information about the regression analysis.
	RegressionStats *DataframeAnalyticsStatsHyperparameters `json:"regression_stats,omitempty"`
}

DataframeAnalyticsStatsContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L374-L382

func NewDataframeAnalyticsStatsContainer added in v8.5.0 

func NewDataframeAnalyticsStatsContainer() *DataframeAnalyticsStatsContainer

NewDataframeAnalyticsStatsContainer returns a DataframeAnalyticsStatsContainer.

type DataframeAnalyticsStatsDataCounts 

type DataframeAnalyticsStatsDataCounts struct {
	// SkippedDocsCount The number of documents that are skipped during the analysis because they
	// contained values that are not supported by the analysis. For example, outlier
	// detection does not support missing fields so it skips documents with missing
	// fields. Likewise, all types of analysis skip documents that contain arrays
	// with more than one element.
	SkippedDocsCount int `json:"skipped_docs_count"`
	// TestDocsCount The number of documents that are not used for training the model and can be
	// used for testing.
	TestDocsCount int `json:"test_docs_count"`
	// TrainingDocsCount The number of documents that are used for training the model.
	TrainingDocsCount int `json:"training_docs_count"`
}

DataframeAnalyticsStatsDataCounts type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L365-L372

func NewDataframeAnalyticsStatsDataCounts added in v8.5.0 

func NewDataframeAnalyticsStatsDataCounts() *DataframeAnalyticsStatsDataCounts

NewDataframeAnalyticsStatsDataCounts returns a DataframeAnalyticsStatsDataCounts.

func (*DataframeAnalyticsStatsDataCounts) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsStatsDataCounts) UnmarshalJSON(data []byte) error

type DataframeAnalyticsStatsHyperparameters 

type DataframeAnalyticsStatsHyperparameters struct {
	// Hyperparameters An object containing the parameters of the classification analysis job.
	Hyperparameters Hyperparameters `json:"hyperparameters"`
	// Iteration The number of iterations on the analysis.
	Iteration int `json:"iteration"`
	// Timestamp The timestamp when the statistics were reported in milliseconds since the
	// epoch.
	Timestamp int64 `json:"timestamp"`
	// TimingStats An object containing time statistics about the data frame analytics job.
	TimingStats TimingStats `json:"timing_stats"`
	// ValidationLoss An object containing information about validation loss.
	ValidationLoss ValidationLoss `json:"validation_loss"`
}

DataframeAnalyticsStatsHyperparameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L384-L403

func NewDataframeAnalyticsStatsHyperparameters added in v8.5.0 

func NewDataframeAnalyticsStatsHyperparameters() *DataframeAnalyticsStatsHyperparameters

NewDataframeAnalyticsStatsHyperparameters returns a DataframeAnalyticsStatsHyperparameters.

func (*DataframeAnalyticsStatsHyperparameters) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsStatsHyperparameters) UnmarshalJSON(data []byte) error

type DataframeAnalyticsStatsMemoryUsage 

type DataframeAnalyticsStatsMemoryUsage struct {
	// MemoryReestimateBytes This value is present when the status is hard_limit and it is a new estimate
	// of how much memory the job needs.
	MemoryReestimateBytes *int64 `json:"memory_reestimate_bytes,omitempty"`
	// PeakUsageBytes The number of bytes used at the highest peak of memory usage.
	PeakUsageBytes int64 `json:"peak_usage_bytes"`
	// Status The memory usage status.
	Status string `json:"status"`
	// Timestamp The timestamp when memory usage was calculated.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

DataframeAnalyticsStatsMemoryUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L354-L363

func NewDataframeAnalyticsStatsMemoryUsage added in v8.5.0 

func NewDataframeAnalyticsStatsMemoryUsage() *DataframeAnalyticsStatsMemoryUsage

NewDataframeAnalyticsStatsMemoryUsage returns a DataframeAnalyticsStatsMemoryUsage.

func (*DataframeAnalyticsStatsMemoryUsage) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsStatsMemoryUsage) UnmarshalJSON(data []byte) error

type DataframeAnalyticsStatsOutlierDetection 

type DataframeAnalyticsStatsOutlierDetection struct {
	// Parameters The list of job parameters specified by the user or determined by algorithmic
	// heuristics.
	Parameters OutlierDetectionParameters `json:"parameters"`
	// Timestamp The timestamp when the statistics were reported in milliseconds since the
	// epoch.
	Timestamp int64 `json:"timestamp"`
	// TimingStats An object containing time statistics about the data frame analytics job.
	TimingStats TimingStats `json:"timing_stats"`
}

DataframeAnalyticsStatsOutlierDetection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L405-L418

func NewDataframeAnalyticsStatsOutlierDetection added in v8.5.0 

func NewDataframeAnalyticsStatsOutlierDetection() *DataframeAnalyticsStatsOutlierDetection

NewDataframeAnalyticsStatsOutlierDetection returns a DataframeAnalyticsStatsOutlierDetection.

func (*DataframeAnalyticsStatsOutlierDetection) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsStatsOutlierDetection) UnmarshalJSON(data []byte) error

type DataframeAnalyticsStatsProgress 

type DataframeAnalyticsStatsProgress struct {
	// Phase Defines the phase of the data frame analytics job.
	Phase string `json:"phase"`
	// ProgressPercent The progress that the data frame analytics job has made expressed in
	// percentage.
	ProgressPercent int `json:"progress_percent"`
}

DataframeAnalyticsStatsProgress type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L347-L352

func NewDataframeAnalyticsStatsProgress added in v8.5.0 

func NewDataframeAnalyticsStatsProgress() *DataframeAnalyticsStatsProgress

NewDataframeAnalyticsStatsProgress returns a DataframeAnalyticsStatsProgress.

func (*DataframeAnalyticsStatsProgress) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsStatsProgress) UnmarshalJSON(data []byte) error

type DataframeAnalyticsSummary 

type DataframeAnalyticsSummary struct {
	AllowLazyStart *bool                            `json:"allow_lazy_start,omitempty"`
	Analysis       DataframeAnalysisContainer       `json:"analysis"`
	AnalyzedFields *DataframeAnalysisAnalyzedFields `json:"analyzed_fields,omitempty"`
	// Authorization The security privileges that the job uses to run its queries. If Elastic
	// Stack security features were disabled at the time of the most recent update
	// to the job, this property is omitted.
	Authorization    *DataframeAnalyticsAuthorization `json:"authorization,omitempty"`
	CreateTime       *int64                           `json:"create_time,omitempty"`
	Description      *string                          `json:"description,omitempty"`
	Dest             DataframeAnalyticsDestination    `json:"dest"`
	Id               string                           `json:"id"`
	MaxNumThreads    *int                             `json:"max_num_threads,omitempty"`
	Meta_            Metadata                         `json:"_meta,omitempty"`
	ModelMemoryLimit *string                          `json:"model_memory_limit,omitempty"`
	Source           DataframeAnalyticsSource         `json:"source"`
	Version          *string                          `json:"version,omitempty"`
}

DataframeAnalyticsSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L306-L323

func NewDataframeAnalyticsSummary added in v8.5.0 

func NewDataframeAnalyticsSummary() *DataframeAnalyticsSummary

NewDataframeAnalyticsSummary returns a DataframeAnalyticsSummary.

func (*DataframeAnalyticsSummary) UnmarshalJSON added in v8.7.1 

func (s *DataframeAnalyticsSummary) UnmarshalJSON(data []byte) error

type DataframeClassificationSummary 

type DataframeClassificationSummary struct {
	// Accuracy Accuracy of predictions (per-class and overall).
	Accuracy *DataframeClassificationSummaryAccuracy `json:"accuracy,omitempty"`
	// AucRoc The AUC ROC (area under the curve of the receiver operating characteristic)
	// score and optionally the curve.
	// It is calculated for a specific class (provided as "class_name") treated as
	// positive.
	AucRoc *DataframeEvaluationSummaryAucRoc `json:"auc_roc,omitempty"`
	// MulticlassConfusionMatrix Multiclass confusion matrix.
	MulticlassConfusionMatrix *DataframeClassificationSummaryMulticlassConfusionMatrix `json:"multiclass_confusion_matrix,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision *DataframeClassificationSummaryPrecision `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall *DataframeClassificationSummaryRecall `json:"recall,omitempty"`
}

DataframeClassificationSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L44-L66

func NewDataframeClassificationSummary added in v8.5.0 

func NewDataframeClassificationSummary() *DataframeClassificationSummary

NewDataframeClassificationSummary returns a DataframeClassificationSummary.

type DataframeClassificationSummaryAccuracy 

type DataframeClassificationSummaryAccuracy struct {
	Classes         []DataframeEvaluationClass `json:"classes"`
	OverallAccuracy Float64                    `json:"overall_accuracy"`
}

DataframeClassificationSummaryAccuracy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L111-L114

func NewDataframeClassificationSummaryAccuracy added in v8.5.0 

func NewDataframeClassificationSummaryAccuracy() *DataframeClassificationSummaryAccuracy

NewDataframeClassificationSummaryAccuracy returns a DataframeClassificationSummaryAccuracy.

func (*DataframeClassificationSummaryAccuracy) UnmarshalJSON added in v8.7.1 

func (s *DataframeClassificationSummaryAccuracy) UnmarshalJSON(data []byte) error

type DataframeClassificationSummaryMulticlassConfusionMatrix 

type DataframeClassificationSummaryMulticlassConfusionMatrix struct {
	ConfusionMatrix       []ConfusionMatrixItem `json:"confusion_matrix"`
	OtherActualClassCount int                   `json:"other_actual_class_count"`
}

DataframeClassificationSummaryMulticlassConfusionMatrix type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L120-L123

func NewDataframeClassificationSummaryMulticlassConfusionMatrix added in v8.5.0 

func NewDataframeClassificationSummaryMulticlassConfusionMatrix() *DataframeClassificationSummaryMulticlassConfusionMatrix

NewDataframeClassificationSummaryMulticlassConfusionMatrix returns a DataframeClassificationSummaryMulticlassConfusionMatrix.

func (*DataframeClassificationSummaryMulticlassConfusionMatrix) UnmarshalJSON added in v8.7.1 

func (s *DataframeClassificationSummaryMulticlassConfusionMatrix) UnmarshalJSON(data []byte) error

type DataframeClassificationSummaryPrecision 

type DataframeClassificationSummaryPrecision struct {
	AvgPrecision Float64                    `json:"avg_precision"`
	Classes      []DataframeEvaluationClass `json:"classes"`
}

DataframeClassificationSummaryPrecision type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L101-L104

func NewDataframeClassificationSummaryPrecision added in v8.5.0 

func NewDataframeClassificationSummaryPrecision() *DataframeClassificationSummaryPrecision

NewDataframeClassificationSummaryPrecision returns a DataframeClassificationSummaryPrecision.

func (*DataframeClassificationSummaryPrecision) UnmarshalJSON added in v8.7.1 

func (s *DataframeClassificationSummaryPrecision) UnmarshalJSON(data []byte) error

type DataframeClassificationSummaryRecall 

type DataframeClassificationSummaryRecall struct {
	AvgRecall Float64                    `json:"avg_recall"`
	Classes   []DataframeEvaluationClass `json:"classes"`
}

DataframeClassificationSummaryRecall type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L106-L109

func NewDataframeClassificationSummaryRecall added in v8.5.0 

func NewDataframeClassificationSummaryRecall() *DataframeClassificationSummaryRecall

NewDataframeClassificationSummaryRecall returns a DataframeClassificationSummaryRecall.

func (*DataframeClassificationSummaryRecall) UnmarshalJSON added in v8.7.1 

func (s *DataframeClassificationSummaryRecall) UnmarshalJSON(data []byte) error

type DataframeEvaluationClass 

type DataframeEvaluationClass struct {
	ClassName string  `json:"class_name"`
	Value     Float64 `json:"value"`
}

DataframeEvaluationClass type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L116-L118

func NewDataframeEvaluationClass added in v8.5.0 

func NewDataframeEvaluationClass() *DataframeEvaluationClass

NewDataframeEvaluationClass returns a DataframeEvaluationClass.

func (*DataframeEvaluationClass) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationClass) UnmarshalJSON(data []byte) error

type DataframeEvaluationClassification 

type DataframeEvaluationClassification struct {
	// ActualField The field of the index which contains the ground truth. The data type of this
	// field can be boolean or integer. If the data type is integer, the value has
	// to be either 0 (false) or 1 (true).
	ActualField string `json:"actual_field"`
	// Metrics Specifies the metrics that are used for the evaluation.
	Metrics *DataframeEvaluationClassificationMetrics `json:"metrics,omitempty"`
	// PredictedField The field in the index which contains the predicted value, in other words the
	// results of the classification analysis.
	PredictedField *string `json:"predicted_field,omitempty"`
	// TopClassesField The field of the index which is an array of documents of the form {
	// "class_name": XXX, "class_probability": YYY }. This field must be defined as
	// nested in the mappings.
	TopClassesField *string `json:"top_classes_field,omitempty"`
}

DataframeEvaluationClassification type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L35-L44

func NewDataframeEvaluationClassification added in v8.5.0 

func NewDataframeEvaluationClassification() *DataframeEvaluationClassification

NewDataframeEvaluationClassification returns a DataframeEvaluationClassification.

func (*DataframeEvaluationClassification) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationClassification) UnmarshalJSON(data []byte) error

type DataframeEvaluationClassificationMetrics 

type DataframeEvaluationClassificationMetrics struct {
	// Accuracy Accuracy of predictions (per-class and overall).
	Accuracy map[string]json.RawMessage `json:"accuracy,omitempty"`
	// AucRoc The AUC ROC (area under the curve of the receiver operating characteristic)
	// score and optionally the curve. It is calculated for a specific class
	// (provided as "class_name") treated as positive.
	AucRoc *DataframeEvaluationClassificationMetricsAucRoc `json:"auc_roc,omitempty"`
	// MulticlassConfusionMatrix Multiclass confusion matrix.
	MulticlassConfusionMatrix map[string]json.RawMessage `json:"multiclass_confusion_matrix,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision map[string]json.RawMessage `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]json.RawMessage `json:"recall,omitempty"`
}

DataframeEvaluationClassificationMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L73-L78

func NewDataframeEvaluationClassificationMetrics added in v8.5.0 

func NewDataframeEvaluationClassificationMetrics() *DataframeEvaluationClassificationMetrics

NewDataframeEvaluationClassificationMetrics returns a DataframeEvaluationClassificationMetrics.

type DataframeEvaluationClassificationMetricsAucRoc 

type DataframeEvaluationClassificationMetricsAucRoc struct {
	// ClassName Name of the only class that is treated as positive during AUC ROC
	// calculation. Other classes are treated as negative ("one-vs-all" strategy).
	// All the evaluated documents must have class_name in the list of their top
	// classes.
	ClassName *string `json:"class_name,omitempty"`
	// IncludeCurve Whether or not the curve should be returned in addition to the score. Default
	// value is false.
	IncludeCurve *bool `json:"include_curve,omitempty"`
}

DataframeEvaluationClassificationMetricsAucRoc type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L85-L90

func NewDataframeEvaluationClassificationMetricsAucRoc added in v8.5.0 

func NewDataframeEvaluationClassificationMetricsAucRoc() *DataframeEvaluationClassificationMetricsAucRoc

NewDataframeEvaluationClassificationMetricsAucRoc returns a DataframeEvaluationClassificationMetricsAucRoc.

func (*DataframeEvaluationClassificationMetricsAucRoc) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationClassificationMetricsAucRoc) UnmarshalJSON(data []byte) error

type DataframeEvaluationContainer 

type DataframeEvaluationContainer struct {
	// Classification Classification evaluation evaluates the results of a classification analysis
	// which outputs a prediction that identifies to which of the classes each
	// document belongs.
	Classification *DataframeEvaluationClassification `json:"classification,omitempty"`
	// OutlierDetection Outlier detection evaluates the results of an outlier detection analysis
	// which outputs the probability that each document is an outlier.
	OutlierDetection *DataframeEvaluationOutlierDetection `json:"outlier_detection,omitempty"`
	// Regression Regression evaluation evaluates the results of a regression analysis which
	// outputs a prediction of values.
	Regression *DataframeEvaluationRegression `json:"regression,omitempty"`
}

DataframeEvaluationContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L25-L33

func NewDataframeEvaluationContainer added in v8.5.0 

func NewDataframeEvaluationContainer() *DataframeEvaluationContainer

NewDataframeEvaluationContainer returns a DataframeEvaluationContainer.

type DataframeEvaluationMetrics 

type DataframeEvaluationMetrics struct {
	// AucRoc The AUC ROC (area under the curve of the receiver operating characteristic)
	// score and optionally the curve. It is calculated for a specific class
	// (provided as "class_name") treated as positive.
	AucRoc *DataframeEvaluationClassificationMetricsAucRoc `json:"auc_roc,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision map[string]json.RawMessage `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]json.RawMessage `json:"recall,omitempty"`
}

DataframeEvaluationMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L64-L71

func NewDataframeEvaluationMetrics added in v8.5.0 

func NewDataframeEvaluationMetrics() *DataframeEvaluationMetrics

NewDataframeEvaluationMetrics returns a DataframeEvaluationMetrics.

type DataframeEvaluationOutlierDetection 

type DataframeEvaluationOutlierDetection struct {
	// ActualField The field of the index which contains the ground truth. The data type of this
	// field can be boolean or integer. If the data type is integer, the value has
	// to be either 0 (false) or 1 (true).
	ActualField string `json:"actual_field"`
	// Metrics Specifies the metrics that are used for the evaluation.
	Metrics *DataframeEvaluationOutlierDetectionMetrics `json:"metrics,omitempty"`
	// PredictedProbabilityField The field of the index that defines the probability of whether the item
	// belongs to the class in question or not. It’s the field that contains the
	// results of the analysis.
	PredictedProbabilityField string `json:"predicted_probability_field"`
}

DataframeEvaluationOutlierDetection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L46-L53

func NewDataframeEvaluationOutlierDetection added in v8.5.0 

func NewDataframeEvaluationOutlierDetection() *DataframeEvaluationOutlierDetection

NewDataframeEvaluationOutlierDetection returns a DataframeEvaluationOutlierDetection.

func (*DataframeEvaluationOutlierDetection) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationOutlierDetection) UnmarshalJSON(data []byte) error

type DataframeEvaluationOutlierDetectionMetrics 

type DataframeEvaluationOutlierDetectionMetrics struct {
	// AucRoc The AUC ROC (area under the curve of the receiver operating characteristic)
	// score and optionally the curve. It is calculated for a specific class
	// (provided as "class_name") treated as positive.
	AucRoc *DataframeEvaluationClassificationMetricsAucRoc `json:"auc_roc,omitempty"`
	// ConfusionMatrix Accuracy of predictions (per-class and overall).
	ConfusionMatrix map[string]json.RawMessage `json:"confusion_matrix,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision map[string]json.RawMessage `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]json.RawMessage `json:"recall,omitempty"`
}

DataframeEvaluationOutlierDetectionMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L80-L83

func NewDataframeEvaluationOutlierDetectionMetrics added in v8.5.0 

func NewDataframeEvaluationOutlierDetectionMetrics() *DataframeEvaluationOutlierDetectionMetrics

NewDataframeEvaluationOutlierDetectionMetrics returns a DataframeEvaluationOutlierDetectionMetrics.

type DataframeEvaluationRegression 

type DataframeEvaluationRegression struct {
	// ActualField The field of the index which contains the ground truth. The data type of this
	// field must be numerical.
	ActualField string `json:"actual_field"`
	// Metrics Specifies the metrics that are used for the evaluation. For more information
	// on mse, msle, and huber, consult the Jupyter notebook on regression loss
	// functions.
	Metrics *DataframeEvaluationRegressionMetrics `json:"metrics,omitempty"`
	// PredictedField The field in the index that contains the predicted value, in other words the
	// results of the regression analysis.
	PredictedField string `json:"predicted_field"`
}

DataframeEvaluationRegression type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L55-L62

func NewDataframeEvaluationRegression added in v8.5.0 

func NewDataframeEvaluationRegression() *DataframeEvaluationRegression

NewDataframeEvaluationRegression returns a DataframeEvaluationRegression.

func (*DataframeEvaluationRegression) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationRegression) UnmarshalJSON(data []byte) error

type DataframeEvaluationRegressionMetrics 

type DataframeEvaluationRegressionMetrics struct {
	// Huber Pseudo Huber loss function.
	Huber *DataframeEvaluationRegressionMetricsHuber `json:"huber,omitempty"`
	// Mse Average squared difference between the predicted values and the actual
	// (ground truth) value. For more information, read this wiki article.
	Mse map[string]json.RawMessage `json:"mse,omitempty"`
	// Msle Average squared difference between the logarithm of the predicted values and
	// the logarithm of the actual (ground truth) value.
	Msle *DataframeEvaluationRegressionMetricsMsle `json:"msle,omitempty"`
	// RSquared Proportion of the variance in the dependent variable that is predictable from
	// the independent variables.
	RSquared map[string]json.RawMessage `json:"r_squared,omitempty"`
}

DataframeEvaluationRegressionMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L92-L110

func NewDataframeEvaluationRegressionMetrics added in v8.5.0 

func NewDataframeEvaluationRegressionMetrics() *DataframeEvaluationRegressionMetrics

NewDataframeEvaluationRegressionMetrics returns a DataframeEvaluationRegressionMetrics.

type DataframeEvaluationRegressionMetricsHuber 

type DataframeEvaluationRegressionMetricsHuber struct {
	// Delta Approximates 1/2 (prediction - actual)2 for values much less than delta and
	// approximates a straight line with slope delta for values much larger than
	// delta. Defaults to 1. Delta needs to be greater than 0.
	Delta *Float64 `json:"delta,omitempty"`
}

DataframeEvaluationRegressionMetricsHuber type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L117-L120

func NewDataframeEvaluationRegressionMetricsHuber added in v8.5.0 

func NewDataframeEvaluationRegressionMetricsHuber() *DataframeEvaluationRegressionMetricsHuber

NewDataframeEvaluationRegressionMetricsHuber returns a DataframeEvaluationRegressionMetricsHuber.

func (*DataframeEvaluationRegressionMetricsHuber) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationRegressionMetricsHuber) UnmarshalJSON(data []byte) error

type DataframeEvaluationRegressionMetricsMsle 

type DataframeEvaluationRegressionMetricsMsle struct {
	// Offset Defines the transition point at which you switch from minimizing quadratic
	// error to minimizing quadratic log error. Defaults to 1.
	Offset *Float64 `json:"offset,omitempty"`
}

DataframeEvaluationRegressionMetricsMsle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeEvaluation.ts#L112-L115

func NewDataframeEvaluationRegressionMetricsMsle added in v8.5.0 

func NewDataframeEvaluationRegressionMetricsMsle() *DataframeEvaluationRegressionMetricsMsle

NewDataframeEvaluationRegressionMetricsMsle returns a DataframeEvaluationRegressionMetricsMsle.

func (*DataframeEvaluationRegressionMetricsMsle) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationRegressionMetricsMsle) UnmarshalJSON(data []byte) error

type DataframeEvaluationSummaryAucRoc 

type DataframeEvaluationSummaryAucRoc struct {
	Curve []DataframeEvaluationSummaryAucRocCurveItem `json:"curve,omitempty"`
	Value Float64                                     `json:"value"`
}

DataframeEvaluationSummaryAucRoc type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L91-L93

func NewDataframeEvaluationSummaryAucRoc added in v8.5.0 

func NewDataframeEvaluationSummaryAucRoc() *DataframeEvaluationSummaryAucRoc

NewDataframeEvaluationSummaryAucRoc returns a DataframeEvaluationSummaryAucRoc.

func (*DataframeEvaluationSummaryAucRoc) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationSummaryAucRoc) UnmarshalJSON(data []byte) error

type DataframeEvaluationSummaryAucRocCurveItem 

type DataframeEvaluationSummaryAucRocCurveItem struct {
	Fpr       Float64 `json:"fpr"`
	Threshold Float64 `json:"threshold"`
	Tpr       Float64 `json:"tpr"`
}

DataframeEvaluationSummaryAucRocCurveItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L95-L99

func NewDataframeEvaluationSummaryAucRocCurveItem added in v8.5.0 

func NewDataframeEvaluationSummaryAucRocCurveItem() *DataframeEvaluationSummaryAucRocCurveItem

NewDataframeEvaluationSummaryAucRocCurveItem returns a DataframeEvaluationSummaryAucRocCurveItem.

func (*DataframeEvaluationSummaryAucRocCurveItem) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationSummaryAucRocCurveItem) UnmarshalJSON(data []byte) error

type DataframeEvaluationValue 

type DataframeEvaluationValue struct {
	Value Float64 `json:"value"`
}

DataframeEvaluationValue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L87-L89

func NewDataframeEvaluationValue added in v8.5.0 

func NewDataframeEvaluationValue() *DataframeEvaluationValue

NewDataframeEvaluationValue returns a DataframeEvaluationValue.

func (*DataframeEvaluationValue) UnmarshalJSON added in v8.7.1 

func (s *DataframeEvaluationValue) UnmarshalJSON(data []byte) error

type DataframeOutlierDetectionSummary 

type DataframeOutlierDetectionSummary struct {
	// AucRoc The AUC ROC (area under the curve of the receiver operating characteristic)
	// score and optionally the curve.
	AucRoc *DataframeEvaluationSummaryAucRoc `json:"auc_roc,omitempty"`
	// ConfusionMatrix Set the different thresholds of the outlier score at where the metrics (`tp`
	// - true positive, `fp` - false positive, `tn` - true negative, `fn` - false
	// negative) are calculated.
	ConfusionMatrix map[string]ConfusionMatrixThreshold `json:"confusion_matrix,omitempty"`
	// Precision Set the different thresholds of the outlier score at where the metric is
	// calculated.
	Precision map[string]Float64 `json:"precision,omitempty"`
	// Recall Set the different thresholds of the outlier score at where the metric is
	// calculated.
	Recall map[string]Float64 `json:"recall,omitempty"`
}

DataframeOutlierDetectionSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L24-L42

func NewDataframeOutlierDetectionSummary added in v8.5.0 

func NewDataframeOutlierDetectionSummary() *DataframeOutlierDetectionSummary

NewDataframeOutlierDetectionSummary returns a DataframeOutlierDetectionSummary.

type DataframePreviewConfig 

type DataframePreviewConfig struct {
	Analysis         DataframeAnalysisContainer       `json:"analysis"`
	AnalyzedFields   *DataframeAnalysisAnalyzedFields `json:"analyzed_fields,omitempty"`
	MaxNumThreads    *int                             `json:"max_num_threads,omitempty"`
	ModelMemoryLimit *string                          `json:"model_memory_limit,omitempty"`
	Source           DataframeAnalyticsSource         `json:"source"`
}

DataframePreviewConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/preview_data_frame_analytics/types.ts#L27-L33

func NewDataframePreviewConfig added in v8.5.0 

func NewDataframePreviewConfig() *DataframePreviewConfig

NewDataframePreviewConfig returns a DataframePreviewConfig.

func (*DataframePreviewConfig) UnmarshalJSON added in v8.7.1 

func (s *DataframePreviewConfig) UnmarshalJSON(data []byte) error

type DataframeRegressionSummary 

type DataframeRegressionSummary struct {
	// Huber Pseudo Huber loss function.
	Huber *DataframeEvaluationValue `json:"huber,omitempty"`
	// Mse Average squared difference between the predicted values and the actual
	// (`ground truth`) value.
	Mse *DataframeEvaluationValue `json:"mse,omitempty"`
	// Msle Average squared difference between the logarithm of the predicted values and
	// the logarithm of the actual (`ground truth`) value.
	Msle *DataframeEvaluationValue `json:"msle,omitempty"`
	// RSquared Proportion of the variance in the dependent variable that is predictable from
	// the independent variables.
	RSquared *DataframeEvaluationValue `json:"r_squared,omitempty"`
}

DataframeRegressionSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/evaluate_data_frame/types.ts#L68-L85

func NewDataframeRegressionSummary added in v8.5.0 

func NewDataframeRegressionSummary() *DataframeRegressionSummary

NewDataframeRegressionSummary returns a DataframeRegressionSummary.

type DateDecayFunction 

type DateDecayFunction struct {
	DecayFunctionBaseDateMathDuration map[string]DecayPlacementDateMathDuration `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

DateDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L209-L209

func NewDateDecayFunction added in v8.5.0 

func NewDateDecayFunction() *DateDecayFunction

NewDateDecayFunction returns a DateDecayFunction.

func (DateDecayFunction) MarshalJSON 

func (s DateDecayFunction) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type DateDistanceFeatureQuery 

type DateDistanceFeatureQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field used to calculate distances. This field must meet the
	// following criteria:
	// be a `date`, `date_nanos` or `geo_point` field;
	// have an `index` mapping parameter value of `true`, which is the default;
	// have an `doc_values` mapping parameter value of `true`, which is the default.
	Field string `json:"field"`
	// Origin Date or point of origin used to calculate distances.
	// If the `field` value is a `date` or `date_nanos` field, the `origin` value
	// must be a date.
	// Date Math, such as `now-1h`, is supported.
	// If the field value is a `geo_point` field, the `origin` value must be a
	// geopoint.
	Origin string `json:"origin"`
	// Pivot Distance from the `origin` at which relevance scores receive half of the
	// `boost` value.
	// If the `field` value is a `date` or `date_nanos` field, the `pivot` value
	// must be a time unit, such as `1h` or `10d`. If the `field` value is a
	// `geo_point` field, the `pivot` value must be a distance unit, such as `1km`
	// or `12m`.
	Pivot      Duration `json:"pivot"`
	QueryName_ *string  `json:"_name,omitempty"`
}

DateDistanceFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L71-L74

func NewDateDistanceFeatureQuery added in v8.5.0 

func NewDateDistanceFeatureQuery() *DateDistanceFeatureQuery

NewDateDistanceFeatureQuery returns a DateDistanceFeatureQuery.

func (*DateDistanceFeatureQuery) UnmarshalJSON added in v8.7.1 

func (s *DateDistanceFeatureQuery) UnmarshalJSON(data []byte) error

type DateHistogramAggregate 

type DateHistogramAggregate struct {
	Buckets BucketsDateHistogramBucket `json:"buckets"`
	Meta    Metadata                   `json:"meta,omitempty"`
}

DateHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L383-L386

func NewDateHistogramAggregate added in v8.5.0 

func NewDateHistogramAggregate() *DateHistogramAggregate

NewDateHistogramAggregate returns a DateHistogramAggregate.

func (*DateHistogramAggregate) UnmarshalJSON added in v8.7.0 

func (s *DateHistogramAggregate) UnmarshalJSON(data []byte) error

type DateHistogramAggregation 

type DateHistogramAggregation struct {
	// CalendarInterval Calendar-aware interval.
	// Can be specified using the unit name, such as `month`, or as a single unit
	// quantity, such as `1M`.
	CalendarInterval *calendarinterval.CalendarInterval `json:"calendar_interval,omitempty"`
	// ExtendedBounds Enables extending the bounds of the histogram beyond the data itself.
	ExtendedBounds *ExtendedBoundsFieldDateMath `json:"extended_bounds,omitempty"`
	// Field The date field whose values are use to build a histogram.
	Field *string `json:"field,omitempty"`
	// FixedInterval Fixed intervals: a fixed number of SI units and never deviate, regardless of
	// where they fall on the calendar.
	FixedInterval Duration `json:"fixed_interval,omitempty"`
	// Format The date format used to format `key_as_string` in the response.
	// If no `format` is specified, the first date format specified in the field
	// mapping is used.
	Format *string `json:"format,omitempty"`
	// HardBounds Limits the histogram to specified bounds.
	HardBounds *ExtendedBoundsFieldDateMath `json:"hard_bounds,omitempty"`
	Interval   Duration                     `json:"interval,omitempty"`
	// Keyed Set to `true` to associate a unique string key with each bucket and return
	// the ranges as a hash rather than an array.
	Keyed *bool `json:"keyed,omitempty"`
	// MinDocCount Only returns buckets that have `min_doc_count` number of documents.
	// By default, all buckets between the first bucket that matches documents and
	// the last one are returned.
	MinDocCount *int `json:"min_doc_count,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing DateTime `json:"missing,omitempty"`
	// Offset Changes the start value of each bucket by the specified positive (`+`) or
	// negative offset (`-`) duration.
	Offset Duration `json:"offset,omitempty"`
	// Order The sort order of the returned buckets.
	Order  AggregateOrder             `json:"order,omitempty"`
	Params map[string]json.RawMessage `json:"params,omitempty"`
	Script *Script                    `json:"script,omitempty"`
	// TimeZone Time zone used for bucketing and rounding.
	// Defaults to Coordinated Universal Time (UTC).
	TimeZone *string `json:"time_zone,omitempty"`
}

DateHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L202-L260

func NewDateHistogramAggregation added in v8.5.0 

func NewDateHistogramAggregation() *DateHistogramAggregation

NewDateHistogramAggregation returns a DateHistogramAggregation.

func (*DateHistogramAggregation) UnmarshalJSON added in v8.7.0 

func (s *DateHistogramAggregation) UnmarshalJSON(data []byte) error

type DateHistogramBucket 

type DateHistogramBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          int64                `json:"key"`
	KeyAsString  *string              `json:"key_as_string,omitempty"`
}

DateHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L388-L391

func NewDateHistogramBucket added in v8.5.0 

func NewDateHistogramBucket() *DateHistogramBucket

NewDateHistogramBucket returns a DateHistogramBucket.

func (DateHistogramBucket) MarshalJSON 

func (s DateHistogramBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*DateHistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *DateHistogramBucket) UnmarshalJSON(data []byte) error

type DateHistogramGrouping 

type DateHistogramGrouping struct {
	// CalendarInterval The interval of time buckets to be generated when rolling up.
	CalendarInterval Duration `json:"calendar_interval,omitempty"`
	// Delay How long to wait before rolling up new documents.
	// By default, the indexer attempts to roll up all data that is available.
	// However, it is not uncommon for data to arrive out of order.
	// The indexer is unable to deal with data that arrives after a time-span has
	// been rolled up.
	// You need to specify a delay that matches the longest period of time you
	// expect out-of-order data to arrive.
	Delay Duration `json:"delay,omitempty"`
	// Field The date field that is to be rolled up.
	Field string `json:"field"`
	// FixedInterval The interval of time buckets to be generated when rolling up.
	FixedInterval Duration `json:"fixed_interval,omitempty"`
	Format        *string  `json:"format,omitempty"`
	Interval      Duration `json:"interval,omitempty"`
	// TimeZone Defines what `time_zone` the rollup documents are stored as.
	// Unlike raw data, which can shift timezones on the fly, rolled documents have
	// to be stored with a specific timezone.
	// By default, rollup documents are stored in `UTC`.
	TimeZone *string `json:"time_zone,omitempty"`
}

DateHistogramGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/_types/Groupings.ts#L42-L73

func NewDateHistogramGrouping added in v8.5.0 

func NewDateHistogramGrouping() *DateHistogramGrouping

NewDateHistogramGrouping returns a DateHistogramGrouping.

func (*DateHistogramGrouping) UnmarshalJSON added in v8.7.1 

func (s *DateHistogramGrouping) UnmarshalJSON(data []byte) error

type DateIndexNameProcessor 

type DateIndexNameProcessor struct {
	// DateFormats An array of the expected date formats for parsing dates / timestamps in the
	// document being preprocessed.
	// Can be a java time pattern or one of the following formats: ISO8601, UNIX,
	// UNIX_MS, or TAI64N.
	DateFormats []string `json:"date_formats"`
	// DateRounding How to round the date when formatting the date into the index name. Valid
	// values are:
	// `y` (year), `M` (month), `w` (week), `d` (day), `h` (hour), `m` (minute) and
	// `s` (second).
	// Supports template snippets.
	DateRounding string `json:"date_rounding"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to get the date or timestamp from.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IndexNameFormat The format to be used when printing the parsed date into the index name.
	// A valid java time pattern is expected here.
	// Supports template snippets.
	IndexNameFormat *string `json:"index_name_format,omitempty"`
	// IndexNamePrefix A prefix of the index name to be prepended before the printed date.
	// Supports template snippets.
	IndexNamePrefix *string `json:"index_name_prefix,omitempty"`
	// Locale The locale to use when parsing the date from the document being preprocessed,
	// relevant when parsing month names or week days.
	Locale *string `json:"locale,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// Timezone The timezone to use when parsing the date and when date math index supports
	// resolves expressions into concrete index names.
	Timezone *string `json:"timezone,omitempty"`
}

DateIndexNameProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L729-L767

func NewDateIndexNameProcessor added in v8.5.0 

func NewDateIndexNameProcessor() *DateIndexNameProcessor

NewDateIndexNameProcessor returns a DateIndexNameProcessor.

func (*DateIndexNameProcessor) UnmarshalJSON added in v8.7.1 

func (s *DateIndexNameProcessor) UnmarshalJSON(data []byte) error

type DateNanosProperty 

type DateNanosProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	Format          *string                        `json:"format,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           DateTime                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	PrecisionStep       *int                                             `json:"precision_step,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

DateNanosProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L89-L99

func NewDateNanosProperty added in v8.5.0 

func NewDateNanosProperty() *DateNanosProperty

NewDateNanosProperty returns a DateNanosProperty.

func (DateNanosProperty) MarshalJSON added in v8.9.0 

func (s DateNanosProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DateNanosProperty) UnmarshalJSON added in v8.7.0 

func (s *DateNanosProperty) UnmarshalJSON(data []byte) error

type DateProcessor 

type DateProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to get the date from.
	Field string `json:"field"`
	// Formats An array of the expected date formats.
	// Can be a java time pattern or one of the following formats: ISO8601, UNIX,
	// UNIX_MS, or TAI64N.
	Formats []string `json:"formats"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// Locale The locale to use when parsing the date, relevant when parsing month names or
	// week days.
	// Supports template snippets.
	Locale *string `json:"locale,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// OutputFormat The format to use when writing the date to target_field. Must be a valid
	// java time pattern.
	OutputFormat *string `json:"output_format,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that will hold the parsed date.
	TargetField *string `json:"target_field,omitempty"`
	// Timezone The timezone to use when parsing the date.
	// Supports template snippets.
	Timezone *string `json:"timezone,omitempty"`
}

DateProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L769-L802

func NewDateProcessor added in v8.5.0 

func NewDateProcessor() *DateProcessor

NewDateProcessor returns a DateProcessor.

func (*DateProcessor) UnmarshalJSON added in v8.7.1 

func (s *DateProcessor) UnmarshalJSON(data []byte) error

type DateProperty 

type DateProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fielddata       *NumericFielddata              `json:"fielddata,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	Format          *string                        `json:"format,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	Locale          *string                        `json:"locale,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           DateTime                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	PrecisionStep       *int                                             `json:"precision_step,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

DateProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L75-L87

func NewDateProperty added in v8.5.0 

func NewDateProperty() *DateProperty

NewDateProperty returns a DateProperty.

func (DateProperty) MarshalJSON added in v8.9.0 

func (s DateProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DateProperty) UnmarshalJSON added in v8.7.0 

func (s *DateProperty) UnmarshalJSON(data []byte) error

type DateRangeAggregate 

type DateRangeAggregate struct {
	Buckets BucketsRangeBucket `json:"buckets"`
	Meta    Metadata           `json:"meta,omitempty"`
}

DateRangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L609-L615

func NewDateRangeAggregate added in v8.5.0 

func NewDateRangeAggregate() *DateRangeAggregate

NewDateRangeAggregate returns a DateRangeAggregate.

func (*DateRangeAggregate) UnmarshalJSON added in v8.7.0 

func (s *DateRangeAggregate) UnmarshalJSON(data []byte) error

type DateRangeAggregation 

type DateRangeAggregation struct {
	// Field The date field whose values are use to build ranges.
	Field *string `json:"field,omitempty"`
	// Format The date format used to format `from` and `to` in the response.
	Format *string `json:"format,omitempty"`
	// Keyed Set to `true` to associate a unique string key with each bucket and returns
	// the ranges as a hash rather than an array.
	Keyed *bool `json:"keyed,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// Ranges Array of date ranges.
	Ranges []DateRangeExpression `json:"ranges,omitempty"`
	// TimeZone Time zone used to convert dates from another time zone to UTC.
	TimeZone *string `json:"time_zone,omitempty"`
}

DateRangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L281-L307

func NewDateRangeAggregation added in v8.5.0 

func NewDateRangeAggregation() *DateRangeAggregation

NewDateRangeAggregation returns a DateRangeAggregation.

func (*DateRangeAggregation) UnmarshalJSON added in v8.7.1 

func (s *DateRangeAggregation) UnmarshalJSON(data []byte) error

type DateRangeExpression 

type DateRangeExpression struct {
	// From Start of the range (inclusive).
	From FieldDateMath `json:"from,omitempty"`
	// Key Custom key to return the range with.
	Key *string `json:"key,omitempty"`
	// To End of the range (exclusive).
	To FieldDateMath `json:"to,omitempty"`
}

DateRangeExpression type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L318-L331

func NewDateRangeExpression added in v8.5.0 

func NewDateRangeExpression() *DateRangeExpression

NewDateRangeExpression returns a DateRangeExpression.

func (*DateRangeExpression) UnmarshalJSON added in v8.7.1 

func (s *DateRangeExpression) UnmarshalJSON(data []byte) error

type DateRangeProperty 

type DateRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	Format      *string                        `json:"format,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

DateRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L29-L32

func NewDateRangeProperty added in v8.5.0 

func NewDateRangeProperty() *DateRangeProperty

NewDateRangeProperty returns a DateRangeProperty.

func (DateRangeProperty) MarshalJSON added in v8.9.0 

func (s DateRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DateRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *DateRangeProperty) UnmarshalJSON(data []byte) error

type DateRangeQuery 

type DateRangeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Format Date format used to convert `date` values in the query.
	Format *string `json:"format,omitempty"`
	From   *string `json:"from,omitempty"`
	// Gt Greater than.
	Gt *string `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *string `json:"gte,omitempty"`
	// Lt Less than.
	Lt *string `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *string `json:"lte,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	// TimeZone Coordinated Universal Time (UTC) offset or IANA time zone used to convert
	// `date` values in the query to UTC.
	TimeZone *string `json:"time_zone,omitempty"`
	To       *string `json:"to,omitempty"`
}

DateRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L161-L170

func NewDateRangeQuery added in v8.5.0 

func NewDateRangeQuery() *DateRangeQuery

NewDateRangeQuery returns a DateRangeQuery.

func (*DateRangeQuery) UnmarshalJSON added in v8.7.1 

func (s *DateRangeQuery) UnmarshalJSON(data []byte) error

type DateTime 

type DateTime any

DateTime holds the union for the following types: 

string
int64

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L22-L27

type DecayFunction 

type DecayFunction any

DecayFunction holds the union for the following types: 

UntypedDecayFunction
DateDecayFunction
NumericDecayFunction
GeoDecayFunction

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L215-L224

type DecayFunctionBaseDateMathDuration added in v8.15.0 

type DecayFunctionBaseDateMathDuration struct {
	DecayFunctionBaseDateMathDuration map[string]DecayPlacementDateMathDuration `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

DecayFunctionBaseDateMathDuration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L191-L202

func NewDecayFunctionBaseDateMathDuration added in v8.15.0 

func NewDecayFunctionBaseDateMathDuration() *DecayFunctionBaseDateMathDuration

NewDecayFunctionBaseDateMathDuration returns a DecayFunctionBaseDateMathDuration.

func (DecayFunctionBaseDateMathDuration) MarshalJSON added in v8.15.0 

func (s DecayFunctionBaseDateMathDuration) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type DecayFunctionBaseGeoLocationDistance added in v8.15.0 

type DecayFunctionBaseGeoLocationDistance struct {
	DecayFunctionBaseGeoLocationDistance map[string]DecayPlacementGeoLocationDistance `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

DecayFunctionBaseGeoLocationDistance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L191-L202

func NewDecayFunctionBaseGeoLocationDistance added in v8.15.0 

func NewDecayFunctionBaseGeoLocationDistance() *DecayFunctionBaseGeoLocationDistance

NewDecayFunctionBaseGeoLocationDistance returns a DecayFunctionBaseGeoLocationDistance.

func (DecayFunctionBaseGeoLocationDistance) MarshalJSON added in v8.15.0 

func (s DecayFunctionBaseGeoLocationDistance) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type DecayFunctionBasedoubledouble added in v8.15.0 

type DecayFunctionBasedoubledouble struct {
	DecayFunctionBasedoubledouble map[string]DecayPlacementdoubledouble `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

DecayFunctionBasedoubledouble type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L191-L202

func NewDecayFunctionBasedoubledouble added in v8.15.0 

func NewDecayFunctionBasedoubledouble() *DecayFunctionBasedoubledouble

NewDecayFunctionBasedoubledouble returns a DecayFunctionBasedoubledouble.

func (DecayFunctionBasedoubledouble) MarshalJSON added in v8.15.0 

func (s DecayFunctionBasedoubledouble) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type DecayPlacement added in v8.15.0 

type DecayPlacement struct {
	// Decay Defines how documents are scored at the distance given at scale.
	Decay *Float64 `json:"decay,omitempty"`
	// Offset If defined, the decay function will only compute the decay function for
	// documents with a distance greater than the defined `offset`.
	Offset json.RawMessage `json:"offset,omitempty"`
	// Origin The point of origin used for calculating distance. Must be given as a number
	// for numeric field, date for date fields and geo point for geo fields.
	Origin json.RawMessage `json:"origin,omitempty"`
	// Scale Defines the distance from origin + offset at which the computed score will
	// equal `decay` parameter.
	Scale json.RawMessage `json:"scale,omitempty"`
}

DecayPlacement type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L170-L189

func NewDecayPlacement added in v8.15.0 

func NewDecayPlacement() *DecayPlacement

NewDecayPlacement returns a DecayPlacement.

func (*DecayPlacement) UnmarshalJSON added in v8.15.0 

func (s *DecayPlacement) UnmarshalJSON(data []byte) error

type DecayPlacementDateMathDuration 

type DecayPlacementDateMathDuration struct {
	// Decay Defines how documents are scored at the distance given at scale.
	Decay *Float64 `json:"decay,omitempty"`
	// Offset If defined, the decay function will only compute the decay function for
	// documents with a distance greater than the defined `offset`.
	Offset Duration `json:"offset,omitempty"`
	// Origin The point of origin used for calculating distance. Must be given as a number
	// for numeric field, date for date fields and geo point for geo fields.
	Origin *string `json:"origin,omitempty"`
	// Scale Defines the distance from origin + offset at which the computed score will
	// equal `decay` parameter.
	Scale Duration `json:"scale,omitempty"`
}

DecayPlacementDateMathDuration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L170-L189

func NewDecayPlacementDateMathDuration added in v8.5.0 

func NewDecayPlacementDateMathDuration() *DecayPlacementDateMathDuration

NewDecayPlacementDateMathDuration returns a DecayPlacementDateMathDuration.

func (*DecayPlacementDateMathDuration) UnmarshalJSON added in v8.7.1 

func (s *DecayPlacementDateMathDuration) UnmarshalJSON(data []byte) error

type DecayPlacementGeoLocationDistance 

type DecayPlacementGeoLocationDistance struct {
	// Decay Defines how documents are scored at the distance given at scale.
	Decay *Float64 `json:"decay,omitempty"`
	// Offset If defined, the decay function will only compute the decay function for
	// documents with a distance greater than the defined `offset`.
	Offset *string `json:"offset,omitempty"`
	// Origin The point of origin used for calculating distance. Must be given as a number
	// for numeric field, date for date fields and geo point for geo fields.
	Origin GeoLocation `json:"origin,omitempty"`
	// Scale Defines the distance from origin + offset at which the computed score will
	// equal `decay` parameter.
	Scale *string `json:"scale,omitempty"`
}

DecayPlacementGeoLocationDistance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L170-L189

func NewDecayPlacementGeoLocationDistance added in v8.5.0 

func NewDecayPlacementGeoLocationDistance() *DecayPlacementGeoLocationDistance

NewDecayPlacementGeoLocationDistance returns a DecayPlacementGeoLocationDistance.

func (*DecayPlacementGeoLocationDistance) UnmarshalJSON added in v8.7.1 

func (s *DecayPlacementGeoLocationDistance) UnmarshalJSON(data []byte) error

type DecayPlacementdoubledouble 

type DecayPlacementdoubledouble struct {
	// Decay Defines how documents are scored at the distance given at scale.
	Decay *Float64 `json:"decay,omitempty"`
	// Offset If defined, the decay function will only compute the decay function for
	// documents with a distance greater than the defined `offset`.
	Offset *Float64 `json:"offset,omitempty"`
	// Origin The point of origin used for calculating distance. Must be given as a number
	// for numeric field, date for date fields and geo point for geo fields.
	Origin *Float64 `json:"origin,omitempty"`
	// Scale Defines the distance from origin + offset at which the computed score will
	// equal `decay` parameter.
	Scale *Float64 `json:"scale,omitempty"`
}

DecayPlacementdoubledouble type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L170-L189

func NewDecayPlacementdoubledouble added in v8.5.0 

func NewDecayPlacementdoubledouble() *DecayPlacementdoubledouble

NewDecayPlacementdoubledouble returns a DecayPlacementdoubledouble.

func (*DecayPlacementdoubledouble) UnmarshalJSON added in v8.7.1 

func (s *DecayPlacementdoubledouble) UnmarshalJSON(data []byte) error

type DecimalDigitTokenFilter added in v8.18.1 

type DecimalDigitTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

DecimalDigitTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L481-L483

func NewDecimalDigitTokenFilter added in v8.18.1 

func NewDecimalDigitTokenFilter() *DecimalDigitTokenFilter

NewDecimalDigitTokenFilter returns a DecimalDigitTokenFilter.

func (DecimalDigitTokenFilter) MarshalJSON added in v8.18.1 

func (s DecimalDigitTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DecimalDigitTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *DecimalDigitTokenFilter) UnmarshalJSON(data []byte) error

type Defaults 

type Defaults struct {
	AnomalyDetectors AnomalyDetectors `json:"anomaly_detectors"`
	Datafeeds        Datafeeds        `json:"datafeeds"`
}

Defaults type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/info/types.ts#L24-L27

func NewDefaults added in v8.5.0 

func NewDefaults() *Defaults

NewDefaults returns a Defaults.

type Definition 

type Definition struct {
	// Preprocessors Collection of preprocessors
	Preprocessors []Preprocessor `json:"preprocessors,omitempty"`
	// TrainedModel The definition of the trained model.
	TrainedModel TrainedModel `json:"trained_model"`
}

Definition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L24-L29

func NewDefinition added in v8.5.0 

func NewDefinition() *Definition

NewDefinition returns a Definition.

type DelayedDataCheckConfig 

type DelayedDataCheckConfig struct {
	// CheckWindow The window of time that is searched for late data. This window of time ends
	// with the latest finalized bucket.
	// It defaults to null, which causes an appropriate `check_window` to be
	// calculated when the real-time datafeed runs.
	// In particular, the default `check_window` span calculation is based on the
	// maximum of `2h` or `8 * bucket_span`.
	CheckWindow Duration `json:"check_window,omitempty"`
	// Enabled Specifies whether the datafeed periodically checks for delayed data.
	Enabled bool `json:"enabled"`
}

DelayedDataCheckConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L122-L133

func NewDelayedDataCheckConfig added in v8.5.0 

func NewDelayedDataCheckConfig() *DelayedDataCheckConfig

NewDelayedDataCheckConfig returns a DelayedDataCheckConfig.

func (*DelayedDataCheckConfig) UnmarshalJSON added in v8.7.1 

func (s *DelayedDataCheckConfig) UnmarshalJSON(data []byte) error

type DeleteAction added in v8.15.0 

type DeleteAction struct {
	DeleteSearchableSnapshot *bool `json:"delete_searchable_snapshot,omitempty"`
}

DeleteAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L149-L151

func NewDeleteAction added in v8.15.0 

func NewDeleteAction() *DeleteAction

NewDeleteAction returns a DeleteAction.

func (*DeleteAction) UnmarshalJSON added in v8.15.0 

func (s *DeleteAction) UnmarshalJSON(data []byte) error

type DeleteInferenceEndpointResult added in v8.15.0 

type DeleteInferenceEndpointResult struct {
	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool     `json:"acknowledged"`
	Pipelines    []string `json:"pipelines"`
}

DeleteInferenceEndpointResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L109-L114

func NewDeleteInferenceEndpointResult added in v8.15.0 

func NewDeleteInferenceEndpointResult() *DeleteInferenceEndpointResult

NewDeleteInferenceEndpointResult returns a DeleteInferenceEndpointResult.

func (*DeleteInferenceEndpointResult) UnmarshalJSON added in v8.15.0 

func (s *DeleteInferenceEndpointResult) UnmarshalJSON(data []byte) error

type DeleteOperation added in v8.9.0 

type DeleteOperation struct {
	// Id_ The document ID.
	Id_           *string `json:"_id,omitempty"`
	IfPrimaryTerm *int64  `json:"if_primary_term,omitempty"`
	IfSeqNo       *int64  `json:"if_seq_no,omitempty"`
	// Index_ The name of the index or index alias to perform the action on.
	Index_ *string `json:"_index,omitempty"`
	// Routing A custom value used to route operations to a specific shard.
	Routing     *string                  `json:"routing,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

DeleteOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L144-L144

func NewDeleteOperation added in v8.9.0 

func NewDeleteOperation() *DeleteOperation

NewDeleteOperation returns a DeleteOperation.

func (*DeleteOperation) UnmarshalJSON added in v8.9.0 

func (s *DeleteOperation) UnmarshalJSON(data []byte) error

type DelimitedPayloadTokenFilter 

type DelimitedPayloadTokenFilter struct {
	// Delimiter Character used to separate tokens from payloads. Defaults to `|`.
	Delimiter *string `json:"delimiter,omitempty"`
	// Encoding Data type for the stored payload.
	Encoding *delimitedpayloadencoding.DelimitedPayloadEncoding `json:"encoding,omitempty"`
	Type     string                                             `json:"type,omitempty"`
	Version  *string                                            `json:"version,omitempty"`
}

DelimitedPayloadTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L84-L90

func NewDelimitedPayloadTokenFilter added in v8.5.0 

func NewDelimitedPayloadTokenFilter() *DelimitedPayloadTokenFilter

NewDelimitedPayloadTokenFilter returns a DelimitedPayloadTokenFilter.

func (DelimitedPayloadTokenFilter) MarshalJSON added in v8.9.0 

func (s DelimitedPayloadTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DelimitedPayloadTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *DelimitedPayloadTokenFilter) UnmarshalJSON(data []byte) error

type DenseVectorIndexOptions 

type DenseVectorIndexOptions struct {
	// ConfidenceInterval The confidence interval to use when quantizing the vectors. Can be any value
	// between and including `0.90` and
	// `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic
	// quantiles should be calculated for
	// optimized quantization. When between `0.90` and `1.0`, this value restricts
	// the values used when calculating
	// the quantization thresholds.
	//
	// For example, a value of `0.95` will only use the middle `95%` of the values
	// when calculating the quantization
	// thresholds (e.g. the highest and lowest `2.5%` of values will be ignored).
	//
	// Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4`
	// for dynamic quantile calculation.
	//
	// Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat`
	// index types.
	ConfidenceInterval *float32 `json:"confidence_interval,omitempty"`
	// EfConstruction The number of candidates to track while assembling the list of nearest
	// neighbors for each new node.
	//
	// Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index
	// types.
	EfConstruction *int `json:"ef_construction,omitempty"`
	// M The number of neighbors each node will be connected to in the HNSW graph.
	//
	// Only applicable to `hnsw`, `int8_hnsw`, `bbq_hnsw`, and `int4_hnsw` index
	// types.
	M *int `json:"m,omitempty"`
	// Type The type of kNN algorithm to use.
	Type densevectorindexoptionstype.DenseVectorIndexOptionsType `json:"type"`
}

DenseVectorIndexOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/DenseVectorProperty.ts#L129-L162

func NewDenseVectorIndexOptions added in v8.5.0 

func NewDenseVectorIndexOptions() *DenseVectorIndexOptions

NewDenseVectorIndexOptions returns a DenseVectorIndexOptions.

func (*DenseVectorIndexOptions) UnmarshalJSON added in v8.7.1 

func (s *DenseVectorIndexOptions) UnmarshalJSON(data []byte) error

type DenseVectorProperty 

type DenseVectorProperty struct {
	// Dims Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified,
	// it will be set to the length of
	// the first vector added to the field.
	Dims    *int                           `json:"dims,omitempty"`
	Dynamic *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	// ElementType The data type used to encode vectors. The supported data types are `float`
	// (default), `byte`, and `bit`.
	ElementType *densevectorelementtype.DenseVectorElementType `json:"element_type,omitempty"`
	Fields      map[string]Property                            `json:"fields,omitempty"`
	IgnoreAbove *int                                           `json:"ignore_above,omitempty"`
	// Index If `true`, you can search this field using the kNN search API.
	Index *bool `json:"index,omitempty"`
	// IndexOptions An optional section that configures the kNN indexing algorithm. The HNSW
	// algorithm has two internal parameters
	// that influence how the data structure is built. These can be adjusted to
	// improve the accuracy of results, at the
	// expense of slower indexing speed.
	//
	// This parameter can only be specified when `index` is `true`.
	IndexOptions *DenseVectorIndexOptions `json:"index_options,omitempty"`
	// Meta Metadata about the field.
	Meta       map[string]string   `json:"meta,omitempty"`
	Properties map[string]Property `json:"properties,omitempty"`
	// Similarity The vector similarity metric to use in kNN search.
	//
	// Documents are ranked by their vector field's similarity to the query vector.
	// The `_score` of each document will
	// be derived from the similarity, in a way that ensures scores are positive and
	// that a larger score corresponds
	// to a higher ranking.
	//
	// Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to
	// `cosine`.
	//
	// `bit` vectors only support `l2_norm` as their similarity metric.
	//
	// This parameter can only be specified when `index` is `true`.
	Similarity          *densevectorsimilarity.DenseVectorSimilarity     `json:"similarity,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

DenseVectorProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/DenseVectorProperty.ts#L23-L62

func NewDenseVectorProperty added in v8.5.0 

func NewDenseVectorProperty() *DenseVectorProperty

NewDenseVectorProperty returns a DenseVectorProperty.

func (DenseVectorProperty) MarshalJSON added in v8.9.0 

func (s DenseVectorProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DenseVectorProperty) UnmarshalJSON added in v8.7.0 

func (s *DenseVectorProperty) UnmarshalJSON(data []byte) error

type Dependency added in v8.15.0 

type Dependency struct {
	Field string      `json:"field"`
	Value ScalarValue `json:"value"`
}

Dependency type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L30-L33

func NewDependency added in v8.15.0 

func NewDependency() *Dependency

NewDependency returns a Dependency.

func (*Dependency) UnmarshalJSON added in v8.15.0 

func (s *Dependency) UnmarshalJSON(data []byte) error

type Deprecation 

type Deprecation struct {
	// Details Optional details about the deprecation warning.
	Details *string `json:"details,omitempty"`
	// Level The level property describes the significance of the issue.
	Level deprecationlevel.DeprecationLevel `json:"level"`
	// Message Descriptive information about the deprecation warning.
	Message                     string                     `json:"message"`
	Meta_                       map[string]json.RawMessage `json:"_meta,omitempty"`
	ResolveDuringRollingUpgrade bool                       `json:"resolve_during_rolling_upgrade"`
	// Url A link to the breaking change documentation, where you can find more
	// information about this change.
	Url string `json:"url"`
}

Deprecation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/migration/deprecations/types.ts#L32-L47

func NewDeprecation added in v8.5.0 

func NewDeprecation() *Deprecation

NewDeprecation returns a Deprecation.

func (*Deprecation) UnmarshalJSON added in v8.9.0 

func (s *Deprecation) UnmarshalJSON(data []byte) error

type DeprecationIndexing 

type DeprecationIndexing struct {
	Enabled string `json:"enabled"`
}

DeprecationIndexing type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L144-L146

func NewDeprecationIndexing added in v8.5.0 

func NewDeprecationIndexing() *DeprecationIndexing

NewDeprecationIndexing returns a DeprecationIndexing.

func (*DeprecationIndexing) UnmarshalJSON added in v8.7.1 

func (s *DeprecationIndexing) UnmarshalJSON(data []byte) error

type DerivativeAggregate 

type DerivativeAggregate struct {
	Meta                    Metadata `json:"meta,omitempty"`
	NormalizedValue         *Float64 `json:"normalized_value,omitempty"`
	NormalizedValueAsString *string  `json:"normalized_value_as_string,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

DerivativeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L241-L248

func NewDerivativeAggregate added in v8.5.0 

func NewDerivativeAggregate() *DerivativeAggregate

NewDerivativeAggregate returns a DerivativeAggregate.

func (*DerivativeAggregate) UnmarshalJSON added in v8.7.1 

func (s *DerivativeAggregate) UnmarshalJSON(data []byte) error

type DerivativeAggregation 

type DerivativeAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

DerivativeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L216-L216

func NewDerivativeAggregation added in v8.5.0 

func NewDerivativeAggregation() *DerivativeAggregation

NewDerivativeAggregation returns a DerivativeAggregation.

func (*DerivativeAggregation) UnmarshalJSON added in v8.7.0 

func (s *DerivativeAggregation) UnmarshalJSON(data []byte) error

type DetailsInfo added in v8.18.0 

type DetailsInfo struct {
	// Blob A description of the blob that was written and read.
	Blob BlobDetails `json:"blob"`
	// OverwriteElapsed The elapsed time spent overwriting the blob.
	// If the blob was not overwritten, this information is omitted.
	OverwriteElapsed Duration `json:"overwrite_elapsed,omitempty"`
	// OverwriteElapsedNanos The elapsed time spent overwriting the blob, in nanoseconds.
	// If the blob was not overwritten, this information is omitted.
	OverwriteElapsedNanos *int64 `json:"overwrite_elapsed_nanos,omitempty"`
	// WriteElapsed The elapsed time spent writing the blob.
	WriteElapsed Duration `json:"write_elapsed"`
	// WriteElapsedNanos The elapsed time spent writing the blob, in nanoseconds.
	WriteElapsedNanos int64 `json:"write_elapsed_nanos"`
	// WriteThrottled The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or
	// `indices.recovery.max_bytes_per_sec` if the recovery settings for managed
	// services are set) throttle while writing the blob.
	WriteThrottled Duration `json:"write_throttled"`
	// WriteThrottledNanos The length of time spent waiting for the `max_snapshot_bytes_per_sec` (or
	// `indices.recovery.max_bytes_per_sec` if the recovery settings for managed
	// services are set) throttle while writing the blob, in nanoseconds.
	WriteThrottledNanos int64 `json:"write_throttled_nanos"`
	// WriterNode The node which wrote the blob and coordinated the read operations.
	WriterNode SnapshotNodeInfo `json:"writer_node"`
}

DetailsInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L286-L321

func NewDetailsInfo added in v8.18.0 

func NewDetailsInfo() *DetailsInfo

NewDetailsInfo returns a DetailsInfo.

func (*DetailsInfo) UnmarshalJSON added in v8.18.0 

func (s *DetailsInfo) UnmarshalJSON(data []byte) error

type DetectionRule 

type DetectionRule struct {
	// Actions The set of actions to be triggered when the rule applies. If more than one
	// action is specified the effects of all actions are combined.
	Actions []ruleaction.RuleAction `json:"actions,omitempty"`
	// Conditions An array of numeric conditions when the rule applies. A rule must either have
	// a non-empty scope or at least one condition. Multiple conditions are combined
	// together with a logical AND.
	Conditions []RuleCondition `json:"conditions,omitempty"`
	// Scope A scope of series where the rule applies. A rule must either have a non-empty
	// scope or at least one condition. By default, the scope includes all series.
	// Scoping is allowed for any of the fields that are also specified in
	// `by_field_name`, `over_field_name`, or `partition_field_name`.
	Scope map[string]FilterRef `json:"scope,omitempty"`
}

DetectionRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Rule.ts#L25-L39

func NewDetectionRule added in v8.5.0 

func NewDetectionRule() *DetectionRule

NewDetectionRule returns a DetectionRule.

type Detector 

type Detector struct {
	// ByFieldName The field used to split the data. In particular, this property is used for
	// analyzing the splits with respect to their own history. It is used for
	// finding unusual values in the context of the split.
	ByFieldName *string `json:"by_field_name,omitempty"`
	// CustomRules Custom rules enable you to customize the way detectors operate. For example,
	// a rule may dictate conditions under which results should be skipped. Kibana
	// refers to custom rules as job rules.
	CustomRules []DetectionRule `json:"custom_rules,omitempty"`
	// DetectorDescription A description of the detector.
	DetectorDescription *string `json:"detector_description,omitempty"`
	// DetectorIndex A unique identifier for the detector. This identifier is based on the order
	// of the detectors in the `analysis_config`, starting at zero. If you specify a
	// value for this property, it is ignored.
	DetectorIndex *int `json:"detector_index,omitempty"`
	// ExcludeFrequent If set, frequent entities are excluded from influencing the anomaly results.
	// Entities can be considered frequent over time or frequent in a population. If
	// you are working with both over and by fields, you can set `exclude_frequent`
	// to `all` for both fields, or to `by` or `over` for those specific fields.
	ExcludeFrequent *excludefrequent.ExcludeFrequent `json:"exclude_frequent,omitempty"`
	// FieldName The field that the detector uses in the function. If you use an event rate
	// function such as count or rare, do not specify this field. The `field_name`
	// cannot contain double quotes or backslashes.
	FieldName *string `json:"field_name,omitempty"`
	// Function The analysis function that is used. For example, `count`, `rare`, `mean`,
	// `min`, `max`, or `sum`.
	Function *string `json:"function,omitempty"`
	// OverFieldName The field used to split the data. In particular, this property is used for
	// analyzing the splits with respect to the history of all splits. It is used
	// for finding unusual values in the population of all splits.
	OverFieldName *string `json:"over_field_name,omitempty"`
	// PartitionFieldName The field used to segment the analysis. When you use this property, you have
	// completely independent baselines for each value of this field.
	PartitionFieldName *string `json:"partition_field_name,omitempty"`
	// UseNull Defines whether a new series is used as the null series when there is no
	// value for the by or partition fields.
	UseNull *bool `json:"use_null,omitempty"`
}

Detector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Detector.ts#L25-L67

func NewDetector added in v8.5.0 

func NewDetector() *Detector

NewDetector returns a Detector.

func (*Detector) UnmarshalJSON added in v8.7.1 

func (s *Detector) UnmarshalJSON(data []byte) error

type DetectorRead 

type DetectorRead struct {
	// ByFieldName The field used to split the data.
	// In particular, this property is used for analyzing the splits with respect to
	// their own history.
	// It is used for finding unusual values in the context of the split.
	ByFieldName *string `json:"by_field_name,omitempty"`
	// CustomRules An array of custom rule objects, which enable you to customize the way
	// detectors operate.
	// For example, a rule may dictate to the detector conditions under which
	// results should be skipped.
	// Kibana refers to custom rules as job rules.
	CustomRules []DetectionRule `json:"custom_rules,omitempty"`
	// DetectorDescription A description of the detector.
	DetectorDescription *string `json:"detector_description,omitempty"`
	// DetectorIndex A unique identifier for the detector.
	// This identifier is based on the order of the detectors in the
	// `analysis_config`, starting at zero.
	DetectorIndex *int `json:"detector_index,omitempty"`
	// ExcludeFrequent Contains one of the following values: `all`, `none`, `by`, or `over`.
	// If set, frequent entities are excluded from influencing the anomaly results.
	// Entities can be considered frequent over time or frequent in a population.
	// If you are working with both over and by fields, then you can set
	// `exclude_frequent` to all for both fields, or to `by` or `over` for those
	// specific fields.
	ExcludeFrequent *excludefrequent.ExcludeFrequent `json:"exclude_frequent,omitempty"`
	// FieldName The field that the detector uses in the function.
	// If you use an event rate function such as `count` or `rare`, do not specify
	// this field.
	FieldName *string `json:"field_name,omitempty"`
	// Function The analysis function that is used.
	// For example, `count`, `rare`, `mean`, `min`, `max`, and `sum`.
	Function string `json:"function"`
	// OverFieldName The field used to split the data.
	// In particular, this property is used for analyzing the splits with respect to
	// the history of all splits.
	// It is used for finding unusual values in the population of all splits.
	OverFieldName *string `json:"over_field_name,omitempty"`
	// PartitionFieldName The field used to segment the analysis.
	// When you use this property, you have completely independent baselines for
	// each value of this field.
	PartitionFieldName *string `json:"partition_field_name,omitempty"`
	// UseNull Defines whether a new series is used as the null series when there is no
	// value for the by or partition fields.
	UseNull *bool `json:"use_null,omitempty"`
}

DetectorRead type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Detector.ts#L69-L125

func NewDetectorRead added in v8.5.0 

func NewDetectorRead() *DetectorRead

NewDetectorRead returns a DetectorRead.

func (*DetectorRead) UnmarshalJSON added in v8.7.1 

func (s *DetectorRead) UnmarshalJSON(data []byte) error

type DetectorUpdate added in v8.17.0 

type DetectorUpdate struct {
	// CustomRules An array of custom rule objects, which enable you to customize the way
	// detectors operate.
	// For example, a rule may dictate to the detector conditions under which
	// results should be skipped.
	// Kibana refers to custom rules as job rules.
	CustomRules []DetectionRule `json:"custom_rules,omitempty"`
	// Description A description of the detector.
	Description *string `json:"description,omitempty"`
	// DetectorIndex A unique identifier for the detector.
	// This identifier is based on the order of the detectors in the
	// `analysis_config`, starting at zero.
	DetectorIndex int `json:"detector_index"`
}

DetectorUpdate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Detector.ts#L127-L143

func NewDetectorUpdate added in v8.17.0 

func NewDetectorUpdate() *DetectorUpdate

NewDetectorUpdate returns a DetectorUpdate.

func (*DetectorUpdate) UnmarshalJSON added in v8.17.0 

func (s *DetectorUpdate) UnmarshalJSON(data []byte) error

type DfsKnnProfile added in v8.16.0 

type DfsKnnProfile struct {
	Collector             []KnnCollectorResult    `json:"collector"`
	Query                 []KnnQueryProfileResult `json:"query"`
	RewriteTime           int64                   `json:"rewrite_time"`
	VectorOperationsCount *int64                  `json:"vector_operations_count,omitempty"`
}

DfsKnnProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L181-L186

func NewDfsKnnProfile added in v8.16.0 

func NewDfsKnnProfile() *DfsKnnProfile

NewDfsKnnProfile returns a DfsKnnProfile.

func (*DfsKnnProfile) UnmarshalJSON added in v8.16.0 

func (s *DfsKnnProfile) UnmarshalJSON(data []byte) error

type DfsProfile added in v8.16.0 

type DfsProfile struct {
	Knn        []DfsKnnProfile       `json:"knn,omitempty"`
	Statistics *DfsStatisticsProfile `json:"statistics,omitempty"`
}

DfsProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L154-L157

func NewDfsProfile added in v8.16.0 

func NewDfsProfile() *DfsProfile

NewDfsProfile returns a DfsProfile.

type DfsStatisticsBreakdown added in v8.16.0 

type DfsStatisticsBreakdown struct {
	CollectionStatistics      int64 `json:"collection_statistics"`
	CollectionStatisticsCount int64 `json:"collection_statistics_count"`
	CreateWeight              int64 `json:"create_weight"`
	CreateWeightCount         int64 `json:"create_weight_count"`
	Rewrite                   int64 `json:"rewrite"`
	RewriteCount              int64 `json:"rewrite_count"`
	TermStatistics            int64 `json:"term_statistics"`
	TermStatisticsCount       int64 `json:"term_statistics_count"`
}

DfsStatisticsBreakdown type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L170-L179

func NewDfsStatisticsBreakdown added in v8.16.0 

func NewDfsStatisticsBreakdown() *DfsStatisticsBreakdown

NewDfsStatisticsBreakdown returns a DfsStatisticsBreakdown.

func (*DfsStatisticsBreakdown) UnmarshalJSON added in v8.16.0 

func (s *DfsStatisticsBreakdown) UnmarshalJSON(data []byte) error

type DfsStatisticsProfile added in v8.16.0 

type DfsStatisticsProfile struct {
	Breakdown   DfsStatisticsBreakdown     `json:"breakdown"`
	Children    []DfsStatisticsProfile     `json:"children,omitempty"`
	Debug       map[string]json.RawMessage `json:"debug,omitempty"`
	Description string                     `json:"description"`
	Time        Duration                   `json:"time,omitempty"`
	TimeInNanos int64                      `json:"time_in_nanos"`
	Type        string                     `json:"type"`
}

DfsStatisticsProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L159-L167

func NewDfsStatisticsProfile added in v8.16.0 

func NewDfsStatisticsProfile() *DfsStatisticsProfile

NewDfsStatisticsProfile returns a DfsStatisticsProfile.

func (*DfsStatisticsProfile) UnmarshalJSON added in v8.16.0 

func (s *DfsStatisticsProfile) UnmarshalJSON(data []byte) error

type Diagnosis added in v8.7.1 

type Diagnosis struct {
	Action            string                     `json:"action"`
	AffectedResources DiagnosisAffectedResources `json:"affected_resources"`
	Cause             string                     `json:"cause"`
	HelpUrl           string                     `json:"help_url"`
	Id                string                     `json:"id"`
}

Diagnosis type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L50-L56

func NewDiagnosis added in v8.7.1 

func NewDiagnosis() *Diagnosis

NewDiagnosis returns a Diagnosis.

func (*Diagnosis) UnmarshalJSON added in v8.9.0 

func (s *Diagnosis) UnmarshalJSON(data []byte) error

type DiagnosisAffectedResources added in v8.7.1 

type DiagnosisAffectedResources struct {
	FeatureStates        []string        `json:"feature_states,omitempty"`
	Indices              []string        `json:"indices,omitempty"`
	Nodes                []IndicatorNode `json:"nodes,omitempty"`
	SlmPolicies          []string        `json:"slm_policies,omitempty"`
	SnapshotRepositories []string        `json:"snapshot_repositories,omitempty"`
}

DiagnosisAffectedResources type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L58-L64

func NewDiagnosisAffectedResources added in v8.7.1 

func NewDiagnosisAffectedResources() *DiagnosisAffectedResources

NewDiagnosisAffectedResources returns a DiagnosisAffectedResources.

func (*DiagnosisAffectedResources) UnmarshalJSON added in v8.7.1 

func (s *DiagnosisAffectedResources) UnmarshalJSON(data []byte) error

type DictionaryDecompounderTokenFilter 

type DictionaryDecompounderTokenFilter struct {
	// MaxSubwordSize Maximum subword character length. Longer subword tokens are excluded from the
	// output. Defaults to `15`.
	MaxSubwordSize *int `json:"max_subword_size,omitempty"`
	// MinSubwordSize Minimum subword character length. Shorter subword tokens are excluded from
	// the output. Defaults to `2`.
	MinSubwordSize *int `json:"min_subword_size,omitempty"`
	// MinWordSize Minimum word character length. Shorter word tokens are excluded from the
	// output. Defaults to `5`.
	MinWordSize *int `json:"min_word_size,omitempty"`
	// OnlyLongestMatch If `true`, only include the longest matching subword. Defaults to `false`.
	OnlyLongestMatch *bool   `json:"only_longest_match,omitempty"`
	Type             string  `json:"type,omitempty"`
	Version          *string `json:"version,omitempty"`
	// WordList A list of subwords to look for in the token stream. If found, the subword is
	// included in the token output.
	// Either this parameter or `word_list_path` must be specified.
	WordList []string `json:"word_list,omitempty"`
	// WordListPath Path to a file that contains a list of subwords to find in the token stream.
	// If found, the subword is included in the token output.
	// This path must be absolute or relative to the config location, and the file
	// must be UTF-8 encoded. Each token in the file must be separated by a line
	// break.
	// Either this parameter or `word_list` must be specified.
	WordListPath *string `json:"word_list_path,omitempty"`
}

DictionaryDecompounderTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L63-L65

func NewDictionaryDecompounderTokenFilter added in v8.5.0 

func NewDictionaryDecompounderTokenFilter() *DictionaryDecompounderTokenFilter

NewDictionaryDecompounderTokenFilter returns a DictionaryDecompounderTokenFilter.

func (DictionaryDecompounderTokenFilter) MarshalJSON added in v8.9.0 

func (s DictionaryDecompounderTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DictionaryDecompounderTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *DictionaryDecompounderTokenFilter) UnmarshalJSON(data []byte) error

type DirectGenerator 

type DirectGenerator struct {
	// Field The field to fetch the candidate suggestions from.
	// Needs to be set globally or per suggestion.
	Field string `json:"field"`
	// MaxEdits The maximum edit distance candidate suggestions can have in order to be
	// considered as a suggestion.
	// Can only be `1` or `2`.
	MaxEdits *int `json:"max_edits,omitempty"`
	// MaxInspections A factor that is used to multiply with the shard_size in order to inspect
	// more candidate spelling corrections on the shard level.
	// Can improve accuracy at the cost of performance.
	MaxInspections *float32 `json:"max_inspections,omitempty"`
	// MaxTermFreq The maximum threshold in number of documents in which a suggest text token
	// can exist in order to be included.
	// This can be used to exclude high frequency terms — which are usually spelled
	// correctly — from being spellchecked.
	// Can be a relative percentage number (for example `0.4`) or an absolute number
	// to represent document frequencies.
	// If a value higher than 1 is specified, then fractional can not be specified.
	MaxTermFreq *float32 `json:"max_term_freq,omitempty"`
	// MinDocFreq The minimal threshold in number of documents a suggestion should appear in.
	// This can improve quality by only suggesting high frequency terms.
	// Can be specified as an absolute number or as a relative percentage of number
	// of documents.
	// If a value higher than 1 is specified, the number cannot be fractional.
	MinDocFreq *float32 `json:"min_doc_freq,omitempty"`
	// MinWordLength The minimum length a suggest text term must have in order to be included.
	MinWordLength *int `json:"min_word_length,omitempty"`
	// PostFilter A filter (analyzer) that is applied to each of the generated tokens before
	// they are passed to the actual phrase scorer.
	PostFilter *string `json:"post_filter,omitempty"`
	// PreFilter A filter (analyzer) that is applied to each of the tokens passed to this
	// candidate generator.
	// This filter is applied to the original token before candidates are generated.
	PreFilter *string `json:"pre_filter,omitempty"`
	// PrefixLength The number of minimal prefix characters that must match in order be a
	// candidate suggestions.
	// Increasing this number improves spellcheck performance.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Size The maximum corrections to be returned per suggest text token.
	Size *int `json:"size,omitempty"`
	// SuggestMode Controls what suggestions are included on the suggestions generated on each
	// shard.
	SuggestMode *suggestmode.SuggestMode `json:"suggest_mode,omitempty"`
}

DirectGenerator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L268-L331

func NewDirectGenerator added in v8.5.0 

func NewDirectGenerator() *DirectGenerator

NewDirectGenerator returns a DirectGenerator.

func (*DirectGenerator) UnmarshalJSON added in v8.7.1 

func (s *DirectGenerator) UnmarshalJSON(data []byte) error

type DisMaxQuery 

type DisMaxQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Queries One or more query clauses.
	// Returned documents must match one or more of these queries.
	// If a document matches multiple queries, Elasticsearch uses the highest
	// relevance score.
	Queries    []Query `json:"queries"`
	QueryName_ *string `json:"_name,omitempty"`
	// TieBreaker Floating point number between 0 and 1.0 used to increase the relevance scores
	// of documents matching multiple query clauses.
	TieBreaker *Float64 `json:"tie_breaker,omitempty"`
}

DisMaxQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L88-L103

func NewDisMaxQuery added in v8.5.0 

func NewDisMaxQuery() *DisMaxQuery

NewDisMaxQuery returns a DisMaxQuery.

func (*DisMaxQuery) UnmarshalJSON added in v8.7.1 

func (s *DisMaxQuery) UnmarshalJSON(data []byte) error

type Discovery 

type Discovery struct {
	ClusterApplierStats *ClusterAppliedStats `json:"cluster_applier_stats,omitempty"`
	// ClusterStateQueue Contains statistics for the cluster state queue of the node.
	ClusterStateQueue *ClusterStateQueue `json:"cluster_state_queue,omitempty"`
	// ClusterStateUpdate Contains low-level statistics about how long various activities took during
	// cluster state updates while the node was the elected master.
	// Omitted if the node is not master-eligible.
	// Every field whose name ends in `_time` within this object is also represented
	// as a raw number of milliseconds in a field whose name ends in `_time_millis`.
	// The human-readable fields with a `_time` suffix are only returned if
	// requested with the `?human=true` query parameter.
	ClusterStateUpdate map[string]ClusterStateUpdate `json:"cluster_state_update,omitempty"`
	// PublishedClusterStates Contains statistics for the published cluster states of the node.
	PublishedClusterStates  *PublishedClusterStates `json:"published_cluster_states,omitempty"`
	SerializedClusterStates *SerializedClusterState `json:"serialized_cluster_states,omitempty"`
}

Discovery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L201-L219

func NewDiscovery added in v8.5.0 

func NewDiscovery() *Discovery

NewDiscovery returns a Discovery.

type DiscoveryNode 

type DiscoveryNode map[string]DiscoveryNodeContent

DiscoveryNode type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DiscoveryNode.ts#L25-L25

type DiscoveryNodeCompact added in v8.17.0 

type DiscoveryNodeCompact struct {
	Attributes       map[string]string `json:"attributes"`
	EphemeralId      string            `json:"ephemeral_id"`
	Id               string            `json:"id"`
	Name             string            `json:"name"`
	TransportAddress string            `json:"transport_address"`
}

DiscoveryNodeCompact type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DiscoveryNode.ts#L39-L48

func NewDiscoveryNodeCompact added in v8.17.0 

func NewDiscoveryNodeCompact() *DiscoveryNodeCompact

NewDiscoveryNodeCompact returns a DiscoveryNodeCompact.

func (*DiscoveryNodeCompact) UnmarshalJSON added in v8.17.0 

func (s *DiscoveryNodeCompact) UnmarshalJSON(data []byte) error

type DiscoveryNodeContent added in v8.17.0 

type DiscoveryNodeContent struct {
	Attributes       map[string]string `json:"attributes"`
	EphemeralId      string            `json:"ephemeral_id"`
	ExternalId       string            `json:"external_id"`
	MaxIndexVersion  int               `json:"max_index_version"`
	MinIndexVersion  int               `json:"min_index_version"`
	Name             *string           `json:"name,omitempty"`
	Roles            []string          `json:"roles"`
	TransportAddress string            `json:"transport_address"`
	Version          string            `json:"version"`
}

DiscoveryNodeContent type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DiscoveryNode.ts#L27-L37

func NewDiscoveryNodeContent added in v8.17.0 

func NewDiscoveryNodeContent() *DiscoveryNodeContent

NewDiscoveryNodeContent returns a DiscoveryNodeContent.

func (*DiscoveryNodeContent) UnmarshalJSON added in v8.17.0 

func (s *DiscoveryNodeContent) UnmarshalJSON(data []byte) error

type DiskIndicator added in v8.7.1 

type DiskIndicator struct {
	Details   *DiskIndicatorDetails                       `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

DiskIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L123-L127

func NewDiskIndicator added in v8.7.1 

func NewDiskIndicator() *DiskIndicator

NewDiskIndicator returns a DiskIndicator.

func (*DiskIndicator) UnmarshalJSON added in v8.9.0 

func (s *DiskIndicator) UnmarshalJSON(data []byte) error

type DiskIndicatorDetails added in v8.7.1 

type DiskIndicatorDetails struct {
	IndicesWithReadonlyBlock     int64 `json:"indices_with_readonly_block"`
	NodesOverFloodStageWatermark int64 `json:"nodes_over_flood_stage_watermark"`
	NodesOverHighWatermark       int64 `json:"nodes_over_high_watermark"`
	NodesWithEnoughDiskSpace     int64 `json:"nodes_with_enough_disk_space"`
	NodesWithUnknownDiskStatus   int64 `json:"nodes_with_unknown_disk_status"`
}

DiskIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L128-L134

func NewDiskIndicatorDetails added in v8.7.1 

func NewDiskIndicatorDetails() *DiskIndicatorDetails

NewDiskIndicatorDetails returns a DiskIndicatorDetails.

func (*DiskIndicatorDetails) UnmarshalJSON added in v8.7.1 

func (s *DiskIndicatorDetails) UnmarshalJSON(data []byte) error

type DiskUsage 

type DiskUsage struct {
	FreeBytes       int64   `json:"free_bytes"`
	FreeDiskPercent Float64 `json:"free_disk_percent"`
	Path            string  `json:"path"`
	TotalBytes      int64   `json:"total_bytes"`
	UsedBytes       int64   `json:"used_bytes"`
	UsedDiskPercent Float64 `json:"used_disk_percent"`
}

DiskUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L63-L70

func NewDiskUsage added in v8.5.0 

func NewDiskUsage() *DiskUsage

NewDiskUsage returns a DiskUsage.

func (*DiskUsage) UnmarshalJSON added in v8.7.1 

func (s *DiskUsage) UnmarshalJSON(data []byte) error

type DissectProcessor 

type DissectProcessor struct {
	// AppendSeparator The character(s) that separate the appended fields.
	AppendSeparator *string `json:"append_separator,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to dissect.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Pattern The pattern to apply to the field.
	Pattern string `json:"pattern"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

DissectProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L804-L823

func NewDissectProcessor added in v8.5.0 

func NewDissectProcessor() *DissectProcessor

NewDissectProcessor returns a DissectProcessor.

func (*DissectProcessor) UnmarshalJSON added in v8.7.1 

func (s *DissectProcessor) UnmarshalJSON(data []byte) error

type DistanceFeatureQuery 

type DistanceFeatureQuery any

DistanceFeatureQuery holds the union for the following types: 

UntypedDistanceFeatureQuery
GeoDistanceFeatureQuery
DateDistanceFeatureQuery

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L76-L85

type DistanceFeatureQueryBaseDateMathDuration 

type DistanceFeatureQueryBaseDateMathDuration struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field used to calculate distances. This field must meet the
	// following criteria:
	// be a `date`, `date_nanos` or `geo_point` field;
	// have an `index` mapping parameter value of `true`, which is the default;
	// have an `doc_values` mapping parameter value of `true`, which is the default.
	Field string `json:"field"`
	// Origin Date or point of origin used to calculate distances.
	// If the `field` value is a `date` or `date_nanos` field, the `origin` value
	// must be a date.
	// Date Math, such as `now-1h`, is supported.
	// If the field value is a `geo_point` field, the `origin` value must be a
	// geopoint.
	Origin string `json:"origin"`
	// Pivot Distance from the `origin` at which relevance scores receive half of the
	// `boost` value.
	// If the `field` value is a `date` or `date_nanos` field, the `pivot` value
	// must be a time unit, such as `1h` or `10d`. If the `field` value is a
	// `geo_point` field, the `pivot` value must be a distance unit, such as `1km`
	// or `12m`.
	Pivot      Duration `json:"pivot"`
	QueryName_ *string  `json:"_name,omitempty"`
}

DistanceFeatureQueryBaseDateMathDuration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L39-L59

func NewDistanceFeatureQueryBaseDateMathDuration added in v8.5.0 

func NewDistanceFeatureQueryBaseDateMathDuration() *DistanceFeatureQueryBaseDateMathDuration

NewDistanceFeatureQueryBaseDateMathDuration returns a DistanceFeatureQueryBaseDateMathDuration.

func (*DistanceFeatureQueryBaseDateMathDuration) UnmarshalJSON added in v8.7.1 

func (s *DistanceFeatureQueryBaseDateMathDuration) UnmarshalJSON(data []byte) error

type DistanceFeatureQueryBaseGeoLocationDistance 

type DistanceFeatureQueryBaseGeoLocationDistance struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field used to calculate distances. This field must meet the
	// following criteria:
	// be a `date`, `date_nanos` or `geo_point` field;
	// have an `index` mapping parameter value of `true`, which is the default;
	// have an `doc_values` mapping parameter value of `true`, which is the default.
	Field string `json:"field"`
	// Origin Date or point of origin used to calculate distances.
	// If the `field` value is a `date` or `date_nanos` field, the `origin` value
	// must be a date.
	// Date Math, such as `now-1h`, is supported.
	// If the field value is a `geo_point` field, the `origin` value must be a
	// geopoint.
	Origin GeoLocation `json:"origin"`
	// Pivot Distance from the `origin` at which relevance scores receive half of the
	// `boost` value.
	// If the `field` value is a `date` or `date_nanos` field, the `pivot` value
	// must be a time unit, such as `1h` or `10d`. If the `field` value is a
	// `geo_point` field, the `pivot` value must be a distance unit, such as `1km`
	// or `12m`.
	Pivot      string  `json:"pivot"`
	QueryName_ *string `json:"_name,omitempty"`
}

DistanceFeatureQueryBaseGeoLocationDistance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L39-L59

func NewDistanceFeatureQueryBaseGeoLocationDistance added in v8.5.0 

func NewDistanceFeatureQueryBaseGeoLocationDistance() *DistanceFeatureQueryBaseGeoLocationDistance

NewDistanceFeatureQueryBaseGeoLocationDistance returns a DistanceFeatureQueryBaseGeoLocationDistance.

func (*DistanceFeatureQueryBaseGeoLocationDistance) UnmarshalJSON added in v8.7.1 

func (s *DistanceFeatureQueryBaseGeoLocationDistance) UnmarshalJSON(data []byte) error

type DiversifiedSamplerAggregation 

type DiversifiedSamplerAggregation struct {
	// ExecutionHint The type of value used for de-duplication.
	ExecutionHint *sampleraggregationexecutionhint.SamplerAggregationExecutionHint `json:"execution_hint,omitempty"`
	// Field The field used to provide values used for de-duplication.
	Field *string `json:"field,omitempty"`
	// MaxDocsPerValue Limits how many documents are permitted per choice of de-duplicating value.
	MaxDocsPerValue *int    `json:"max_docs_per_value,omitempty"`
	Script          *Script `json:"script,omitempty"`
	// ShardSize Limits how many top-scoring documents are collected in the sample processed
	// on each shard.
	ShardSize *int `json:"shard_size,omitempty"`
}

DiversifiedSamplerAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L333-L357

func NewDiversifiedSamplerAggregation added in v8.5.0 

func NewDiversifiedSamplerAggregation() *DiversifiedSamplerAggregation

NewDiversifiedSamplerAggregation returns a DiversifiedSamplerAggregation.

func (*DiversifiedSamplerAggregation) UnmarshalJSON added in v8.7.1 

func (s *DiversifiedSamplerAggregation) UnmarshalJSON(data []byte) error

type DocStats 

type DocStats struct {
	// Count Total number of non-deleted documents across all primary shards assigned to
	// selected nodes.
	// This number is based on documents in Lucene segments and may include
	// documents from nested fields.
	Count int64 `json:"count"`
	// Deleted Total number of deleted documents across all primary shards assigned to
	// selected nodes.
	// This number is based on documents in Lucene segments.
	// Elasticsearch reclaims the disk space of deleted Lucene documents when a
	// segment is merged.
	Deleted *int64 `json:"deleted,omitempty"`
}

DocStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L100-L112

func NewDocStats added in v8.5.0 

func NewDocStats() *DocStats

NewDocStats returns a DocStats.

func (*DocStats) UnmarshalJSON added in v8.7.1 

func (s *DocStats) UnmarshalJSON(data []byte) error

type Document 

type Document struct {
	// Id_ Unique identifier for the document.
	// This ID must be unique within the `_index`.
	Id_ *string `json:"_id,omitempty"`
	// Index_ Name of the index containing the document.
	Index_ *string `json:"_index,omitempty"`
	// Source_ JSON body for the document.
	Source_ json.RawMessage `json:"_source,omitempty"`
}

Document type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L69-L83

func NewDocument added in v8.5.0 

func NewDocument() *Document

NewDocument returns a Document.

func (*Document) UnmarshalJSON added in v8.7.1 

func (s *Document) UnmarshalJSON(data []byte) error

type DocumentRating 

type DocumentRating struct {
	// Id_ The document ID.
	Id_ string `json:"_id"`
	// Index_ The document’s index. For data streams, this should be the document’s backing
	// index.
	Index_ string `json:"_index"`
	// Rating The document’s relevance with regard to this search request.
	Rating int `json:"rating"`
}

DocumentRating type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L119-L126

func NewDocumentRating added in v8.5.0 

func NewDocumentRating() *DocumentRating

NewDocumentRating returns a DocumentRating.

func (*DocumentRating) UnmarshalJSON added in v8.7.1 

func (s *DocumentRating) UnmarshalJSON(data []byte) error

type DocumentSimulation 

type DocumentSimulation struct {
	DocumentSimulation map[string]string `json:"-"`
	// Id_ Unique identifier for the document. This ID must be unique within the
	// `_index`.
	Id_ string `json:"_id"`
	// Index_ Name of the index containing the document.
	Index_  string `json:"_index"`
	Ingest_ Ingest `json:"_ingest"`
	// Routing_ Value used to send the document to a specific primary shard.
	Routing_ *string `json:"_routing,omitempty"`
	// Source_ JSON body for the document.
	Source_      map[string]json.RawMessage `json:"_source"`
	VersionType_ *versiontype.VersionType   `json:"_version_type,omitempty"`
	Version_     StringifiedVersionNumber   `json:"_version,omitempty"`
}

DocumentSimulation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L85-L115

func NewDocumentSimulation added in v8.5.0 

func NewDocumentSimulation() *DocumentSimulation

NewDocumentSimulation returns a DocumentSimulation.

func (DocumentSimulation) MarshalJSON added in v8.5.0 

func (s DocumentSimulation) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*DocumentSimulation) UnmarshalJSON added in v8.7.1 

func (s *DocumentSimulation) UnmarshalJSON(data []byte) error

type DotExpanderProcessor 

type DotExpanderProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to expand into an object field.
	// If set to `*`, all top-level fields will be expanded.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Override Controls the behavior when there is already an existing nested object that
	// conflicts with the expanded field.
	// When `false`, the processor will merge conflicts by combining the old and the
	// new values into an array.
	// When `true`, the value from the expanded field will overwrite the existing
	// value.
	Override *bool `json:"override,omitempty"`
	// Path The field that contains the field to expand.
	// Only required if the field to expand is part another object field, because
	// the `field` option can only understand leaf fields.
	Path *string `json:"path,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

DotExpanderProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L825-L843

func NewDotExpanderProcessor added in v8.5.0 

func NewDotExpanderProcessor() *DotExpanderProcessor

NewDotExpanderProcessor returns a DotExpanderProcessor.

func (*DotExpanderProcessor) UnmarshalJSON added in v8.7.1 

func (s *DotExpanderProcessor) UnmarshalJSON(data []byte) error

type DoubleNumberProperty 

type DoubleNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *Float64                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

DoubleNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L165-L168

func NewDoubleNumberProperty added in v8.5.0 

func NewDoubleNumberProperty() *DoubleNumberProperty

NewDoubleNumberProperty returns a DoubleNumberProperty.

func (DoubleNumberProperty) MarshalJSON added in v8.9.0 

func (s DoubleNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DoubleNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *DoubleNumberProperty) UnmarshalJSON(data []byte) error

type DoubleRangeProperty 

type DoubleRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

DoubleRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L34-L36

func NewDoubleRangeProperty added in v8.5.0 

func NewDoubleRangeProperty() *DoubleRangeProperty

NewDoubleRangeProperty returns a DoubleRangeProperty.

func (DoubleRangeProperty) MarshalJSON added in v8.9.0 

func (s DoubleRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DoubleRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *DoubleRangeProperty) UnmarshalJSON(data []byte) error

type DoubleTermsAggregate 

type DoubleTermsAggregate struct {
	Buckets                 BucketsDoubleTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                 `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

DoubleTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L451-L456

func NewDoubleTermsAggregate added in v8.5.0 

func NewDoubleTermsAggregate() *DoubleTermsAggregate

NewDoubleTermsAggregate returns a DoubleTermsAggregate.

func (*DoubleTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *DoubleTermsAggregate) UnmarshalJSON(data []byte) error

type DoubleTermsBucket 

type DoubleTermsBucket struct {
	Aggregations            map[string]Aggregate `json:"-"`
	DocCount                int64                `json:"doc_count"`
	DocCountErrorUpperBound *int64               `json:"doc_count_error_upper_bound,omitempty"`
	Key                     Float64              `json:"key"`
	KeyAsString             *string              `json:"key_as_string,omitempty"`
}

DoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L458-L461

func NewDoubleTermsBucket added in v8.5.0 

func NewDoubleTermsBucket() *DoubleTermsBucket

NewDoubleTermsBucket returns a DoubleTermsBucket.

func (DoubleTermsBucket) MarshalJSON 

func (s DoubleTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*DoubleTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *DoubleTermsBucket) UnmarshalJSON(data []byte) error

type DownsampleAction added in v8.15.0 

type DownsampleAction struct {
	FixedInterval string   `json:"fixed_interval"`
	WaitTimeout   Duration `json:"wait_timeout,omitempty"`
}

DownsampleAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L112-L115

func NewDownsampleAction added in v8.15.0 

func NewDownsampleAction() *DownsampleAction

NewDownsampleAction returns a DownsampleAction.

func (*DownsampleAction) UnmarshalJSON added in v8.15.0 

func (s *DownsampleAction) UnmarshalJSON(data []byte) error

type DownsampleConfig added in v8.5.0 

type DownsampleConfig struct {
	// FixedInterval The interval at which to aggregate the original time series index.
	FixedInterval string `json:"fixed_interval"`
}

DownsampleConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/Downsample.ts#L22-L27

func NewDownsampleConfig added in v8.5.0 

func NewDownsampleConfig() *DownsampleConfig

NewDownsampleConfig returns a DownsampleConfig.

func (*DownsampleConfig) UnmarshalJSON added in v8.7.1 

func (s *DownsampleConfig) UnmarshalJSON(data []byte) error

type DownsamplingRound added in v8.11.0 

type DownsamplingRound struct {
	// After The duration since rollover when this downsampling round should execute
	After Duration `json:"after"`
	// Config The downsample configuration to execute.
	Config DownsampleConfig `json:"config"`
}

DownsamplingRound type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DownsamplingRound.ts#L23-L32

func NewDownsamplingRound added in v8.11.0 

func NewDownsamplingRound() *DownsamplingRound

NewDownsamplingRound returns a DownsamplingRound.

func (*DownsamplingRound) UnmarshalJSON added in v8.11.0 

func (s *DownsamplingRound) UnmarshalJSON(data []byte) error

type DropProcessor 

type DropProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

DropProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L845-L845

func NewDropProcessor added in v8.5.0 

func NewDropProcessor() *DropProcessor

NewDropProcessor returns a DropProcessor.

func (*DropProcessor) UnmarshalJSON added in v8.7.1 

func (s *DropProcessor) UnmarshalJSON(data []byte) error

type Duration 

type Duration any

Duration holds the union for the following types: 

string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L52-L58

type DurationValueUnitFloatMillis 

type DurationValueUnitFloatMillis Float64

DurationValueUnitFloatMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L67-L67

type DurationValueUnitMillis 

type DurationValueUnitMillis int64

DurationValueUnitMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L67-L67

type DurationValueUnitNanos 

type DurationValueUnitNanos int64

DurationValueUnitNanos type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L67-L67

type DurationValueUnitSeconds 

type DurationValueUnitSeconds int64

DurationValueUnitSeconds type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L67-L67

type DutchAnalyzer 

type DutchAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

DutchAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L125-L130

func NewDutchAnalyzer added in v8.5.0 

func NewDutchAnalyzer() *DutchAnalyzer

NewDutchAnalyzer returns a DutchAnalyzer.

func (DutchAnalyzer) MarshalJSON added in v8.9.0 

func (s DutchAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DutchAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *DutchAnalyzer) UnmarshalJSON(data []byte) error

type DynamicProperty 

type DynamicProperty struct {
	Analyzer            *string                        `json:"analyzer,omitempty"`
	Boost               *Float64                       `json:"boost,omitempty"`
	Coerce              *bool                          `json:"coerce,omitempty"`
	CopyTo              []string                       `json:"copy_to,omitempty"`
	DocValues           *bool                          `json:"doc_values,omitempty"`
	Dynamic             *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EagerGlobalOrdinals *bool                          `json:"eager_global_ordinals,omitempty"`
	Enabled             *bool                          `json:"enabled,omitempty"`
	Fields              map[string]Property            `json:"fields,omitempty"`
	Format              *string                        `json:"format,omitempty"`
	IgnoreAbove         *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed     *bool                          `json:"ignore_malformed,omitempty"`
	Index               *bool                          `json:"index,omitempty"`
	IndexOptions        *indexoptions.IndexOptions     `json:"index_options,omitempty"`
	IndexPhrases        *bool                          `json:"index_phrases,omitempty"`
	IndexPrefixes       *TextIndexPrefixes             `json:"index_prefixes,omitempty"`
	Locale              *string                        `json:"locale,omitempty"`
	// Meta Metadata about the field.
	Meta                 map[string]string                                `json:"meta,omitempty"`
	Norms                *bool                                            `json:"norms,omitempty"`
	NullValue            FieldValue                                       `json:"null_value,omitempty"`
	OnScriptError        *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	PositionIncrementGap *int                                             `json:"position_increment_gap,omitempty"`
	PrecisionStep        *int                                             `json:"precision_step,omitempty"`
	Properties           map[string]Property                              `json:"properties,omitempty"`
	Script               *Script                                          `json:"script,omitempty"`
	SearchAnalyzer       *string                                          `json:"search_analyzer,omitempty"`
	SearchQuoteAnalyzer  *string                                          `json:"search_quote_analyzer,omitempty"`
	Store                *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep  *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	TermVector           *termvectoroption.TermVectorOption               `json:"term_vector,omitempty"`
	TimeSeriesMetric     *timeseriesmetrictype.TimeSeriesMetricType       `json:"time_series_metric,omitempty"`
	Type                 string                                           `json:"type,omitempty"`
}

DynamicProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L327-L358

func NewDynamicProperty added in v8.5.0 

func NewDynamicProperty() *DynamicProperty

NewDynamicProperty returns a DynamicProperty.

func (DynamicProperty) MarshalJSON added in v8.9.0 

func (s DynamicProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*DynamicProperty) UnmarshalJSON added in v8.7.0 

func (s *DynamicProperty) UnmarshalJSON(data []byte) error

type DynamicTemplate 

type DynamicTemplate struct {
	Mapping            Property             `json:"mapping,omitempty"`
	Match              []string             `json:"match,omitempty"`
	MatchMappingType   []string             `json:"match_mapping_type,omitempty"`
	MatchPattern       *matchtype.MatchType `json:"match_pattern,omitempty"`
	PathMatch          []string             `json:"path_match,omitempty"`
	PathUnmatch        []string             `json:"path_unmatch,omitempty"`
	Runtime            *RuntimeField        `json:"runtime,omitempty"`
	Unmatch            []string             `json:"unmatch,omitempty"`
	UnmatchMappingType []string             `json:"unmatch_mapping_type,omitempty"`
}

DynamicTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/dynamic-template.ts#L23-L43

func NewDynamicTemplate added in v8.5.0 

func NewDynamicTemplate() *DynamicTemplate

NewDynamicTemplate returns a DynamicTemplate.

func (*DynamicTemplate) UnmarshalJSON added in v8.7.0 

func (s *DynamicTemplate) UnmarshalJSON(data []byte) error

type EdgeNGramTokenFilter 

type EdgeNGramTokenFilter struct {
	// MaxGram Maximum character length of a gram. For custom token filters, defaults to
	// `2`. For the built-in edge_ngram filter, defaults to `1`.
	MaxGram *int `json:"max_gram,omitempty"`
	// MinGram Minimum character length of a gram. Defaults to `1`.
	MinGram *int `json:"min_gram,omitempty"`
	// PreserveOriginal Emits original token when set to `true`. Defaults to `false`.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	// Side Indicates whether to truncate tokens from the `front` or `back`. Defaults to
	// `front`.
	Side    *edgengramside.EdgeNGramSide `json:"side,omitempty"`
	Type    string                       `json:"type,omitempty"`
	Version *string                      `json:"version,omitempty"`
}

EdgeNGramTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L97-L107

func NewEdgeNGramTokenFilter added in v8.5.0 

func NewEdgeNGramTokenFilter() *EdgeNGramTokenFilter

NewEdgeNGramTokenFilter returns a EdgeNGramTokenFilter.

func (EdgeNGramTokenFilter) MarshalJSON added in v8.9.0 

func (s EdgeNGramTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*EdgeNGramTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *EdgeNGramTokenFilter) UnmarshalJSON(data []byte) error

type EdgeNGramTokenizer 

type EdgeNGramTokenizer struct {
	CustomTokenChars *string               `json:"custom_token_chars,omitempty"`
	MaxGram          *int                  `json:"max_gram,omitempty"`
	MinGram          *int                  `json:"min_gram,omitempty"`
	TokenChars       []tokenchar.TokenChar `json:"token_chars,omitempty"`
	Type             string                `json:"type,omitempty"`
	Version          *string               `json:"version,omitempty"`
}

EdgeNGramTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L48-L57

func NewEdgeNGramTokenizer added in v8.5.0 

func NewEdgeNGramTokenizer() *EdgeNGramTokenizer

NewEdgeNGramTokenizer returns a EdgeNGramTokenizer.

func (EdgeNGramTokenizer) MarshalJSON added in v8.9.0 

func (s EdgeNGramTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*EdgeNGramTokenizer) UnmarshalJSON added in v8.7.1 

func (s *EdgeNGramTokenizer) UnmarshalJSON(data []byte) error

type ElasticsearchError added in v8.7.0 

type ElasticsearchError struct {
	ErrorCause ErrorCause `json:"error"`
	Status     int        `json:"status"`
}

An ElasticsearchError represent the exception raised by the server and sent as json payloads.

func NewElasticsearchError added in v8.7.0 

func NewElasticsearchError() *ElasticsearchError

NewElasticsearchError returns a ElasticsearchError.

func (ElasticsearchError) As added in v8.7.0 

func (e ElasticsearchError) As(err interface{}) bool

As implements errors.As interface to allow type matching of ElasticsearchError.

func (ElasticsearchError) Error added in v8.7.0 

func (e ElasticsearchError) Error() string

Error implements error string serialization of the ElasticsearchError.

func (ElasticsearchError) Is added in v8.7.0 

func (e ElasticsearchError) Is(err error) bool

Is implements errors.Is interface to allow value comparison within ElasticsearchError. It checks for always present values only: Status & ErrorCause.Type.

type ElasticsearchServiceSettings added in v8.18.0 

type ElasticsearchServiceSettings struct {
	// AdaptiveAllocations Adaptive allocations configuration details.
	// If `enabled` is true, the number of allocations of the model is set based on
	// the current load the process gets.
	// When the load is high, a new model allocation is automatically created,
	// respecting the value of `max_number_of_allocations` if it's set.
	// When the load is low, a model allocation is automatically removed, respecting
	// the value of `min_number_of_allocations` if it's set.
	// If `enabled` is true, do not set the number of allocations manually.
	AdaptiveAllocations *AdaptiveAllocations `json:"adaptive_allocations,omitempty"`
	// DeploymentId The deployment identifier for a trained model deployment.
	// When `deployment_id` is used the `model_id` is optional.
	DeploymentId *string `json:"deployment_id,omitempty"`
	// ModelId The name of the model to use for the inference task.
	// It can be the ID of a built-in model (for example, `.multilingual-e5-small`
	// for E5) or a text embedding model that was uploaded by using the Eland
	// client.
	ModelId string `json:"model_id"`
	// NumAllocations The total number of allocations that are assigned to the model across machine
	// learning nodes.
	// Increasing this value generally increases the throughput.
	// If adaptive allocations are enabled, do not set this value because it's
	// automatically set.
	NumAllocations *int `json:"num_allocations,omitempty"`
	// NumThreads The number of threads used by each model allocation during inference.
	// This setting generally increases the speed per inference request.
	// The inference process is a compute-bound process; `threads_per_allocations`
	// must not exceed the number of available allocated processors per node.
	// The value must be a power of 2.
	// The maximum value is 32.
	NumThreads int `json:"num_threads"`
}

ElasticsearchServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L777-L811

func NewElasticsearchServiceSettings added in v8.18.0 

func NewElasticsearchServiceSettings() *ElasticsearchServiceSettings

NewElasticsearchServiceSettings returns a ElasticsearchServiceSettings.

func (*ElasticsearchServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *ElasticsearchServiceSettings) UnmarshalJSON(data []byte) error

type ElasticsearchTaskSettings added in v8.18.0 

type ElasticsearchTaskSettings struct {
	// ReturnDocuments For a `rerank` task, return the document instead of only the index.
	ReturnDocuments *bool `json:"return_documents,omitempty"`
}

ElasticsearchTaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L813-L819

func NewElasticsearchTaskSettings added in v8.18.0 

func NewElasticsearchTaskSettings() *ElasticsearchTaskSettings

NewElasticsearchTaskSettings returns a ElasticsearchTaskSettings.

func (*ElasticsearchTaskSettings) UnmarshalJSON added in v8.18.0 

func (s *ElasticsearchTaskSettings) UnmarshalJSON(data []byte) error

type ElasticsearchVersionInfo 

type ElasticsearchVersionInfo struct {
	// BuildDate The Elasticsearch Git commit's date.
	BuildDate DateTime `json:"build_date"`
	// BuildFlavor The build flavor. For example, `default`.
	BuildFlavor string `json:"build_flavor"`
	// BuildHash The Elasticsearch Git commit's SHA hash.
	BuildHash string `json:"build_hash"`
	// BuildSnapshot Indicates whether the Elasticsearch build was a snapshot.
	BuildSnapshot bool `json:"build_snapshot"`
	// BuildType The build type that corresponds to how Elasticsearch was installed.
	// For example, `docker`, `rpm`, or `tar`.
	BuildType string `json:"build_type"`
	// Int The Elasticsearch version number.
	Int string `json:"number"`
	// LuceneVersion The version number of Elasticsearch's underlying Lucene software.
	LuceneVersion string `json:"lucene_version"`
	// MinimumIndexCompatibilityVersion The minimum index version with which the responding node can read from disk.
	MinimumIndexCompatibilityVersion string `json:"minimum_index_compatibility_version"`
	// MinimumWireCompatibilityVersion The minimum node version with which the responding node can communicate.
	// Also the minimum version from which you can perform a rolling upgrade.
	MinimumWireCompatibilityVersion string `json:"minimum_wire_compatibility_version"`
}

ElasticsearchVersionInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Base.ts#L76-L115

func NewElasticsearchVersionInfo added in v8.5.0 

func NewElasticsearchVersionInfo() *ElasticsearchVersionInfo

NewElasticsearchVersionInfo returns a ElasticsearchVersionInfo.

func (*ElasticsearchVersionInfo) UnmarshalJSON added in v8.7.1 

func (s *ElasticsearchVersionInfo) UnmarshalJSON(data []byte) error

type ElasticsearchVersionMinInfo added in v8.13.0 

type ElasticsearchVersionMinInfo struct {
	BuildFlavor                      string `json:"build_flavor"`
	Int                              string `json:"number"`
	MinimumIndexCompatibilityVersion string `json:"minimum_index_compatibility_version"`
	MinimumWireCompatibilityVersion  string `json:"minimum_wire_compatibility_version"`
}

ElasticsearchVersionMinInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Base.ts#L117-L125

func NewElasticsearchVersionMinInfo added in v8.13.0 

func NewElasticsearchVersionMinInfo() *ElasticsearchVersionMinInfo

NewElasticsearchVersionMinInfo returns a ElasticsearchVersionMinInfo.

func (*ElasticsearchVersionMinInfo) UnmarshalJSON added in v8.13.0 

func (s *ElasticsearchVersionMinInfo) UnmarshalJSON(data []byte) error

type ElisionTokenFilter 

type ElisionTokenFilter struct {
	// Articles List of elisions to remove.
	// To be removed, the elision must be at the beginning of a token and be
	// immediately followed by an apostrophe. Both the elision and apostrophe are
	// removed.
	// For custom `elision` filters, either this parameter or `articles_path` must
	// be specified.
	Articles []string `json:"articles,omitempty"`
	// ArticlesCase If `true`, elision matching is case insensitive. If `false`, elision matching
	// is case sensitive. Defaults to `false`.
	ArticlesCase Stringifiedboolean `json:"articles_case,omitempty"`
	// ArticlesPath Path to a file that contains a list of elisions to remove.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each elision in the file must be separated by a line
	// break.
	// To be removed, the elision must be at the beginning of a token and be
	// immediately followed by an apostrophe. Both the elision and apostrophe are
	// removed.
	// For custom `elision` filters, either this parameter or `articles` must be
	// specified.
	ArticlesPath *string `json:"articles_path,omitempty"`
	Type         string  `json:"type,omitempty"`
	Version      *string `json:"version,omitempty"`
}

ElisionTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L245-L258

func NewElisionTokenFilter added in v8.5.0 

func NewElisionTokenFilter() *ElisionTokenFilter

NewElisionTokenFilter returns a ElisionTokenFilter.

func (ElisionTokenFilter) MarshalJSON added in v8.9.0 

func (s ElisionTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ElisionTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *ElisionTokenFilter) UnmarshalJSON(data []byte) error

type ElserServiceSettings added in v8.18.0 

type ElserServiceSettings struct {
	// AdaptiveAllocations Adaptive allocations configuration details.
	// If `enabled` is true, the number of allocations of the model is set based on
	// the current load the process gets.
	// When the load is high, a new model allocation is automatically created,
	// respecting the value of `max_number_of_allocations` if it's set.
	// When the load is low, a model allocation is automatically removed, respecting
	// the value of `min_number_of_allocations` if it's set.
	// If `enabled` is true, do not set the number of allocations manually.
	AdaptiveAllocations *AdaptiveAllocations `json:"adaptive_allocations,omitempty"`
	// NumAllocations The total number of allocations this model is assigned across machine
	// learning nodes.
	// Increasing this value generally increases the throughput.
	// If adaptive allocations is enabled, do not set this value because it's
	// automatically set.
	NumAllocations int `json:"num_allocations"`
	// NumThreads The number of threads used by each model allocation during inference.
	// Increasing this value generally increases the speed per inference request.
	// The inference process is a compute-bound process; `threads_per_allocations`
	// must not exceed the number of available allocated processors per node.
	// The value must be a power of 2.
	// The maximum value is 32.
	//
	// > info
	// > If you want to optimize your ELSER endpoint for ingest, set the number of
	// threads to 1. If you want to optimize your ELSER endpoint for search, set the
	// number of threads to greater than 1.
	NumThreads int `json:"num_threads"`
}

ElserServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L831-L857

func NewElserServiceSettings added in v8.18.0 

func NewElserServiceSettings() *ElserServiceSettings

NewElserServiceSettings returns a ElserServiceSettings.

func (*ElserServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *ElserServiceSettings) UnmarshalJSON(data []byte) error

type Email 

type Email struct {
	Attachments map[string]EmailAttachmentContainer `json:"attachments,omitempty"`
	Bcc         []string                            `json:"bcc,omitempty"`
	Body        *EmailBody                          `json:"body,omitempty"`
	Cc          []string                            `json:"cc,omitempty"`
	From        *string                             `json:"from,omitempty"`
	Id          *string                             `json:"id,omitempty"`
	Priority    *emailpriority.EmailPriority        `json:"priority,omitempty"`
	ReplyTo     []string                            `json:"reply_to,omitempty"`
	SentDate    DateTime                            `json:"sent_date,omitempty"`
	Subject     string                              `json:"subject"`
	To          []string                            `json:"to"`
}

Email type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L238-L250

func NewEmail added in v8.5.0 

func NewEmail() *Email

NewEmail returns a Email.

func (*Email) UnmarshalJSON added in v8.7.1 

func (s *Email) UnmarshalJSON(data []byte) error

type EmailAction 

type EmailAction struct {
	Attachments map[string]EmailAttachmentContainer `json:"attachments,omitempty"`
	Bcc         []string                            `json:"bcc,omitempty"`
	Body        *EmailBody                          `json:"body,omitempty"`
	Cc          []string                            `json:"cc,omitempty"`
	From        *string                             `json:"from,omitempty"`
	Id          *string                             `json:"id,omitempty"`
	Priority    *emailpriority.EmailPriority        `json:"priority,omitempty"`
	ReplyTo     []string                            `json:"reply_to,omitempty"`
	SentDate    DateTime                            `json:"sent_date,omitempty"`
	Subject     string                              `json:"subject"`
	To          []string                            `json:"to"`
}

EmailAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L252-L252

func NewEmailAction added in v8.5.0 

func NewEmailAction() *EmailAction

NewEmailAction returns a EmailAction.

func (*EmailAction) UnmarshalJSON added in v8.7.1 

func (s *EmailAction) UnmarshalJSON(data []byte) error

type EmailAttachmentContainer 

type EmailAttachmentContainer struct {
	Data      *DataEmailAttachment      `json:"data,omitempty"`
	Http      *HttpEmailAttachment      `json:"http,omitempty"`
	Reporting *ReportingEmailAttachment `json:"reporting,omitempty"`
}

EmailAttachmentContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L211-L216

func NewEmailAttachmentContainer added in v8.5.0 

func NewEmailAttachmentContainer() *EmailAttachmentContainer

NewEmailAttachmentContainer returns a EmailAttachmentContainer.

type EmailBody 

type EmailBody struct {
	Html *string `json:"html,omitempty"`
	Text *string `json:"text,omitempty"`
}

EmailBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L192-L195

func NewEmailBody added in v8.5.0 

func NewEmailBody() *EmailBody

NewEmailBody returns a EmailBody.

func (*EmailBody) UnmarshalJSON added in v8.9.0 

func (s *EmailBody) UnmarshalJSON(data []byte) error

type EmailResult 

type EmailResult struct {
	Account *string `json:"account,omitempty"`
	Message Email   `json:"message"`
	Reason  *string `json:"reason,omitempty"`
}

EmailResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L205-L209

func NewEmailResult added in v8.5.0 

func NewEmailResult() *EmailResult

NewEmailResult returns a EmailResult.

func (*EmailResult) UnmarshalJSON added in v8.9.0 

func (s *EmailResult) UnmarshalJSON(data []byte) error

type EmptyObject 

type EmptyObject struct {
}

EmptyObject type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L164-L165

func NewEmptyObject added in v8.5.0 

func NewEmptyObject() *EmptyObject

NewEmptyObject returns a EmptyObject.

type EnglishAnalyzer added in v8.16.0 

type EnglishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

EnglishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L132-L137

func NewEnglishAnalyzer added in v8.16.0 

func NewEnglishAnalyzer() *EnglishAnalyzer

NewEnglishAnalyzer returns a EnglishAnalyzer.

func (EnglishAnalyzer) MarshalJSON added in v8.16.0 

func (s EnglishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*EnglishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *EnglishAnalyzer) UnmarshalJSON(data []byte) error

type EnrichPolicy added in v8.5.0 

type EnrichPolicy struct {
	ElasticsearchVersion *string  `json:"elasticsearch_version,omitempty"`
	EnrichFields         []string `json:"enrich_fields"`
	Indices              []string `json:"indices"`
	MatchField           string   `json:"match_field"`
	Name                 *string  `json:"name,omitempty"`
	Query                *Query   `json:"query,omitempty"`
}

EnrichPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/_types/Policy.ts#L34-L41

func NewEnrichPolicy added in v8.5.0 

func NewEnrichPolicy() *EnrichPolicy

NewEnrichPolicy returns a EnrichPolicy.

func (*EnrichPolicy) UnmarshalJSON added in v8.7.1 

func (s *EnrichPolicy) UnmarshalJSON(data []byte) error

type EnrichProcessor 

type EnrichProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field in the input document that matches the policies match_field used to
	// retrieve the enrichment data.
	// Supports template snippets.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// MaxMatches The maximum number of matched documents to include under the configured
	// target field.
	// The `target_field` will be turned into a json array if `max_matches` is
	// higher than 1, otherwise `target_field` will become a json object.
	// In order to avoid documents getting too large, the maximum allowed value is
	// 128.
	MaxMatches *int `json:"max_matches,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Override If processor will update fields with pre-existing non-null-valued field.
	// When set to `false`, such fields will not be touched.
	Override *bool `json:"override,omitempty"`
	// PolicyName The name of the enrich policy to use.
	PolicyName string `json:"policy_name"`
	// ShapeRelation A spatial relation operator used to match the geoshape of incoming documents
	// to documents in the enrich index.
	// This option is only used for `geo_match` enrich policy types.
	ShapeRelation *geoshaperelation.GeoShapeRelation `json:"shape_relation,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Field added to incoming documents to contain enrich data. This field contains
	// both the `match_field` and `enrich_fields` specified in the enrich policy.
	// Supports template snippets.
	TargetField string `json:"target_field"`
}

EnrichProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L847-L886

func NewEnrichProcessor added in v8.5.0 

func NewEnrichProcessor() *EnrichProcessor

NewEnrichProcessor returns a EnrichProcessor.

func (*EnrichProcessor) UnmarshalJSON added in v8.7.1 

func (s *EnrichProcessor) UnmarshalJSON(data []byte) error

type Ensemble 

type Ensemble struct {
	AggregateOutput      *AggregateOutput `json:"aggregate_output,omitempty"`
	ClassificationLabels []string         `json:"classification_labels,omitempty"`
	FeatureNames         []string         `json:"feature_names,omitempty"`
	TargetType           *string          `json:"target_type,omitempty"`
	TrainedModels        []TrainedModel   `json:"trained_models"`
}

Ensemble type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L93-L99

func NewEnsemble added in v8.5.0 

func NewEnsemble() *Ensemble

NewEnsemble returns a Ensemble.

func (*Ensemble) UnmarshalJSON added in v8.9.0 

func (s *Ensemble) UnmarshalJSON(data []byte) error

type EpochTimeUnitMillis 

type EpochTimeUnitMillis int64

EpochTimeUnitMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L40-L40

type EpochTimeUnitSeconds 

type EpochTimeUnitSeconds int64

EpochTimeUnitSeconds type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Time.ts#L40-L40

type Eql 

type Eql struct {
	Available bool                  `json:"available"`
	Enabled   bool                  `json:"enabled"`
	Features  EqlFeatures           `json:"features"`
	Queries   map[string]XpackQuery `json:"queries"`
}

Eql type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L361-L364

func NewEql added in v8.5.0 

func NewEql() *Eql

NewEql returns a Eql.

func (*Eql) UnmarshalJSON added in v8.7.1 

func (s *Eql) UnmarshalJSON(data []byte) error

type EqlFeatures 

type EqlFeatures struct {
	Event     uint                 `json:"event"`
	Join      uint                 `json:"join"`
	Joins     EqlFeaturesJoin      `json:"joins"`
	Keys      EqlFeaturesKeys      `json:"keys"`
	Pipes     EqlFeaturesPipes     `json:"pipes"`
	Sequence  uint                 `json:"sequence"`
	Sequences EqlFeaturesSequences `json:"sequences"`
}

EqlFeatures type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L96-L104

func NewEqlFeatures added in v8.5.0 

func NewEqlFeatures() *EqlFeatures

NewEqlFeatures returns a EqlFeatures.

type EqlFeaturesJoin 

type EqlFeaturesJoin struct {
	JoinQueriesFiveOrMore uint `json:"join_queries_five_or_more"`
	JoinQueriesFour       uint `json:"join_queries_four"`
	JoinQueriesThree      uint `json:"join_queries_three"`
	JoinQueriesTwo        uint `json:"join_queries_two"`
	JoinUntil             uint `json:"join_until"`
}

EqlFeaturesJoin type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L106-L112

func NewEqlFeaturesJoin added in v8.5.0 

func NewEqlFeaturesJoin() *EqlFeaturesJoin

NewEqlFeaturesJoin returns a EqlFeaturesJoin.

type EqlFeaturesKeys 

type EqlFeaturesKeys struct {
	JoinKeysFiveOrMore uint `json:"join_keys_five_or_more"`
	JoinKeysFour       uint `json:"join_keys_four"`
	JoinKeysOne        uint `json:"join_keys_one"`
	JoinKeysThree      uint `json:"join_keys_three"`
	JoinKeysTwo        uint `json:"join_keys_two"`
}

EqlFeaturesKeys type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L114-L120

func NewEqlFeaturesKeys added in v8.5.0 

func NewEqlFeaturesKeys() *EqlFeaturesKeys

NewEqlFeaturesKeys returns a EqlFeaturesKeys.

type EqlFeaturesPipes 

type EqlFeaturesPipes struct {
	PipeHead uint `json:"pipe_head"`
	PipeTail uint `json:"pipe_tail"`
}

EqlFeaturesPipes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L122-L125

func NewEqlFeaturesPipes added in v8.5.0 

func NewEqlFeaturesPipes() *EqlFeaturesPipes

NewEqlFeaturesPipes returns a EqlFeaturesPipes.

type EqlFeaturesSequences 

type EqlFeaturesSequences struct {
	SequenceMaxspan           uint `json:"sequence_maxspan"`
	SequenceQueriesFiveOrMore uint `json:"sequence_queries_five_or_more"`
	SequenceQueriesFour       uint `json:"sequence_queries_four"`
	SequenceQueriesThree      uint `json:"sequence_queries_three"`
	SequenceQueriesTwo        uint `json:"sequence_queries_two"`
	SequenceUntil             uint `json:"sequence_until"`
}

EqlFeaturesSequences type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L127-L134

func NewEqlFeaturesSequences added in v8.5.0 

func NewEqlFeaturesSequences() *EqlFeaturesSequences

NewEqlFeaturesSequences returns a EqlFeaturesSequences.

type EqlHits 

type EqlHits struct {
	// Events Contains events matching the query. Each object represents a matching event.
	Events []HitsEvent `json:"events,omitempty"`
	// Sequences Contains event sequences matching the query. Each object represents a
	// matching sequence. This parameter is only returned for EQL queries containing
	// a sequence.
	Sequences []HitsSequence `json:"sequences,omitempty"`
	// Total Metadata about the number of matching events or sequences.
	Total *TotalHits `json:"total,omitempty"`
}

EqlHits type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/eql/_types/EqlHits.ts#L25-L39

func NewEqlHits added in v8.5.0 

func NewEqlHits() *EqlHits

NewEqlHits returns a EqlHits.

type ErrorCause 

type ErrorCause struct {
	CausedBy *ErrorCause                `json:"caused_by,omitempty"`
	Metadata map[string]json.RawMessage `json:"-"`
	// Reason A human-readable explanation of the error, in English.
	Reason    *string      `json:"reason,omitempty"`
	RootCause []ErrorCause `json:"root_cause,omitempty"`
	// StackTrace The server stack trace. Present only if the `error_trace=true` parameter was
	// sent with the request.
	StackTrace *string      `json:"stack_trace,omitempty"`
	Suppressed []ErrorCause `json:"suppressed,omitempty"`
	// Type The type of error
	Type string `json:"type"`
}

ErrorCause type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Errors.ts#L25-L50

func NewErrorCause added in v8.5.0 

func NewErrorCause() *ErrorCause

NewErrorCause returns a ErrorCause.

func (ErrorCause) MarshalJSON 

func (s ErrorCause) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ErrorCause) UnmarshalJSON added in v8.9.0 

func (s *ErrorCause) UnmarshalJSON(data []byte) error

type ErrorResponseBase 

type ErrorResponseBase struct {
	Error  ErrorCause `json:"error"`
	Status int        `json:"status"`
}

ErrorResponseBase type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Base.ts#L127-L136

func NewErrorResponseBase added in v8.12.0 

func NewErrorResponseBase() *ErrorResponseBase

NewErrorResponseBase returns a ErrorResponseBase.

func (*ErrorResponseBase) UnmarshalJSON added in v8.12.0 

func (s *ErrorResponseBase) UnmarshalJSON(data []byte) error

type EsqlResult added in v8.18.0 

type EsqlResult []byte

EsqlResult type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Binary.ts#L24-L24

type EstonianAnalyzer added in v8.16.0 

type EstonianAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

EstonianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L139-L143

func NewEstonianAnalyzer added in v8.16.0 

func NewEstonianAnalyzer() *EstonianAnalyzer

NewEstonianAnalyzer returns a EstonianAnalyzer.

func (EstonianAnalyzer) MarshalJSON added in v8.16.0 

func (s EstonianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*EstonianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *EstonianAnalyzer) UnmarshalJSON(data []byte) error

type EventDataStream added in v8.8.0 

type EventDataStream struct {
	Name string `json:"name"`
}

EventDataStream type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/search_application/_types/BehavioralAnalytics.ts#L29-L31

func NewEventDataStream added in v8.8.0 

func NewEventDataStream() *EventDataStream

NewEventDataStream returns a EventDataStream.

func (*EventDataStream) UnmarshalJSON added in v8.8.0 

func (s *EventDataStream) UnmarshalJSON(data []byte) error

type EwmaModelSettings 

type EwmaModelSettings struct {
	Alpha *float32 `json:"alpha,omitempty"`
}

EwmaModelSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L293-L295

func NewEwmaModelSettings added in v8.5.0 

func NewEwmaModelSettings() *EwmaModelSettings

NewEwmaModelSettings returns a EwmaModelSettings.

func (*EwmaModelSettings) UnmarshalJSON added in v8.7.1 

func (s *EwmaModelSettings) UnmarshalJSON(data []byte) error

type EwmaMovingAverageAggregation 

type EwmaMovingAverageAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	Minimize  *bool                `json:"minimize,omitempty"`
	Model     string               `json:"model,omitempty"`
	Predict   *int                 `json:"predict,omitempty"`
	Settings  EwmaModelSettings    `json:"settings"`
	Window    *int                 `json:"window,omitempty"`
}

EwmaMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L278-L281

func NewEwmaMovingAverageAggregation added in v8.5.0 

func NewEwmaMovingAverageAggregation() *EwmaMovingAverageAggregation

NewEwmaMovingAverageAggregation returns a EwmaMovingAverageAggregation.

func (EwmaMovingAverageAggregation) MarshalJSON added in v8.9.0 

func (s EwmaMovingAverageAggregation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*EwmaMovingAverageAggregation) UnmarshalJSON added in v8.7.0 

func (s *EwmaMovingAverageAggregation) UnmarshalJSON(data []byte) error

type ExecuteEnrichPolicyStatus 

type ExecuteEnrichPolicyStatus struct {
	Phase enrichpolicyphase.EnrichPolicyPhase `json:"phase"`
	Step  *string                             `json:"step,omitempty"`
}

ExecuteEnrichPolicyStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/execute_policy/types.ts#L20-L23

func NewExecuteEnrichPolicyStatus added in v8.5.0 

func NewExecuteEnrichPolicyStatus() *ExecuteEnrichPolicyStatus

NewExecuteEnrichPolicyStatus returns a ExecuteEnrichPolicyStatus.

func (*ExecuteEnrichPolicyStatus) UnmarshalJSON added in v8.18.0 

func (s *ExecuteEnrichPolicyStatus) UnmarshalJSON(data []byte) error

type ExecutingPolicy 

type ExecutingPolicy struct {
	Name string   `json:"name"`
	Task TaskInfo `json:"task"`
}

ExecutingPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/stats/types.ts#L25-L28

func NewExecutingPolicy added in v8.5.0 

func NewExecutingPolicy() *ExecutingPolicy

NewExecutingPolicy returns a ExecutingPolicy.

func (*ExecutingPolicy) UnmarshalJSON added in v8.7.1 

func (s *ExecutingPolicy) UnmarshalJSON(data []byte) error

type ExecutionResult 

type ExecutionResult struct {
	Actions           []ExecutionResultAction  `json:"actions"`
	Condition         ExecutionResultCondition `json:"condition"`
	ExecutionDuration int64                    `json:"execution_duration"`
	ExecutionTime     DateTime                 `json:"execution_time"`
	Input             ExecutionResultInput     `json:"input"`
}

ExecutionResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Execution.ts#L60-L66

func NewExecutionResult added in v8.5.0 

func NewExecutionResult() *ExecutionResult

NewExecutionResult returns a ExecutionResult.

func (*ExecutionResult) UnmarshalJSON added in v8.7.1 

func (s *ExecutionResult) UnmarshalJSON(data []byte) error

type ExecutionResultAction 

type ExecutionResultAction struct {
	Email     *EmailResult                            `json:"email,omitempty"`
	Error     *ErrorCause                             `json:"error,omitempty"`
	Id        string                                  `json:"id"`
	Index     *IndexResult                            `json:"index,omitempty"`
	Logging   *LoggingResult                          `json:"logging,omitempty"`
	Pagerduty *PagerDutyResult                        `json:"pagerduty,omitempty"`
	Reason    *string                                 `json:"reason,omitempty"`
	Slack     *SlackResult                            `json:"slack,omitempty"`
	Status    actionstatusoptions.ActionStatusOptions `json:"status"`
	Type      actiontype.ActionType                   `json:"type"`
	Webhook   *WebhookResult                          `json:"webhook,omitempty"`
}

ExecutionResultAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Execution.ts#L74-L86

func NewExecutionResultAction added in v8.5.0 

func NewExecutionResultAction() *ExecutionResultAction

NewExecutionResultAction returns a ExecutionResultAction.

func (*ExecutionResultAction) UnmarshalJSON added in v8.7.1 

func (s *ExecutionResultAction) UnmarshalJSON(data []byte) error

type ExecutionResultCondition 

type ExecutionResultCondition struct {
	Met    bool                                    `json:"met"`
	Status actionstatusoptions.ActionStatusOptions `json:"status"`
	Type   conditiontype.ConditionType             `json:"type"`
}

ExecutionResultCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Execution.ts#L68-L72

func NewExecutionResultCondition added in v8.5.0 

func NewExecutionResultCondition() *ExecutionResultCondition

NewExecutionResultCondition returns a ExecutionResultCondition.

func (*ExecutionResultCondition) UnmarshalJSON added in v8.7.1 

func (s *ExecutionResultCondition) UnmarshalJSON(data []byte) error

type ExecutionResultInput 

type ExecutionResultInput struct {
	Payload map[string]json.RawMessage              `json:"payload"`
	Status  actionstatusoptions.ActionStatusOptions `json:"status"`
	Type    inputtype.InputType                     `json:"type"`
}

ExecutionResultInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Execution.ts#L88-L92

func NewExecutionResultInput added in v8.5.0 

func NewExecutionResultInput() *ExecutionResultInput

NewExecutionResultInput returns a ExecutionResultInput.

type ExecutionState 

type ExecutionState struct {
	Reason     *string  `json:"reason,omitempty"`
	Successful bool     `json:"successful"`
	Timestamp  DateTime `json:"timestamp"`
}

ExecutionState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L114-L118

func NewExecutionState added in v8.5.0 

func NewExecutionState() *ExecutionState

NewExecutionState returns a ExecutionState.

func (*ExecutionState) UnmarshalJSON added in v8.7.1 

func (s *ExecutionState) UnmarshalJSON(data []byte) error

type ExecutionThreadPool 

type ExecutionThreadPool struct {
	// MaxSize The largest size of the execution thread pool, which indicates the largest
	// number of concurrent running watches.
	MaxSize int64 `json:"max_size"`
	// QueueSize The number of watches that were triggered and are currently queued.
	QueueSize int64 `json:"queue_size"`
}

ExecutionThreadPool type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Execution.ts#L94-L103

func NewExecutionThreadPool added in v8.5.0 

func NewExecutionThreadPool() *ExecutionThreadPool

NewExecutionThreadPool returns a ExecutionThreadPool.

func (*ExecutionThreadPool) UnmarshalJSON added in v8.7.1 

func (s *ExecutionThreadPool) UnmarshalJSON(data []byte) error

type ExistsQuery 

type ExistsQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field you wish to search.
	Field      string  `json:"field"`
	QueryName_ *string `json:"_name,omitempty"`
}

ExistsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L38-L46

func NewExistsQuery added in v8.5.0 

func NewExistsQuery() *ExistsQuery

NewExistsQuery returns a ExistsQuery.

func (*ExistsQuery) UnmarshalJSON added in v8.7.1 

func (s *ExistsQuery) UnmarshalJSON(data []byte) error

type ExpandWildcards 

type ExpandWildcards []expandwildcard.ExpandWildcard

ExpandWildcards type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L221-L221

type ExplainAnalyzeToken 

type ExplainAnalyzeToken struct {
	Bytes               string                     `json:"bytes"`
	EndOffset           int64                      `json:"end_offset"`
	ExplainAnalyzeToken map[string]json.RawMessage `json:"-"`
	Keyword             *bool                      `json:"keyword,omitempty"`
	Position            int64                      `json:"position"`
	PositionLength      int64                      `json:"positionLength"`
	StartOffset         int64                      `json:"start_offset"`
	TermFrequency       int64                      `json:"termFrequency"`
	Token               string                     `json:"token"`
	Type                string                     `json:"type"`
}

ExplainAnalyzeToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L52-L67

func NewExplainAnalyzeToken added in v8.5.0 

func NewExplainAnalyzeToken() *ExplainAnalyzeToken

NewExplainAnalyzeToken returns a ExplainAnalyzeToken.

func (ExplainAnalyzeToken) MarshalJSON 

func (s ExplainAnalyzeToken) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ExplainAnalyzeToken) UnmarshalJSON added in v8.7.1 

func (s *ExplainAnalyzeToken) UnmarshalJSON(data []byte) error

type Explanation 

type Explanation struct {
	Description string              `json:"description"`
	Details     []ExplanationDetail `json:"details"`
	Value       float32             `json:"value"`
}

Explanation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/explain/types.ts#L22-L26

func NewExplanation added in v8.5.0 

func NewExplanation() *Explanation

NewExplanation returns a Explanation.

func (*Explanation) UnmarshalJSON added in v8.7.1 

func (s *Explanation) UnmarshalJSON(data []byte) error

type ExplanationDetail 

type ExplanationDetail struct {
	Description string              `json:"description"`
	Details     []ExplanationDetail `json:"details,omitempty"`
	Value       float32             `json:"value"`
}

ExplanationDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/explain/types.ts#L28-L32

func NewExplanationDetail added in v8.5.0 

func NewExplanationDetail() *ExplanationDetail

NewExplanationDetail returns a ExplanationDetail.

func (*ExplanationDetail) UnmarshalJSON added in v8.7.1 

func (s *ExplanationDetail) UnmarshalJSON(data []byte) error

type ExploreControls 

type ExploreControls struct {
	// SampleDiversity To avoid the top-matching documents sample being dominated by a single source
	// of results, it is sometimes necessary to request diversity in the sample.
	// You can do this by selecting a single-value field and setting a maximum
	// number of documents per value for that field.
	SampleDiversity *SampleDiversity `json:"sample_diversity,omitempty"`
	// SampleSize Each hop considers a sample of the best-matching documents on each shard.
	// Using samples improves the speed of execution and keeps exploration focused
	// on meaningfully-connected terms.
	// Very small values (less than 50) might not provide sufficient
	// weight-of-evidence to identify significant connections between terms.
	// Very large sample sizes can dilute the quality of the results and increase
	// execution times.
	SampleSize *int `json:"sample_size,omitempty"`
	// Timeout The length of time in milliseconds after which exploration will be halted and
	// the results gathered so far are returned.
	// This timeout is honored on a best-effort basis.
	// Execution might overrun this timeout if, for example, a long pause is
	// encountered while FieldData is loaded for a field.
	Timeout Duration `json:"timeout,omitempty"`
	// UseSignificance Filters associated terms so only those that are significantly associated with
	// your query are included.
	UseSignificance bool `json:"use_significance"`
}

ExploreControls type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/ExploreControls.ts#L24-L49

func NewExploreControls added in v8.5.0 

func NewExploreControls() *ExploreControls

NewExploreControls returns a ExploreControls.

func (*ExploreControls) UnmarshalJSON added in v8.7.1 

func (s *ExploreControls) UnmarshalJSON(data []byte) error

type ExponentialAverageCalculationContext added in v8.17.0 

type ExponentialAverageCalculationContext struct {
	IncrementalMetricValueMs     Float64 `json:"incremental_metric_value_ms"`
	LatestTimestamp              *int64  `json:"latest_timestamp,omitempty"`
	PreviousExponentialAverageMs Float64 `json:"previous_exponential_average_ms,omitempty"`
}

ExponentialAverageCalculationContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L204-L208

func NewExponentialAverageCalculationContext added in v8.17.0 

func NewExponentialAverageCalculationContext() *ExponentialAverageCalculationContext

NewExponentialAverageCalculationContext returns a ExponentialAverageCalculationContext.

func (*ExponentialAverageCalculationContext) UnmarshalJSON added in v8.17.0 

func (s *ExponentialAverageCalculationContext) UnmarshalJSON(data []byte) error

type ExtendedBoundsFieldDateMath 

type ExtendedBoundsFieldDateMath struct {
	// Max Maximum value for the bound.
	Max FieldDateMath `json:"max,omitempty"`
	// Min Minimum value for the bound.
	Min FieldDateMath `json:"min,omitempty"`
}

ExtendedBoundsFieldDateMath type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L508-L517

func NewExtendedBoundsFieldDateMath added in v8.5.0 

func NewExtendedBoundsFieldDateMath() *ExtendedBoundsFieldDateMath

NewExtendedBoundsFieldDateMath returns a ExtendedBoundsFieldDateMath.

func (*ExtendedBoundsFieldDateMath) UnmarshalJSON added in v8.7.1 

func (s *ExtendedBoundsFieldDateMath) UnmarshalJSON(data []byte) error

type ExtendedBoundsdouble 

type ExtendedBoundsdouble struct {
	// Max Maximum value for the bound.
	Max *Float64 `json:"max,omitempty"`
	// Min Minimum value for the bound.
	Min *Float64 `json:"min,omitempty"`
}

ExtendedBoundsdouble type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L508-L517

func NewExtendedBoundsdouble added in v8.5.0 

func NewExtendedBoundsdouble() *ExtendedBoundsdouble

NewExtendedBoundsdouble returns a ExtendedBoundsdouble.

func (*ExtendedBoundsdouble) UnmarshalJSON added in v8.7.1 

func (s *ExtendedBoundsdouble) UnmarshalJSON(data []byte) error

type ExtendedMemoryStats 

type ExtendedMemoryStats struct {
	// AdjustedTotalInBytes If the amount of physical memory has been overridden using the
	// `es`.`total_memory_bytes` system property then this reports the overridden
	// value in bytes.
	// Otherwise it reports the same value as `total_in_bytes`.
	AdjustedTotalInBytes *int64 `json:"adjusted_total_in_bytes,omitempty"`
	// FreeInBytes Amount of free physical memory in bytes.
	FreeInBytes *int64 `json:"free_in_bytes,omitempty"`
	// FreePercent Percentage of free memory.
	FreePercent     *int    `json:"free_percent,omitempty"`
	Resident        *string `json:"resident,omitempty"`
	ResidentInBytes *int64  `json:"resident_in_bytes,omitempty"`
	Share           *string `json:"share,omitempty"`
	ShareInBytes    *int64  `json:"share_in_bytes,omitempty"`
	// TotalInBytes Total amount of physical memory in bytes.
	TotalInBytes        *int64  `json:"total_in_bytes,omitempty"`
	TotalVirtual        *string `json:"total_virtual,omitempty"`
	TotalVirtualInBytes *int64  `json:"total_virtual_in_bytes,omitempty"`
	// UsedInBytes Amount of used physical memory in bytes.
	UsedInBytes *int64 `json:"used_in_bytes,omitempty"`
	// UsedPercent Percentage of used memory.
	UsedPercent *int `json:"used_percent,omitempty"`
}

ExtendedMemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L658-L667

func NewExtendedMemoryStats added in v8.5.0 

func NewExtendedMemoryStats() *ExtendedMemoryStats

NewExtendedMemoryStats returns a ExtendedMemoryStats.

func (*ExtendedMemoryStats) UnmarshalJSON added in v8.7.1 

func (s *ExtendedMemoryStats) UnmarshalJSON(data []byte) error

type ExtendedStatsAggregate 

type ExtendedStatsAggregate struct {
	Avg                        *Float64                         `json:"avg,omitempty"`
	AvgAsString                *string                          `json:"avg_as_string,omitempty"`
	Count                      int64                            `json:"count"`
	Max                        *Float64                         `json:"max,omitempty"`
	MaxAsString                *string                          `json:"max_as_string,omitempty"`
	Meta                       Metadata                         `json:"meta,omitempty"`
	Min                        *Float64                         `json:"min,omitempty"`
	MinAsString                *string                          `json:"min_as_string,omitempty"`
	StdDeviation               *Float64                         `json:"std_deviation,omitempty"`
	StdDeviationAsString       *string                          `json:"std_deviation_as_string,omitempty"`
	StdDeviationBounds         *StandardDeviationBounds         `json:"std_deviation_bounds,omitempty"`
	StdDeviationBoundsAsString *StandardDeviationBoundsAsString `json:"std_deviation_bounds_as_string,omitempty"`
	StdDeviationPopulation     *Float64                         `json:"std_deviation_population,omitempty"`
	StdDeviationSampling       *Float64                         `json:"std_deviation_sampling,omitempty"`
	Sum                        Float64                          `json:"sum"`
	SumAsString                *string                          `json:"sum_as_string,omitempty"`
	SumOfSquares               *Float64                         `json:"sum_of_squares,omitempty"`
	SumOfSquaresAsString       *string                          `json:"sum_of_squares_as_string,omitempty"`
	Variance                   *Float64                         `json:"variance,omitempty"`
	VarianceAsString           *string                          `json:"variance_as_string,omitempty"`
	VariancePopulation         *Float64                         `json:"variance_population,omitempty"`
	VariancePopulationAsString *string                          `json:"variance_population_as_string,omitempty"`
	VarianceSampling           *Float64                         `json:"variance_sampling,omitempty"`
	VarianceSamplingAsString   *string                          `json:"variance_sampling_as_string,omitempty"`
}

ExtendedStatsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L299-L320

func NewExtendedStatsAggregate added in v8.5.0 

func NewExtendedStatsAggregate() *ExtendedStatsAggregate

NewExtendedStatsAggregate returns a ExtendedStatsAggregate.

func (*ExtendedStatsAggregate) UnmarshalJSON added in v8.7.1 

func (s *ExtendedStatsAggregate) UnmarshalJSON(data []byte) error

type ExtendedStatsAggregation 

type ExtendedStatsAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// Sigma The number of standard deviations above/below the mean to display.
	Sigma *Float64 `json:"sigma,omitempty"`
}

ExtendedStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L101-L106

func NewExtendedStatsAggregation added in v8.5.0 

func NewExtendedStatsAggregation() *ExtendedStatsAggregation

NewExtendedStatsAggregation returns a ExtendedStatsAggregation.

func (*ExtendedStatsAggregation) UnmarshalJSON added in v8.7.1 

func (s *ExtendedStatsAggregation) UnmarshalJSON(data []byte) error

type ExtendedStatsBucketAggregate 

type ExtendedStatsBucketAggregate struct {
	Avg                        *Float64                         `json:"avg,omitempty"`
	AvgAsString                *string                          `json:"avg_as_string,omitempty"`
	Count                      int64                            `json:"count"`
	Max                        *Float64                         `json:"max,omitempty"`
	MaxAsString                *string                          `json:"max_as_string,omitempty"`
	Meta                       Metadata                         `json:"meta,omitempty"`
	Min                        *Float64                         `json:"min,omitempty"`
	MinAsString                *string                          `json:"min_as_string,omitempty"`
	StdDeviation               *Float64                         `json:"std_deviation,omitempty"`
	StdDeviationAsString       *string                          `json:"std_deviation_as_string,omitempty"`
	StdDeviationBounds         *StandardDeviationBounds         `json:"std_deviation_bounds,omitempty"`
	StdDeviationBoundsAsString *StandardDeviationBoundsAsString `json:"std_deviation_bounds_as_string,omitempty"`
	StdDeviationPopulation     *Float64                         `json:"std_deviation_population,omitempty"`
	StdDeviationSampling       *Float64                         `json:"std_deviation_sampling,omitempty"`
	Sum                        Float64                          `json:"sum"`
	SumAsString                *string                          `json:"sum_as_string,omitempty"`
	SumOfSquares               *Float64                         `json:"sum_of_squares,omitempty"`
	SumOfSquaresAsString       *string                          `json:"sum_of_squares_as_string,omitempty"`
	Variance                   *Float64                         `json:"variance,omitempty"`
	VarianceAsString           *string                          `json:"variance_as_string,omitempty"`
	VariancePopulation         *Float64                         `json:"variance_population,omitempty"`
	VariancePopulationAsString *string                          `json:"variance_population_as_string,omitempty"`
	VarianceSampling           *Float64                         `json:"variance_sampling,omitempty"`
	VarianceSamplingAsString   *string                          `json:"variance_sampling_as_string,omitempty"`
}

ExtendedStatsBucketAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L322-L323

func NewExtendedStatsBucketAggregate added in v8.5.0 

func NewExtendedStatsBucketAggregate() *ExtendedStatsBucketAggregate

NewExtendedStatsBucketAggregate returns a ExtendedStatsBucketAggregate.

func (*ExtendedStatsBucketAggregate) UnmarshalJSON added in v8.7.1 

func (s *ExtendedStatsBucketAggregate) UnmarshalJSON(data []byte) error

type ExtendedStatsBucketAggregation 

type ExtendedStatsBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Sigma The number of standard deviations above/below the mean to display.
	Sigma *Float64 `json:"sigma,omitempty"`
}

ExtendedStatsBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L218-L223

func NewExtendedStatsBucketAggregation added in v8.5.0 

func NewExtendedStatsBucketAggregation() *ExtendedStatsBucketAggregation

NewExtendedStatsBucketAggregation returns a ExtendedStatsBucketAggregation.

func (*ExtendedStatsBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *ExtendedStatsBucketAggregation) UnmarshalJSON(data []byte) error

type FailProcessor 

type FailProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// Message The error message thrown by the processor.
	// Supports template snippets.
	Message string `json:"message"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

FailProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L888-L894

func NewFailProcessor added in v8.5.0 

func NewFailProcessor() *FailProcessor

NewFailProcessor returns a FailProcessor.

func (*FailProcessor) UnmarshalJSON added in v8.7.1 

func (s *FailProcessor) UnmarshalJSON(data []byte) error

type FailureStore added in v8.16.0 

type FailureStore struct {
	Enabled         bool              `json:"enabled"`
	Indices         []DataStreamIndex `json:"indices"`
	RolloverOnWrite bool              `json:"rollover_on_write"`
}

FailureStore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/DataStream.ts#L39-L43

func NewFailureStore added in v8.16.0 

func NewFailureStore() *FailureStore

NewFailureStore returns a FailureStore.

func (*FailureStore) UnmarshalJSON added in v8.16.0 

func (s *FailureStore) UnmarshalJSON(data []byte) error

type Feature 

type Feature struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

Feature type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/features/_types/Feature.ts#L20-L23

func NewFeature added in v8.5.0 

func NewFeature() *Feature

NewFeature returns a Feature.

func (*Feature) UnmarshalJSON added in v8.9.0 

func (s *Feature) UnmarshalJSON(data []byte) error

type FeatureEnabled added in v8.15.0 

type FeatureEnabled struct {
	Enabled bool `json:"enabled"`
}

FeatureEnabled type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L215-L217

func NewFeatureEnabled added in v8.15.0 

func NewFeatureEnabled() *FeatureEnabled

NewFeatureEnabled returns a FeatureEnabled.

func (*FeatureEnabled) UnmarshalJSON added in v8.15.0 

func (s *FeatureEnabled) UnmarshalJSON(data []byte) error

type FeatureExtractor added in v8.18.0 

type FeatureExtractor QueryFeatureExtractor

FeatureExtractor type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L93-L96

type FeatureToggle 

type FeatureToggle struct {
	Enabled bool `json:"enabled"`
}

FeatureToggle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L37-L39

func NewFeatureToggle added in v8.5.0 

func NewFeatureToggle() *FeatureToggle

NewFeatureToggle returns a FeatureToggle.

func (*FeatureToggle) UnmarshalJSON added in v8.7.1 

func (s *FeatureToggle) UnmarshalJSON(data []byte) error

type Features 

type Features []feature.Feature

Features type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get/IndicesGetRequest.ts#L103-L103

type FetchProfile 

type FetchProfile struct {
	Breakdown   FetchProfileBreakdown `json:"breakdown"`
	Children    []FetchProfile        `json:"children,omitempty"`
	Debug       *FetchProfileDebug    `json:"debug,omitempty"`
	Description string                `json:"description"`
	TimeInNanos int64                 `json:"time_in_nanos"`
	Type        string                `json:"type"`
}

FetchProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L230-L237

func NewFetchProfile added in v8.5.0 

func NewFetchProfile() *FetchProfile

NewFetchProfile returns a FetchProfile.

func (*FetchProfile) UnmarshalJSON added in v8.7.1 

func (s *FetchProfile) UnmarshalJSON(data []byte) error

type FetchProfileBreakdown 

type FetchProfileBreakdown struct {
	LoadSource            *int `json:"load_source,omitempty"`
	LoadSourceCount       *int `json:"load_source_count,omitempty"`
	LoadStoredFields      *int `json:"load_stored_fields,omitempty"`
	LoadStoredFieldsCount *int `json:"load_stored_fields_count,omitempty"`
	NextReader            *int `json:"next_reader,omitempty"`
	NextReaderCount       *int `json:"next_reader_count,omitempty"`
	Process               *int `json:"process,omitempty"`
	ProcessCount          *int `json:"process_count,omitempty"`
}

FetchProfileBreakdown type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L239-L248

func NewFetchProfileBreakdown added in v8.5.0 

func NewFetchProfileBreakdown() *FetchProfileBreakdown

NewFetchProfileBreakdown returns a FetchProfileBreakdown.

func (*FetchProfileBreakdown) UnmarshalJSON added in v8.7.1 

func (s *FetchProfileBreakdown) UnmarshalJSON(data []byte) error

type FetchProfileDebug 

type FetchProfileDebug struct {
	FastPath     *int     `json:"fast_path,omitempty"`
	StoredFields []string `json:"stored_fields,omitempty"`
}

FetchProfileDebug type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L250-L253

func NewFetchProfileDebug added in v8.5.0 

func NewFetchProfileDebug() *FetchProfileDebug

NewFetchProfileDebug returns a FetchProfileDebug.

func (*FetchProfileDebug) UnmarshalJSON added in v8.7.1 

func (s *FetchProfileDebug) UnmarshalJSON(data []byte) error

type FieldAliasProperty 

type FieldAliasProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Path                *string                                          `json:"path,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

FieldAliasProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L64-L67

func NewFieldAliasProperty added in v8.5.0 

func NewFieldAliasProperty() *FieldAliasProperty

NewFieldAliasProperty returns a FieldAliasProperty.

func (FieldAliasProperty) MarshalJSON added in v8.9.0 

func (s FieldAliasProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FieldAliasProperty) UnmarshalJSON added in v8.7.0 

func (s *FieldAliasProperty) UnmarshalJSON(data []byte) error

type FieldAndFormat 

type FieldAndFormat struct {
	// Field A wildcard pattern. The request returns values for field names matching this
	// pattern.
	Field string `json:"field"`
	// Format The format in which the values are returned.
	Format          *string `json:"format,omitempty"`
	IncludeUnmapped *bool   `json:"include_unmapped,omitempty"`
}

FieldAndFormat type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/abstractions.ts#L535-L549

func NewFieldAndFormat added in v8.5.0 

func NewFieldAndFormat() *FieldAndFormat

NewFieldAndFormat returns a FieldAndFormat.

func (*FieldAndFormat) UnmarshalJSON added in v8.7.1 

func (s *FieldAndFormat) UnmarshalJSON(data []byte) error

type FieldCapability 

type FieldCapability struct {
	// Aggregatable Whether this field can be aggregated on all indices.
	Aggregatable bool `json:"aggregatable"`
	// Indices The list of indices where this field has the same type family, or null if all
	// indices have the same type family for the field.
	Indices []string `json:"indices,omitempty"`
	// Meta Merged metadata across all indices as a map of string keys to arrays of
	// values. A value length of 1 indicates that all indices had the same value for
	// this key, while a length of 2 or more indicates that not all indices had the
	// same value for this key.
	Meta Metadata `json:"meta,omitempty"`
	// MetadataField Whether this field is registered as a metadata field.
	MetadataField *bool `json:"metadata_field,omitempty"`
	// MetricConflictsIndices The list of indices where this field is present if these indices
	// don’t have the same `time_series_metric` value for this field.
	MetricConflictsIndices []string `json:"metric_conflicts_indices,omitempty"`
	// NonAggregatableIndices The list of indices where this field is not aggregatable, or null if all
	// indices have the same definition for the field.
	NonAggregatableIndices []string `json:"non_aggregatable_indices,omitempty"`
	// NonDimensionIndices If this list is present in response then some indices have the
	// field marked as a dimension and other indices, the ones in this list, do not.
	NonDimensionIndices []string `json:"non_dimension_indices,omitempty"`
	// NonSearchableIndices The list of indices where this field is not searchable, or null if all
	// indices have the same definition for the field.
	NonSearchableIndices []string `json:"non_searchable_indices,omitempty"`
	// Searchable Whether this field is indexed for search on all indices.
	Searchable bool `json:"searchable"`
	// TimeSeriesDimension Whether this field is used as a time series dimension.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric Contains metric type if this fields is used as a time series
	// metrics, absent if the field is not used as metric.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type"`
}

FieldCapability type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/field_caps/types.ts#L23-L81

func NewFieldCapability added in v8.5.0 

func NewFieldCapability() *FieldCapability

NewFieldCapability returns a FieldCapability.

func (*FieldCapability) UnmarshalJSON added in v8.7.1 

func (s *FieldCapability) UnmarshalJSON(data []byte) error

type FieldCollapse 

type FieldCollapse struct {
	Collapse *FieldCollapse `json:"collapse,omitempty"`
	// Field The field to collapse the result set on
	Field string `json:"field"`
	// InnerHits The number of inner hits and their sort order
	InnerHits []InnerHits `json:"inner_hits,omitempty"`
	// MaxConcurrentGroupSearches The number of concurrent requests allowed to retrieve the inner_hits per
	// group
	MaxConcurrentGroupSearches *int `json:"max_concurrent_group_searches,omitempty"`
}

FieldCollapse type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/FieldCollapse.ts#L24-L41

func NewFieldCollapse added in v8.5.0 

func NewFieldCollapse() *FieldCollapse

NewFieldCollapse returns a FieldCollapse.

func (*FieldCollapse) UnmarshalJSON added in v8.7.1 

func (s *FieldCollapse) UnmarshalJSON(data []byte) error

type FieldDateMath 

type FieldDateMath any

FieldDateMath holds the union for the following types: 

string
Float64

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L309-L316

type FieldLookup 

type FieldLookup struct {
	// Id `id` of the document.
	Id string `json:"id"`
	// Index Index from which to retrieve the document.
	Index *string `json:"index,omitempty"`
	// Path Name of the field.
	Path *string `json:"path,omitempty"`
	// Routing Custom routing value.
	Routing *string `json:"routing,omitempty"`
}

FieldLookup type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/abstractions.ts#L436-L453

func NewFieldLookup added in v8.5.0 

func NewFieldLookup() *FieldLookup

NewFieldLookup returns a FieldLookup.

func (*FieldLookup) UnmarshalJSON added in v8.7.1 

func (s *FieldLookup) UnmarshalJSON(data []byte) error

type FieldMapping 

type FieldMapping struct {
	FullName string              `json:"full_name"`
	Mapping  map[string]Property `json:"mapping"`
}

FieldMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L24-L27

func NewFieldMapping added in v8.5.0 

func NewFieldMapping() *FieldMapping

NewFieldMapping returns a FieldMapping.

func (*FieldMapping) UnmarshalJSON added in v8.7.0 

func (s *FieldMapping) UnmarshalJSON(data []byte) error

type FieldMemoryUsage 

type FieldMemoryUsage struct {
	MemorySize        ByteSize `json:"memory_size,omitempty"`
	MemorySizeInBytes int64    `json:"memory_size_in_bytes"`
}

FieldMemoryUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L121-L124

func NewFieldMemoryUsage added in v8.5.0 

func NewFieldMemoryUsage() *FieldMemoryUsage

NewFieldMemoryUsage returns a FieldMemoryUsage.

func (*FieldMemoryUsage) UnmarshalJSON added in v8.7.1 

func (s *FieldMemoryUsage) UnmarshalJSON(data []byte) error

type FieldMetric 

type FieldMetric struct {
	// Field The field to collect metrics for. This must be a numeric of some kind.
	Field string `json:"field"`
	// Metrics An array of metrics to collect for the field. At least one metric must be
	// configured.
	Metrics []metric.Metric `json:"metrics"`
}

FieldMetric type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/_types/Metric.ts#L30-L35

func NewFieldMetric added in v8.5.0 

func NewFieldMetric() *FieldMetric

NewFieldMetric returns a FieldMetric.

func (*FieldMetric) UnmarshalJSON added in v8.7.1 

func (s *FieldMetric) UnmarshalJSON(data []byte) error

type FieldNamesField 

type FieldNamesField struct {
	Enabled bool `json:"enabled"`
}

FieldNamesField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L42-L44

func NewFieldNamesField added in v8.5.0 

func NewFieldNamesField() *FieldNamesField

NewFieldNamesField returns a FieldNamesField.

func (*FieldNamesField) UnmarshalJSON added in v8.7.1 

func (s *FieldNamesField) UnmarshalJSON(data []byte) error

type FieldRule 

type FieldRule struct {
	Dn       []string `json:"dn,omitempty"`
	Groups   []string `json:"groups,omitempty"`
	Username []string `json:"username,omitempty"`
}

FieldRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleMappingRule.ts#L35-L43

func NewFieldRule added in v8.5.0 

func NewFieldRule() *FieldRule

NewFieldRule returns a FieldRule.

func (*FieldRule) UnmarshalJSON added in v8.7.1 

func (s *FieldRule) UnmarshalJSON(data []byte) error

type FieldSecurity 

type FieldSecurity struct {
	Except []string `json:"except,omitempty"`
	Grant  []string `json:"grant,omitempty"`
}

FieldSecurity type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/FieldSecurity.ts#L22-L25

func NewFieldSecurity added in v8.5.0 

func NewFieldSecurity() *FieldSecurity

NewFieldSecurity returns a FieldSecurity.

func (*FieldSecurity) UnmarshalJSON added in v8.7.1 

func (s *FieldSecurity) UnmarshalJSON(data []byte) error

type FieldSizeUsage 

type FieldSizeUsage struct {
	Size        ByteSize `json:"size,omitempty"`
	SizeInBytes int64    `json:"size_in_bytes"`
}

FieldSizeUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L95-L98

func NewFieldSizeUsage added in v8.5.0 

func NewFieldSizeUsage() *FieldSizeUsage

NewFieldSizeUsage returns a FieldSizeUsage.

func (*FieldSizeUsage) UnmarshalJSON added in v8.7.1 

func (s *FieldSizeUsage) UnmarshalJSON(data []byte) error

type FieldSort 

type FieldSort struct {
	Format       *string                                    `json:"format,omitempty"`
	Missing      Missing                                    `json:"missing,omitempty"`
	Mode         *sortmode.SortMode                         `json:"mode,omitempty"`
	Nested       *NestedSortValue                           `json:"nested,omitempty"`
	NumericType  *fieldsortnumerictype.FieldSortNumericType `json:"numeric_type,omitempty"`
	Order        *sortorder.SortOrder                       `json:"order,omitempty"`
	UnmappedType *fieldtype.FieldType                       `json:"unmapped_type,omitempty"`
}

FieldSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L43-L52

func NewFieldSort added in v8.5.0 

func NewFieldSort() *FieldSort

NewFieldSort returns a FieldSort.

func (*FieldSort) UnmarshalJSON added in v8.7.1 

func (s *FieldSort) UnmarshalJSON(data []byte) error

type FieldStat added in v8.9.0 

type FieldStat struct {
	Cardinality int      `json:"cardinality"`
	Count       int      `json:"count"`
	Earliest    *string  `json:"earliest,omitempty"`
	Latest      *string  `json:"latest,omitempty"`
	MaxValue    *int     `json:"max_value,omitempty"`
	MeanValue   *int     `json:"mean_value,omitempty"`
	MedianValue *int     `json:"median_value,omitempty"`
	MinValue    *int     `json:"min_value,omitempty"`
	TopHits     []TopHit `json:"top_hits"`
}

FieldStat type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/text_structure/_types/Structure.ts#L23-L33

func NewFieldStat added in v8.9.0 

func NewFieldStat() *FieldStat

NewFieldStat returns a FieldStat.

func (*FieldStat) UnmarshalJSON added in v8.9.0 

func (s *FieldStat) UnmarshalJSON(data []byte) error

type FieldStatistics 

type FieldStatistics struct {
	DocCount   int   `json:"doc_count"`
	SumDocFreq int64 `json:"sum_doc_freq"`
	SumTtf     int64 `json:"sum_ttf"`
}

FieldStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/termvectors/types.ts#L28-L32

func NewFieldStatistics added in v8.5.0 

func NewFieldStatistics() *FieldStatistics

NewFieldStatistics returns a FieldStatistics.

func (*FieldStatistics) UnmarshalJSON added in v8.7.1 

func (s *FieldStatistics) UnmarshalJSON(data []byte) error

type FieldSuggester 

type FieldSuggester struct {
	// Completion Provides auto-complete/search-as-you-type functionality.
	Completion *CompletionSuggester `json:"completion,omitempty"`
	// Phrase Provides access to word alternatives on a per token basis within a certain
	// string distance.
	Phrase *PhraseSuggester `json:"phrase,omitempty"`
	// Prefix Prefix used to search for suggestions.
	Prefix *string `json:"prefix,omitempty"`
	// Regex A prefix expressed as a regular expression.
	Regex *string `json:"regex,omitempty"`
	// Term Suggests terms based on edit distance.
	Term *TermSuggester `json:"term,omitempty"`
	// Text The text to use as input for the suggester.
	// Needs to be set globally or per suggestion.
	Text *string `json:"text,omitempty"`
}

FieldSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L109-L142

func NewFieldSuggester added in v8.5.0 

func NewFieldSuggester() *FieldSuggester

NewFieldSuggester returns a FieldSuggester.

func (*FieldSuggester) UnmarshalJSON added in v8.9.0 

func (s *FieldSuggester) UnmarshalJSON(data []byte) error

type FieldSummary 

type FieldSummary struct {
	Any           uint          `json:"any"`
	DocValues     uint          `json:"doc_values"`
	InvertedIndex InvertedIndex `json:"inverted_index"`
	KnnVectors    uint          `json:"knn_vectors"`
	Norms         uint          `json:"norms"`
	Points        uint          `json:"points"`
	StoredFields  uint          `json:"stored_fields"`
	TermVectors   uint          `json:"term_vectors"`
}

FieldSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L57-L66

func NewFieldSummary added in v8.5.0 

func NewFieldSummary() *FieldSummary

NewFieldSummary returns a FieldSummary.

type FieldTypes 

type FieldTypes struct {
	// Count The number of occurrences of the field type in selected nodes.
	Count int `json:"count"`
	// IndexCount The number of indices containing the field type in selected nodes.
	IndexCount int `json:"index_count"`
	// IndexedVectorCount For dense_vector field types, number of indexed vector types in selected
	// nodes.
	IndexedVectorCount *int64 `json:"indexed_vector_count,omitempty"`
	// IndexedVectorDimMax For dense_vector field types, the maximum dimension of all indexed vector
	// types in selected nodes.
	IndexedVectorDimMax *int64 `json:"indexed_vector_dim_max,omitempty"`
	// IndexedVectorDimMin For dense_vector field types, the minimum dimension of all indexed vector
	// types in selected nodes.
	IndexedVectorDimMin *int64 `json:"indexed_vector_dim_min,omitempty"`
	// Name The name for the field type in selected nodes.
	Name string `json:"name"`
	// ScriptCount The number of fields that declare a script.
	ScriptCount *int `json:"script_count,omitempty"`
}

FieldTypes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L136-L167

func NewFieldTypes added in v8.5.0 

func NewFieldTypes() *FieldTypes

NewFieldTypes returns a FieldTypes.

func (*FieldTypes) UnmarshalJSON added in v8.7.1 

func (s *FieldTypes) UnmarshalJSON(data []byte) error

type FieldTypesMappings 

type FieldTypesMappings struct {
	// FieldTypes Contains statistics about field data types used in selected nodes.
	FieldTypes []FieldTypes `json:"field_types"`
	// RuntimeFieldTypes Contains statistics about runtime field data types used in selected nodes.
	RuntimeFieldTypes []ClusterRuntimeFieldTypes `json:"runtime_field_types,omitempty"`
	// TotalDeduplicatedFieldCount Total number of fields in all non-system indices, accounting for mapping
	// deduplication.
	TotalDeduplicatedFieldCount *int `json:"total_deduplicated_field_count,omitempty"`
	// TotalDeduplicatedMappingSize Total size of all mappings after deduplication and compression.
	TotalDeduplicatedMappingSize ByteSize `json:"total_deduplicated_mapping_size,omitempty"`
	// TotalDeduplicatedMappingSizeInBytes Total size of all mappings, in bytes, after deduplication and compression.
	TotalDeduplicatedMappingSizeInBytes *int64 `json:"total_deduplicated_mapping_size_in_bytes,omitempty"`
	// TotalFieldCount Total number of fields in all non-system indices.
	TotalFieldCount *int `json:"total_field_count,omitempty"`
}

FieldTypesMappings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L109-L134

func NewFieldTypesMappings added in v8.5.0 

func NewFieldTypesMappings() *FieldTypesMappings

NewFieldTypesMappings returns a FieldTypesMappings.

func (*FieldTypesMappings) UnmarshalJSON added in v8.7.1 

func (s *FieldTypesMappings) UnmarshalJSON(data []byte) error

type FieldValue 

type FieldValue any

FieldValue holds the union for the following types: 

int64
Float64
string
bool
nil
json.RawMessage

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L25-L37

type FieldValueFactorScoreFunction 

type FieldValueFactorScoreFunction struct {
	// Factor Optional factor to multiply the field value with.
	Factor *Float64 `json:"factor,omitempty"`
	// Field Field to be extracted from the document.
	Field string `json:"field"`
	// Missing Value used if the document doesn’t have that field.
	// The modifier and factor are still applied to it as though it were read from
	// the document.
	Missing *Float64 `json:"missing,omitempty"`
	// Modifier Modifier to apply to the field value.
	Modifier *fieldvaluefactormodifier.FieldValueFactorModifier `json:"modifier,omitempty"`
}

FieldValueFactorScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L149-L168

func NewFieldValueFactorScoreFunction added in v8.5.0 

func NewFieldValueFactorScoreFunction() *FieldValueFactorScoreFunction

NewFieldValueFactorScoreFunction returns a FieldValueFactorScoreFunction.

func (*FieldValueFactorScoreFunction) UnmarshalJSON added in v8.7.1 

func (s *FieldValueFactorScoreFunction) UnmarshalJSON(data []byte) error

type FielddataFrequencyFilter 

type FielddataFrequencyFilter struct {
	Max            Float64 `json:"max"`
	Min            Float64 `json:"min"`
	MinSegmentSize int     `json:"min_segment_size"`
}

FielddataFrequencyFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/FielddataFrequencyFilter.ts#L22-L26

func NewFielddataFrequencyFilter added in v8.5.0 

func NewFielddataFrequencyFilter() *FielddataFrequencyFilter

NewFielddataFrequencyFilter returns a FielddataFrequencyFilter.

func (*FielddataFrequencyFilter) UnmarshalJSON added in v8.7.1 

func (s *FielddataFrequencyFilter) UnmarshalJSON(data []byte) error

type FielddataRecord 

type FielddataRecord struct {
	// Field field name
	Field *string `json:"field,omitempty"`
	// Host host name
	Host *string `json:"host,omitempty"`
	// Id node id
	Id *string `json:"id,omitempty"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// Node node name
	Node *string `json:"node,omitempty"`
	// Size field data usage
	Size *string `json:"size,omitempty"`
}

FielddataRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/fielddata/types.ts#L20-L48

func NewFielddataRecord added in v8.5.0 

func NewFielddataRecord() *FielddataRecord

NewFielddataRecord returns a FielddataRecord.

func (*FielddataRecord) UnmarshalJSON added in v8.9.0 

func (s *FielddataRecord) UnmarshalJSON(data []byte) error

type FielddataStats 

type FielddataStats struct {
	Evictions         *int64                      `json:"evictions,omitempty"`
	Fields            map[string]FieldMemoryUsage `json:"fields,omitempty"`
	MemorySize        ByteSize                    `json:"memory_size,omitempty"`
	MemorySizeInBytes int64                       `json:"memory_size_in_bytes"`
}

FielddataStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L114-L119

func NewFielddataStats added in v8.5.0 

func NewFielddataStats() *FielddataStats

NewFielddataStats returns a FielddataStats.

func (*FielddataStats) UnmarshalJSON added in v8.7.1 

func (s *FielddataStats) UnmarshalJSON(data []byte) error

type Fields 

type Fields []string

Fields type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L144-L144

type FieldsUsageBody 

type FieldsUsageBody struct {
	FieldsUsageBody map[string]UsageStatsIndex `json:"-"`
	Shards_         ShardStatistics            `json:"_shards"`
}

FieldsUsageBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L32-L39

func NewFieldsUsageBody added in v8.5.0 

func NewFieldsUsageBody() *FieldsUsageBody

NewFieldsUsageBody returns a FieldsUsageBody.

func (FieldsUsageBody) MarshalJSON 

func (s FieldsUsageBody) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type FileCountSnapshotStats 

type FileCountSnapshotStats struct {
	FileCount   int   `json:"file_count"`
	SizeInBytes int64 `json:"size_in_bytes"`
}

FileCountSnapshotStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/FileCountSnapshotStats.ts#L22-L25

func NewFileCountSnapshotStats added in v8.5.0 

func NewFileCountSnapshotStats() *FileCountSnapshotStats

NewFileCountSnapshotStats returns a FileCountSnapshotStats.

func (*FileCountSnapshotStats) UnmarshalJSON added in v8.7.1 

func (s *FileCountSnapshotStats) UnmarshalJSON(data []byte) error

type FileDetails 

type FileDetails struct {
	Length    int64  `json:"length"`
	Name      string `json:"name"`
	Recovered int64  `json:"recovered"`
}

FileDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L50-L54

func NewFileDetails added in v8.5.0 

func NewFileDetails() *FileDetails

NewFileDetails returns a FileDetails.

func (*FileDetails) UnmarshalJSON added in v8.7.1 

func (s *FileDetails) UnmarshalJSON(data []byte) error

type FileSystem 

type FileSystem struct {
	// Data List of all file stores.
	Data []DataPathStats `json:"data,omitempty"`
	// IoStats Contains I/O statistics for the node.
	IoStats *IoStats `json:"io_stats,omitempty"`
	// Timestamp Last time the file stores statistics were refreshed.
	// Recorded in milliseconds since the Unix Epoch.
	Timestamp *int64 `json:"timestamp,omitempty"`
	// Total Contains statistics for all file stores of the node.
	Total *FileSystemTotal `json:"total,omitempty"`
}

FileSystem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L769-L787

func NewFileSystem added in v8.5.0 

func NewFileSystem() *FileSystem

NewFileSystem returns a FileSystem.

func (*FileSystem) UnmarshalJSON added in v8.7.1 

func (s *FileSystem) UnmarshalJSON(data []byte) error

type FileSystemTotal 

type FileSystemTotal struct {
	// Available Total disk space available to this Java virtual machine on all file stores.
	// Depending on OS or process level restrictions, this might appear less than
	// `free`.
	// This is the actual amount of free disk space the Elasticsearch node can
	// utilise.
	Available *string `json:"available,omitempty"`
	// AvailableInBytes Total number of bytes available to this Java virtual machine on all file
	// stores.
	// Depending on OS or process level restrictions, this might appear less than
	// `free_in_bytes`.
	// This is the actual amount of free disk space the Elasticsearch node can
	// utilise.
	AvailableInBytes *int64 `json:"available_in_bytes,omitempty"`
	// Free Total unallocated disk space in all file stores.
	Free *string `json:"free,omitempty"`
	// FreeInBytes Total number of unallocated bytes in all file stores.
	FreeInBytes *int64 `json:"free_in_bytes,omitempty"`
	// Total Total size of all file stores.
	Total *string `json:"total,omitempty"`
	// TotalInBytes Total size of all file stores in bytes.
	TotalInBytes *int64 `json:"total_in_bytes,omitempty"`
}

FileSystemTotal type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L828-L857

func NewFileSystemTotal added in v8.5.0 

func NewFileSystemTotal() *FileSystemTotal

NewFileSystemTotal returns a FileSystemTotal.

func (*FileSystemTotal) UnmarshalJSON added in v8.7.1 

func (s *FileSystemTotal) UnmarshalJSON(data []byte) error

type FillMaskInferenceOptions 

type FillMaskInferenceOptions struct {
	// MaskToken The string/token which will be removed from incoming documents and replaced
	// with the inference prediction(s).
	// In a response, this field contains the mask token for the specified
	// model/tokenizer. Each model and tokenizer
	// has a predefined mask token which cannot be changed. Thus, it is recommended
	// not to set this value in requests.
	// However, if this field is present in a request, its value must match the
	// predefined value for that model/tokenizer,
	// otherwise the request will fail.
	MaskToken *string `json:"mask_token,omitempty"`
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   Vocabulary                   `json:"vocabulary"`
}

FillMaskInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L284-L299

func NewFillMaskInferenceOptions added in v8.5.0 

func NewFillMaskInferenceOptions() *FillMaskInferenceOptions

NewFillMaskInferenceOptions returns a FillMaskInferenceOptions.

func (*FillMaskInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *FillMaskInferenceOptions) UnmarshalJSON(data []byte) error

type FillMaskInferenceUpdateOptions 

type FillMaskInferenceUpdateOptions struct {
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

FillMaskInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L430-L437

func NewFillMaskInferenceUpdateOptions added in v8.5.0 

func NewFillMaskInferenceUpdateOptions() *FillMaskInferenceUpdateOptions

NewFillMaskInferenceUpdateOptions returns a FillMaskInferenceUpdateOptions.

func (*FillMaskInferenceUpdateOptions) UnmarshalJSON added in v8.7.1 

func (s *FillMaskInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type FilterAggregate 

type FilterAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

FilterAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L552-L556

func NewFilterAggregate added in v8.5.0 

func NewFilterAggregate() *FilterAggregate

NewFilterAggregate returns a FilterAggregate.

func (FilterAggregate) MarshalJSON 

func (s FilterAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*FilterAggregate) UnmarshalJSON added in v8.7.0 

func (s *FilterAggregate) UnmarshalJSON(data []byte) error

type FilterRef 

type FilterRef struct {
	// FilterId The identifier for the filter.
	FilterId string `json:"filter_id"`
	// FilterType If set to `include`, the rule applies for values in the filter. If set to
	// `exclude`, the rule applies for values not in the filter.
	FilterType *filtertype.FilterType `json:"filter_type,omitempty"`
}

FilterRef type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Filter.ts#L31-L41

func NewFilterRef added in v8.5.0 

func NewFilterRef() *FilterRef

NewFilterRef returns a FilterRef.

func (*FilterRef) UnmarshalJSON added in v8.7.1 

func (s *FilterRef) UnmarshalJSON(data []byte) error

type FilteringAdvancedSnippet added in v8.15.0 

type FilteringAdvancedSnippet struct {
	CreatedAt DateTime        `json:"created_at,omitempty"`
	UpdatedAt DateTime        `json:"updated_at,omitempty"`
	Value     json.RawMessage `json:"value,omitempty"`
}

FilteringAdvancedSnippet type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L192-L196

func NewFilteringAdvancedSnippet added in v8.15.0 

func NewFilteringAdvancedSnippet() *FilteringAdvancedSnippet

NewFilteringAdvancedSnippet returns a FilteringAdvancedSnippet.

func (*FilteringAdvancedSnippet) UnmarshalJSON added in v8.15.0 

func (s *FilteringAdvancedSnippet) UnmarshalJSON(data []byte) error

type FilteringConfig added in v8.15.0 

type FilteringConfig struct {
	Active FilteringRules `json:"active"`
	Domain *string        `json:"domain,omitempty"`
	Draft  FilteringRules `json:"draft"`
}

FilteringConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L209-L213

func NewFilteringConfig added in v8.15.0 

func NewFilteringConfig() *FilteringConfig

NewFilteringConfig returns a FilteringConfig.

func (*FilteringConfig) UnmarshalJSON added in v8.15.0 

func (s *FilteringConfig) UnmarshalJSON(data []byte) error

type FilteringRule added in v8.15.0 

type FilteringRule struct {
	CreatedAt DateTime                            `json:"created_at,omitempty"`
	Field     string                              `json:"field"`
	Id        string                              `json:"id"`
	Order     int                                 `json:"order"`
	Policy    filteringpolicy.FilteringPolicy     `json:"policy"`
	Rule      filteringrulerule.FilteringRuleRule `json:"rule"`
	UpdatedAt DateTime                            `json:"updated_at,omitempty"`
	Value     string                              `json:"value"`
}

FilteringRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L170-L179

func NewFilteringRule added in v8.15.0 

func NewFilteringRule() *FilteringRule

NewFilteringRule returns a FilteringRule.

func (*FilteringRule) UnmarshalJSON added in v8.15.0 

func (s *FilteringRule) UnmarshalJSON(data []byte) error

type FilteringRules added in v8.15.0 

type FilteringRules struct {
	AdvancedSnippet FilteringAdvancedSnippet `json:"advanced_snippet"`
	Rules           []FilteringRule          `json:"rules"`
	Validation      FilteringRulesValidation `json:"validation"`
}

FilteringRules type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L203-L207

func NewFilteringRules added in v8.15.0 

func NewFilteringRules() *FilteringRules

NewFilteringRules returns a FilteringRules.

type FilteringRulesValidation added in v8.15.0 

type FilteringRulesValidation struct {
	Errors []FilteringValidation                             `json:"errors"`
	State  filteringvalidationstate.FilteringValidationState `json:"state"`
}

FilteringRulesValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L198-L201

func NewFilteringRulesValidation added in v8.15.0 

func NewFilteringRulesValidation() *FilteringRulesValidation

NewFilteringRulesValidation returns a FilteringRulesValidation.

type FilteringValidation added in v8.15.0 

type FilteringValidation struct {
	Ids      []string `json:"ids"`
	Messages []string `json:"messages"`
}

FilteringValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L181-L184

func NewFilteringValidation added in v8.15.0 

func NewFilteringValidation() *FilteringValidation

NewFilteringValidation returns a FilteringValidation.

type FiltersAggregate 

type FiltersAggregate struct {
	Buckets BucketsFiltersBucket `json:"buckets"`
	Meta    Metadata             `json:"meta,omitempty"`
}

FiltersAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L639-L643

func NewFiltersAggregate added in v8.5.0 

func NewFiltersAggregate() *FiltersAggregate

NewFiltersAggregate returns a FiltersAggregate.

func (*FiltersAggregate) UnmarshalJSON added in v8.7.0 

func (s *FiltersAggregate) UnmarshalJSON(data []byte) error

type FiltersAggregation 

type FiltersAggregation struct {
	// Filters Collection of queries from which to build buckets.
	Filters BucketsQuery `json:"filters,omitempty"`
	// Keyed By default, the named filters aggregation returns the buckets as an object.
	// Set to `false` to return the buckets as an array of objects.
	Keyed *bool `json:"keyed,omitempty"`
	// OtherBucket Set to `true` to add a bucket to the response which will contain all
	// documents that do not match any of the given filters.
	OtherBucket *bool `json:"other_bucket,omitempty"`
	// OtherBucketKey The key with which the other bucket is returned.
	OtherBucketKey *string `json:"other_bucket_key,omitempty"`
}

FiltersAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L374-L394

func NewFiltersAggregation added in v8.5.0 

func NewFiltersAggregation() *FiltersAggregation

NewFiltersAggregation returns a FiltersAggregation.

func (*FiltersAggregation) UnmarshalJSON added in v8.7.1 

func (s *FiltersAggregation) UnmarshalJSON(data []byte) error

type FiltersBucket 

type FiltersBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
}

FiltersBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L645-L645

func NewFiltersBucket added in v8.5.0 

func NewFiltersBucket() *FiltersBucket

NewFiltersBucket returns a FiltersBucket.

func (FiltersBucket) MarshalJSON 

func (s FiltersBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*FiltersBucket) UnmarshalJSON added in v8.7.0 

func (s *FiltersBucket) UnmarshalJSON(data []byte) error

type FingerprintAnalyzer 

type FingerprintAnalyzer struct {
	MaxOutputSize    int       `json:"max_output_size"`
	PreserveOriginal bool      `json:"preserve_original"`
	Separator        string    `json:"separator"`
	Stopwords        StopWords `json:"stopwords,omitempty"`
	StopwordsPath    *string   `json:"stopwords_path,omitempty"`
	Type             string    `json:"type,omitempty"`
	Version          *string   `json:"version,omitempty"`
}

FingerprintAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L37-L45

func NewFingerprintAnalyzer added in v8.5.0 

func NewFingerprintAnalyzer() *FingerprintAnalyzer

NewFingerprintAnalyzer returns a FingerprintAnalyzer.

func (FingerprintAnalyzer) MarshalJSON added in v8.9.0 

func (s FingerprintAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FingerprintAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *FingerprintAnalyzer) UnmarshalJSON(data []byte) error

type FingerprintProcessor added in v8.16.0 

type FingerprintProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Fields Array of fields to include in the fingerprint. For objects, the processor
	// hashes both the field key and value. For other fields, the processor hashes
	// only the field value.
	Fields []string `json:"fields"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If true, the processor ignores any missing fields. If all fields are
	// missing, the processor silently exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// Method The hash method used to compute the fingerprint. Must be one of MD5, SHA-1,
	// SHA-256, SHA-512, or MurmurHash3.
	Method *fingerprintdigest.FingerprintDigest `json:"method,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Salt Salt value for the hash function.
	Salt *string `json:"salt,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Output field for the fingerprint.
	TargetField *string `json:"target_field,omitempty"`
}

FingerprintProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L904-L932

func NewFingerprintProcessor added in v8.16.0 

func NewFingerprintProcessor() *FingerprintProcessor

NewFingerprintProcessor returns a FingerprintProcessor.

func (*FingerprintProcessor) UnmarshalJSON added in v8.16.0 

func (s *FingerprintProcessor) UnmarshalJSON(data []byte) error

type FingerprintTokenFilter 

type FingerprintTokenFilter struct {
	// MaxOutputSize Maximum character length, including whitespace, of the output token. Defaults
	// to `255`. Concatenated tokens longer than this will result in no token
	// output.
	MaxOutputSize *int `json:"max_output_size,omitempty"`
	// Separator Character to use to concatenate the token stream input. Defaults to a space.
	Separator *string `json:"separator,omitempty"`
	Type      string  `json:"type,omitempty"`
	Version   *string `json:"version,omitempty"`
}

FingerprintTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L260-L266

func NewFingerprintTokenFilter added in v8.5.0 

func NewFingerprintTokenFilter() *FingerprintTokenFilter

NewFingerprintTokenFilter returns a FingerprintTokenFilter.

func (FingerprintTokenFilter) MarshalJSON added in v8.9.0 

func (s FingerprintTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FingerprintTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *FingerprintTokenFilter) UnmarshalJSON(data []byte) error

type FinnishAnalyzer added in v8.16.0 

type FinnishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

FinnishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L145-L150

func NewFinnishAnalyzer added in v8.16.0 

func NewFinnishAnalyzer() *FinnishAnalyzer

NewFinnishAnalyzer returns a FinnishAnalyzer.

func (FinnishAnalyzer) MarshalJSON added in v8.16.0 

func (s FinnishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FinnishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *FinnishAnalyzer) UnmarshalJSON(data []byte) error

type FlattenGraphTokenFilter added in v8.18.1 

type FlattenGraphTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

FlattenGraphTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L485-L487

func NewFlattenGraphTokenFilter added in v8.18.1 

func NewFlattenGraphTokenFilter() *FlattenGraphTokenFilter

NewFlattenGraphTokenFilter returns a FlattenGraphTokenFilter.

func (FlattenGraphTokenFilter) MarshalJSON added in v8.18.1 

func (s FlattenGraphTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FlattenGraphTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *FlattenGraphTokenFilter) UnmarshalJSON(data []byte) error

type Flattened 

type Flattened struct {
	Available  bool `json:"available"`
	Enabled    bool `json:"enabled"`
	FieldCount int  `json:"field_count"`
}

Flattened type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L366-L368

func NewFlattened added in v8.5.0 

func NewFlattened() *Flattened

NewFlattened returns a Flattened.

func (*Flattened) UnmarshalJSON added in v8.7.1 

func (s *Flattened) UnmarshalJSON(data []byte) error

type FlattenedProperty 

type FlattenedProperty struct {
	Boost               *Float64                       `json:"boost,omitempty"`
	DepthLimit          *int                           `json:"depth_limit,omitempty"`
	DocValues           *bool                          `json:"doc_values,omitempty"`
	Dynamic             *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EagerGlobalOrdinals *bool                          `json:"eager_global_ordinals,omitempty"`
	Fields              map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove         *int                           `json:"ignore_above,omitempty"`
	Index               *bool                          `json:"index,omitempty"`
	IndexOptions        *indexoptions.IndexOptions     `json:"index_options,omitempty"`
	// Meta Metadata about the field.
	Meta                     map[string]string                                `json:"meta,omitempty"`
	NullValue                *string                                          `json:"null_value,omitempty"`
	Properties               map[string]Property                              `json:"properties,omitempty"`
	Similarity               *string                                          `json:"similarity,omitempty"`
	SplitQueriesOnWhitespace *bool                                            `json:"split_queries_on_whitespace,omitempty"`
	SyntheticSourceKeep      *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                     string                                           `json:"type,omitempty"`
}

FlattenedProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/complex.ts#L26-L37

func NewFlattenedProperty added in v8.5.0 

func NewFlattenedProperty() *FlattenedProperty

NewFlattenedProperty returns a FlattenedProperty.

func (FlattenedProperty) MarshalJSON added in v8.9.0 

func (s FlattenedProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FlattenedProperty) UnmarshalJSON added in v8.7.0 

func (s *FlattenedProperty) UnmarshalJSON(data []byte) error

type Float64 added in v8.7.0 

type Float64 float64

Float64 custom type for Inf & NaN handling.

func (Float64) MarshalJSON added in v8.7.0 

func (f Float64) MarshalJSON() ([]byte, error)

MarshalJSON implements Marshaler interface.

func (*Float64) UnmarshalJSON added in v8.7.0 

func (f *Float64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements Unmarshaler interface.

type FloatNumberProperty 

type FloatNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *float32                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

FloatNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L155-L158

func NewFloatNumberProperty added in v8.5.0 

func NewFloatNumberProperty() *FloatNumberProperty

NewFloatNumberProperty returns a FloatNumberProperty.

func (FloatNumberProperty) MarshalJSON added in v8.9.0 

func (s FloatNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FloatNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *FloatNumberProperty) UnmarshalJSON(data []byte) error

type FloatRangeProperty 

type FloatRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

FloatRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L38-L40

func NewFloatRangeProperty added in v8.5.0 

func NewFloatRangeProperty() *FloatRangeProperty

NewFloatRangeProperty returns a FloatRangeProperty.

func (FloatRangeProperty) MarshalJSON added in v8.9.0 

func (s FloatRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FloatRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *FloatRangeProperty) UnmarshalJSON(data []byte) error

type FlushStats 

type FlushStats struct {
	Periodic          int64    `json:"periodic"`
	Total             int64    `json:"total"`
	TotalTime         Duration `json:"total_time,omitempty"`
	TotalTimeInMillis int64    `json:"total_time_in_millis"`
}

FlushStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L126-L131

func NewFlushStats added in v8.5.0 

func NewFlushStats() *FlushStats

NewFlushStats returns a FlushStats.

func (*FlushStats) UnmarshalJSON added in v8.7.1 

func (s *FlushStats) UnmarshalJSON(data []byte) error

type FollowIndexStats 

type FollowIndexStats struct {
	// Index The name of the follower index.
	Index string `json:"index"`
	// Shards An array of shard-level following task statistics.
	Shards []CcrShardStats `json:"shards"`
}

FollowIndexStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/_types/FollowIndexStats.ts#L30-L35

func NewFollowIndexStats added in v8.5.0 

func NewFollowIndexStats() *FollowIndexStats

NewFollowIndexStats returns a FollowIndexStats.

func (*FollowIndexStats) UnmarshalJSON added in v8.7.1 

func (s *FollowIndexStats) UnmarshalJSON(data []byte) error

type FollowStats 

type FollowStats struct {
	Indices []FollowIndexStats `json:"indices"`
}

FollowStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/stats/types.ts.ts#L49-L51

func NewFollowStats added in v8.5.0 

func NewFollowStats() *FollowStats

NewFollowStats returns a FollowStats.

type FollowerIndex 

type FollowerIndex struct {
	// FollowerIndex The name of the follower index.
	FollowerIndex string `json:"follower_index"`
	// LeaderIndex The name of the index in the leader cluster that is followed.
	LeaderIndex string `json:"leader_index"`
	// Parameters An object that encapsulates cross-cluster replication parameters. If the
	// follower index's status is paused, this object is omitted.
	Parameters *FollowerIndexParameters `json:"parameters,omitempty"`
	// RemoteCluster The remote cluster that contains the leader index.
	RemoteCluster string `json:"remote_cluster"`
	// Status The status of the index following: `active` or `paused`.
	Status followerindexstatus.FollowerIndexStatus `json:"status"`
}

FollowerIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/follow_info/types.ts#L24-L35

func NewFollowerIndex added in v8.5.0 

func NewFollowerIndex() *FollowerIndex

NewFollowerIndex returns a FollowerIndex.

func (*FollowerIndex) UnmarshalJSON added in v8.7.1 

func (s *FollowerIndex) UnmarshalJSON(data []byte) error

type FollowerIndexParameters 

type FollowerIndexParameters struct {
	// MaxOutstandingReadRequests The maximum number of outstanding reads requests from the remote cluster.
	MaxOutstandingReadRequests *int64 `json:"max_outstanding_read_requests,omitempty"`
	// MaxOutstandingWriteRequests The maximum number of outstanding write requests on the follower.
	MaxOutstandingWriteRequests *int `json:"max_outstanding_write_requests,omitempty"`
	// MaxReadRequestOperationCount The maximum number of operations to pull per read from the remote cluster.
	MaxReadRequestOperationCount *int `json:"max_read_request_operation_count,omitempty"`
	// MaxReadRequestSize The maximum size in bytes of per read of a batch of operations pulled from
	// the remote cluster.
	MaxReadRequestSize ByteSize `json:"max_read_request_size,omitempty"`
	// MaxRetryDelay The maximum time to wait before retrying an operation that failed
	// exceptionally. An exponential backoff strategy is employed when
	// retrying.
	MaxRetryDelay Duration `json:"max_retry_delay,omitempty"`
	// MaxWriteBufferCount The maximum number of operations that can be queued for writing. When this
	// limit is reached, reads from the remote cluster will be
	// deferred until the number of queued operations goes below the limit.
	MaxWriteBufferCount *int `json:"max_write_buffer_count,omitempty"`
	// MaxWriteBufferSize The maximum total bytes of operations that can be queued for writing. When
	// this limit is reached, reads from the remote cluster will
	// be deferred until the total bytes of queued operations goes below the limit.
	MaxWriteBufferSize ByteSize `json:"max_write_buffer_size,omitempty"`
	// MaxWriteRequestOperationCount The maximum number of operations per bulk write request executed on the
	// follower.
	MaxWriteRequestOperationCount *int `json:"max_write_request_operation_count,omitempty"`
	// MaxWriteRequestSize The maximum total bytes of operations per bulk write request executed on the
	// follower.
	MaxWriteRequestSize ByteSize `json:"max_write_request_size,omitempty"`
	// ReadPollTimeout The maximum time to wait for new operations on the remote cluster when the
	// follower index is synchronized with the leader index.
	// When the timeout has elapsed, the poll for operations will return to the
	// follower so that it can update some statistics.
	// Then the follower will immediately attempt to read from the leader again.
	ReadPollTimeout Duration `json:"read_poll_timeout,omitempty"`
}

FollowerIndexParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/follow_info/types.ts#L42-L88

func NewFollowerIndexParameters added in v8.5.0 

func NewFollowerIndexParameters() *FollowerIndexParameters

NewFollowerIndexParameters returns a FollowerIndexParameters.

func (*FollowerIndexParameters) UnmarshalJSON added in v8.7.1 

func (s *FollowerIndexParameters) UnmarshalJSON(data []byte) error

type ForceMergeAction added in v8.15.0 

type ForceMergeAction struct {
	IndexCodec     *string `json:"index_codec,omitempty"`
	MaxNumSegments int     `json:"max_num_segments"`
}

ForceMergeAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L123-L126

func NewForceMergeAction added in v8.15.0 

func NewForceMergeAction() *ForceMergeAction

NewForceMergeAction returns a ForceMergeAction.

func (*ForceMergeAction) UnmarshalJSON added in v8.15.0 

func (s *ForceMergeAction) UnmarshalJSON(data []byte) error

type ForceMergeResponseBody added in v8.5.0 

type ForceMergeResponseBody struct {
	Shards_ *ShardStatistics `json:"_shards,omitempty"`
	// Task task contains a task id returned when wait_for_completion=false,
	// you can use the task_id to get the status of the task at _tasks/<task_id>
	Task *string `json:"task,omitempty"`
}

ForceMergeResponseBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/forcemerge/_types/response.ts#L22-L28

func NewForceMergeResponseBody added in v8.5.0 

func NewForceMergeResponseBody() *ForceMergeResponseBody

NewForceMergeResponseBody returns a ForceMergeResponseBody.

func (*ForceMergeResponseBody) UnmarshalJSON added in v8.9.0 

func (s *ForceMergeResponseBody) UnmarshalJSON(data []byte) error

type ForeachProcessor 

type ForeachProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field Field containing array or object values.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true`, the processor silently exits without changing the document if the
	// `field` is `null` or missing.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Processor Ingest processor to run on each element.
	Processor *ProcessorContainer `json:"processor,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

ForeachProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L934-L948

func NewForeachProcessor added in v8.5.0 

func NewForeachProcessor() *ForeachProcessor

NewForeachProcessor returns a ForeachProcessor.

func (*ForeachProcessor) UnmarshalJSON added in v8.7.1 

func (s *ForeachProcessor) UnmarshalJSON(data []byte) error

type FormattableMetricAggregation 

type FormattableMetricAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

FormattableMetricAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L51-L53

func NewFormattableMetricAggregation added in v8.5.0 

func NewFormattableMetricAggregation() *FormattableMetricAggregation

NewFormattableMetricAggregation returns a FormattableMetricAggregation.

func (*FormattableMetricAggregation) UnmarshalJSON added in v8.7.1 

func (s *FormattableMetricAggregation) UnmarshalJSON(data []byte) error

type FoundStatus 

type FoundStatus struct {
	Found bool `json:"found"`
}

FoundStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/delete_privileges/types.ts#L20-L22

func NewFoundStatus added in v8.5.0 

func NewFoundStatus() *FoundStatus

NewFoundStatus returns a FoundStatus.

func (*FoundStatus) UnmarshalJSON added in v8.7.1 

func (s *FoundStatus) UnmarshalJSON(data []byte) error

type FrenchAnalyzer added in v8.16.0 

type FrenchAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

FrenchAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L152-L157

func NewFrenchAnalyzer added in v8.16.0 

func NewFrenchAnalyzer() *FrenchAnalyzer

NewFrenchAnalyzer returns a FrenchAnalyzer.

func (FrenchAnalyzer) MarshalJSON added in v8.16.0 

func (s FrenchAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*FrenchAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *FrenchAnalyzer) UnmarshalJSON(data []byte) error

type FrequencyEncodingPreprocessor 

type FrequencyEncodingPreprocessor struct {
	FeatureName  string             `json:"feature_name"`
	Field        string             `json:"field"`
	FrequencyMap map[string]Float64 `json:"frequency_map"`
}

FrequencyEncodingPreprocessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L38-L42

func NewFrequencyEncodingPreprocessor added in v8.5.0 

func NewFrequencyEncodingPreprocessor() *FrequencyEncodingPreprocessor

NewFrequencyEncodingPreprocessor returns a FrequencyEncodingPreprocessor.

func (*FrequencyEncodingPreprocessor) UnmarshalJSON added in v8.7.1 

func (s *FrequencyEncodingPreprocessor) UnmarshalJSON(data []byte) error

type FrequentItemSetsAggregate added in v8.8.0 

type FrequentItemSetsAggregate struct {
	Buckets BucketsFrequentItemSetsBucket `json:"buckets"`
	Meta    Metadata                      `json:"meta,omitempty"`
}

FrequentItemSetsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L722-L723

func NewFrequentItemSetsAggregate added in v8.8.0 

func NewFrequentItemSetsAggregate() *FrequentItemSetsAggregate

NewFrequentItemSetsAggregate returns a FrequentItemSetsAggregate.

func (*FrequentItemSetsAggregate) UnmarshalJSON added in v8.8.0 

func (s *FrequentItemSetsAggregate) UnmarshalJSON(data []byte) error

type FrequentItemSetsAggregation added in v8.8.0 

type FrequentItemSetsAggregation struct {
	// Fields Fields to analyze.
	Fields []FrequentItemSetsField `json:"fields"`
	// Filter Query that filters documents from analysis.
	Filter *Query `json:"filter,omitempty"`
	// MinimumSetSize The minimum size of one item set.
	MinimumSetSize *int `json:"minimum_set_size,omitempty"`
	// MinimumSupport The minimum support of one item set.
	MinimumSupport *Float64 `json:"minimum_support,omitempty"`
	// Size The number of top item sets to return.
	Size *int `json:"size,omitempty"`
}

FrequentItemSetsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1241-L1268

func NewFrequentItemSetsAggregation added in v8.8.0 

func NewFrequentItemSetsAggregation() *FrequentItemSetsAggregation

NewFrequentItemSetsAggregation returns a FrequentItemSetsAggregation.

func (*FrequentItemSetsAggregation) UnmarshalJSON added in v8.8.0 

func (s *FrequentItemSetsAggregation) UnmarshalJSON(data []byte) error

type FrequentItemSetsBucket added in v8.8.0 

type FrequentItemSetsBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          map[string][]string  `json:"key"`
	Support      Float64              `json:"support"`
}

FrequentItemSetsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L725-L728

func NewFrequentItemSetsBucket added in v8.8.0 

func NewFrequentItemSetsBucket() *FrequentItemSetsBucket

NewFrequentItemSetsBucket returns a FrequentItemSetsBucket.

func (FrequentItemSetsBucket) MarshalJSON added in v8.8.0 

func (s FrequentItemSetsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*FrequentItemSetsBucket) UnmarshalJSON added in v8.8.0 

func (s *FrequentItemSetsBucket) UnmarshalJSON(data []byte) error

type FrequentItemSetsField added in v8.8.0 

type FrequentItemSetsField struct {
	// Exclude Values to exclude.
	// Can be regular expression strings or arrays of strings of exact terms.
	Exclude []string `json:"exclude,omitempty"`
	Field   string   `json:"field"`
	// Include Values to include.
	// Can be regular expression strings or arrays of strings of exact terms.
	Include TermsInclude `json:"include,omitempty"`
}

FrequentItemSetsField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1227-L1239

func NewFrequentItemSetsField added in v8.8.0 

func NewFrequentItemSetsField() *FrequentItemSetsField

NewFrequentItemSetsField returns a FrequentItemSetsField.

func (*FrequentItemSetsField) UnmarshalJSON added in v8.8.0 

func (s *FrequentItemSetsField) UnmarshalJSON(data []byte) error

type FrozenIndices 

type FrozenIndices struct {
	Available    bool  `json:"available"`
	Enabled      bool  `json:"enabled"`
	IndicesCount int64 `json:"indices_count"`
}

FrozenIndices type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L370-L372

func NewFrozenIndices added in v8.5.0 

func NewFrozenIndices() *FrozenIndices

NewFrozenIndices returns a FrozenIndices.

func (*FrozenIndices) UnmarshalJSON added in v8.7.1 

func (s *FrozenIndices) UnmarshalJSON(data []byte) error

type FunctionScore added in v8.5.0 

type FunctionScore struct {
	// Exp Function that scores a document with a exponential decay, depending on the
	// distance of a numeric field value of the document from an origin.
	Exp DecayFunction `json:"exp,omitempty"`
	// FieldValueFactor Function allows you to use a field from a document to influence the score.
	// It’s similar to using the script_score function, however, it avoids the
	// overhead of scripting.
	FieldValueFactor *FieldValueFactorScoreFunction `json:"field_value_factor,omitempty"`
	Filter           *Query                         `json:"filter,omitempty"`
	// Gauss Function that scores a document with a normal decay, depending on the
	// distance of a numeric field value of the document from an origin.
	Gauss DecayFunction `json:"gauss,omitempty"`
	// Linear Function that scores a document with a linear decay, depending on the
	// distance of a numeric field value of the document from an origin.
	Linear DecayFunction `json:"linear,omitempty"`
	// RandomScore Generates scores that are uniformly distributed from 0 up to but not
	// including 1.
	// In case you want scores to be reproducible, it is possible to provide a
	// `seed` and `field`.
	RandomScore *RandomScoreFunction `json:"random_score,omitempty"`
	// ScriptScore Enables you to wrap another query and customize the scoring of it optionally
	// with a computation derived from other numeric field values in the doc using a
	// script expression.
	ScriptScore *ScriptScoreFunction `json:"script_score,omitempty"`
	Weight      *Float64             `json:"weight,omitempty"`
}

FunctionScore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L226-L266

func NewFunctionScore added in v8.5.0 

func NewFunctionScore() *FunctionScore

NewFunctionScore returns a FunctionScore.

func (*FunctionScore) UnmarshalJSON added in v8.7.1 

func (s *FunctionScore) UnmarshalJSON(data []byte) error

type FunctionScoreQuery 

type FunctionScoreQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// BoostMode Defines how he newly computed score is combined with the score of the query
	BoostMode *functionboostmode.FunctionBoostMode `json:"boost_mode,omitempty"`
	// Functions One or more functions that compute a new score for each document returned by
	// the query.
	Functions []FunctionScore `json:"functions,omitempty"`
	// MaxBoost Restricts the new score to not exceed the provided limit.
	MaxBoost *Float64 `json:"max_boost,omitempty"`
	// MinScore Excludes documents that do not meet the provided score threshold.
	MinScore *Float64 `json:"min_score,omitempty"`
	// Query A query that determines the documents for which a new score is computed.
	Query      *Query  `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// ScoreMode Specifies how the computed scores are combined
	ScoreMode *functionscoremode.FunctionScoreMode `json:"score_mode,omitempty"`
}

FunctionScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L105-L135

func NewFunctionScoreQuery added in v8.5.0 

func NewFunctionScoreQuery() *FunctionScoreQuery

NewFunctionScoreQuery returns a FunctionScoreQuery.

func (*FunctionScoreQuery) UnmarshalJSON added in v8.7.1 

func (s *FunctionScoreQuery) UnmarshalJSON(data []byte) error

type Fuzziness 

type Fuzziness any

Fuzziness holds the union for the following types: 

string
int

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L137-L138

type FuzzyQuery 

type FuzzyQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Fuzziness Maximum edit distance allowed for matching.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// MaxExpansions Maximum number of variations created.
	MaxExpansions *int `json:"max_expansions,omitempty"`
	// PrefixLength Number of beginning characters left unchanged when creating expansions.
	PrefixLength *int    `json:"prefix_length,omitempty"`
	QueryName_   *string `json:"_name,omitempty"`
	// Rewrite Number of beginning characters left unchanged when creating expansions.
	Rewrite *string `json:"rewrite,omitempty"`
	// Transpositions Indicates whether edits include transpositions of two adjacent characters
	// (for example `ab` to `ba`).
	Transpositions *bool `json:"transpositions,omitempty"`
	// Value Term you wish to find in the provided field.
	Value string `json:"value"`
}

FuzzyQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L48-L86

func NewFuzzyQuery added in v8.5.0 

func NewFuzzyQuery() *FuzzyQuery

NewFuzzyQuery returns a FuzzyQuery.

func (*FuzzyQuery) UnmarshalJSON added in v8.7.1 

func (s *FuzzyQuery) UnmarshalJSON(data []byte) error

type GalicianAnalyzer added in v8.16.0 

type GalicianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

GalicianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L159-L164

func NewGalicianAnalyzer added in v8.16.0 

func NewGalicianAnalyzer() *GalicianAnalyzer

NewGalicianAnalyzer returns a GalicianAnalyzer.

func (GalicianAnalyzer) MarshalJSON added in v8.16.0 

func (s GalicianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GalicianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *GalicianAnalyzer) UnmarshalJSON(data []byte) error

type GarbageCollector 

type GarbageCollector struct {
	// Collectors Contains statistics about JVM garbage collectors for the node.
	Collectors map[string]GarbageCollectorTotal `json:"collectors,omitempty"`
}

GarbageCollector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L994-L999

func NewGarbageCollector added in v8.5.0 

func NewGarbageCollector() *GarbageCollector

NewGarbageCollector returns a GarbageCollector.

type GarbageCollectorTotal 

type GarbageCollectorTotal struct {
	// CollectionCount Total number of JVM garbage collectors that collect objects.
	CollectionCount *int64 `json:"collection_count,omitempty"`
	// CollectionTime Total time spent by JVM collecting objects.
	CollectionTime *string `json:"collection_time,omitempty"`
	// CollectionTimeInMillis Total time, in milliseconds, spent by JVM collecting objects.
	CollectionTimeInMillis *int64 `json:"collection_time_in_millis,omitempty"`
}

GarbageCollectorTotal type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1001-L1014

func NewGarbageCollectorTotal added in v8.5.0 

func NewGarbageCollectorTotal() *GarbageCollectorTotal

NewGarbageCollectorTotal returns a GarbageCollectorTotal.

func (*GarbageCollectorTotal) UnmarshalJSON added in v8.7.1 

func (s *GarbageCollectorTotal) UnmarshalJSON(data []byte) error

type GcsRepository added in v8.13.0 

type GcsRepository struct {
	Settings GcsRepositorySettings `json:"settings"`
	Type     string                `json:"type,omitempty"`
	Uuid     *string               `json:"uuid,omitempty"`
}

GcsRepository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L45-L48

func NewGcsRepository added in v8.13.0 

func NewGcsRepository() *GcsRepository

NewGcsRepository returns a GcsRepository.

func (GcsRepository) MarshalJSON added in v8.13.0 

func (s GcsRepository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GcsRepository) UnmarshalJSON added in v8.13.0 

func (s *GcsRepository) UnmarshalJSON(data []byte) error

type GcsRepositorySettings added in v8.13.0 

type GcsRepositorySettings struct {
	ApplicationName        *string  `json:"application_name,omitempty"`
	BasePath               *string  `json:"base_path,omitempty"`
	Bucket                 string   `json:"bucket"`
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Client                 *string  `json:"client,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	Readonly               *bool    `json:"readonly,omitempty"`
}

GcsRepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L85-L91

func NewGcsRepositorySettings added in v8.13.0 

func NewGcsRepositorySettings() *GcsRepositorySettings

NewGcsRepositorySettings returns a GcsRepositorySettings.

func (*GcsRepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *GcsRepositorySettings) UnmarshalJSON(data []byte) error

type GeoBoundingBoxQuery 

type GeoBoundingBoxQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost               *float32             `json:"boost,omitempty"`
	GeoBoundingBoxQuery map[string]GeoBounds `json:"-"`
	// IgnoreUnmapped Set to `true` to ignore an unmapped field and not match any documents for
	// this query.
	// Set to `false` to throw an exception if the field is not mapped.
	IgnoreUnmapped *bool                      `json:"ignore_unmapped,omitempty"`
	QueryName_     *string                    `json:"_name,omitempty"`
	Type           *geoexecution.GeoExecution `json:"type,omitempty"`
	// ValidationMethod Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or
	// longitude.
	// Set to `COERCE` to also try to infer correct latitude or longitude.
	ValidationMethod *geovalidationmethod.GeoValidationMethod `json:"validation_method,omitempty"`
}

GeoBoundingBoxQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L35-L57

func NewGeoBoundingBoxQuery added in v8.5.0 

func NewGeoBoundingBoxQuery() *GeoBoundingBoxQuery

NewGeoBoundingBoxQuery returns a GeoBoundingBoxQuery.

func (GeoBoundingBoxQuery) MarshalJSON 

func (s GeoBoundingBoxQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoBoundingBoxQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoBoundingBoxQuery) UnmarshalJSON(data []byte) error

type GeoBounds 

type GeoBounds any

GeoBounds holds the union for the following types: 

CoordsGeoBounds
TopLeftBottomRightGeoBounds
TopRightBottomLeftGeoBounds
WktGeoBounds

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L135-L148

type GeoBoundsAggregate 

type GeoBoundsAggregate struct {
	Bounds GeoBounds `json:"bounds,omitempty"`
	Meta   Metadata  `json:"meta,omitempty"`
}

GeoBoundsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L327-L333

func NewGeoBoundsAggregate added in v8.5.0 

func NewGeoBoundsAggregate() *GeoBoundsAggregate

NewGeoBoundsAggregate returns a GeoBoundsAggregate.

func (*GeoBoundsAggregate) UnmarshalJSON added in v8.7.1 

func (s *GeoBoundsAggregate) UnmarshalJSON(data []byte) error

type GeoBoundsAggregation 

type GeoBoundsAggregation struct {
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// WrapLongitude Specifies whether the bounding box should be allowed to overlap the
	// international date line.
	WrapLongitude *bool `json:"wrap_longitude,omitempty"`
}

GeoBoundsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L108-L117

func NewGeoBoundsAggregation added in v8.5.0 

func NewGeoBoundsAggregation() *GeoBoundsAggregation

NewGeoBoundsAggregation returns a GeoBoundsAggregation.

func (*GeoBoundsAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoBoundsAggregation) UnmarshalJSON(data []byte) error

type GeoCentroidAggregate 

type GeoCentroidAggregate struct {
	Count    int64       `json:"count"`
	Location GeoLocation `json:"location,omitempty"`
	Meta     Metadata    `json:"meta,omitempty"`
}

GeoCentroidAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L335-L342

func NewGeoCentroidAggregate added in v8.5.0 

func NewGeoCentroidAggregate() *GeoCentroidAggregate

NewGeoCentroidAggregate returns a GeoCentroidAggregate.

func (*GeoCentroidAggregate) UnmarshalJSON added in v8.7.1 

func (s *GeoCentroidAggregate) UnmarshalJSON(data []byte) error

type GeoCentroidAggregation 

type GeoCentroidAggregation struct {
	Count *int64 `json:"count,omitempty"`
	// Field The field on which to run the aggregation.
	Field    *string     `json:"field,omitempty"`
	Location GeoLocation `json:"location,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

GeoCentroidAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L119-L122

func NewGeoCentroidAggregation added in v8.5.0 

func NewGeoCentroidAggregation() *GeoCentroidAggregation

NewGeoCentroidAggregation returns a GeoCentroidAggregation.

func (*GeoCentroidAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoCentroidAggregation) UnmarshalJSON(data []byte) error

type GeoDecayFunction 

type GeoDecayFunction struct {
	DecayFunctionBaseGeoLocationDistance map[string]DecayPlacementGeoLocationDistance `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

GeoDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L210-L213

func NewGeoDecayFunction added in v8.5.0 

func NewGeoDecayFunction() *GeoDecayFunction

NewGeoDecayFunction returns a GeoDecayFunction.

func (GeoDecayFunction) MarshalJSON 

func (s GeoDecayFunction) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type GeoDistanceAggregate 

type GeoDistanceAggregate struct {
	Buckets BucketsRangeBucket `json:"buckets"`
	Meta    Metadata           `json:"meta,omitempty"`
}

GeoDistanceAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L617-L622

func NewGeoDistanceAggregate added in v8.5.0 

func NewGeoDistanceAggregate() *GeoDistanceAggregate

NewGeoDistanceAggregate returns a GeoDistanceAggregate.

func (*GeoDistanceAggregate) UnmarshalJSON added in v8.7.0 

func (s *GeoDistanceAggregate) UnmarshalJSON(data []byte) error

type GeoDistanceAggregation 

type GeoDistanceAggregation struct {
	// DistanceType The distance calculation type.
	DistanceType *geodistancetype.GeoDistanceType `json:"distance_type,omitempty"`
	// Field A field of type `geo_point` used to evaluate the distance.
	Field *string `json:"field,omitempty"`
	// Origin The origin  used to evaluate the distance.
	Origin GeoLocation `json:"origin,omitempty"`
	// Ranges An array of ranges used to bucket documents.
	Ranges []AggregationRange `json:"ranges,omitempty"`
	// Unit The distance unit.
	Unit *distanceunit.DistanceUnit `json:"unit,omitempty"`
}

GeoDistanceAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L396-L419

func NewGeoDistanceAggregation added in v8.5.0 

func NewGeoDistanceAggregation() *GeoDistanceAggregation

NewGeoDistanceAggregation returns a GeoDistanceAggregation.

func (*GeoDistanceAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoDistanceAggregation) UnmarshalJSON(data []byte) error

type GeoDistanceFeatureQuery 

type GeoDistanceFeatureQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field used to calculate distances. This field must meet the
	// following criteria:
	// be a `date`, `date_nanos` or `geo_point` field;
	// have an `index` mapping parameter value of `true`, which is the default;
	// have an `doc_values` mapping parameter value of `true`, which is the default.
	Field string `json:"field"`
	// Origin Date or point of origin used to calculate distances.
	// If the `field` value is a `date` or `date_nanos` field, the `origin` value
	// must be a date.
	// Date Math, such as `now-1h`, is supported.
	// If the field value is a `geo_point` field, the `origin` value must be a
	// geopoint.
	Origin GeoLocation `json:"origin"`
	// Pivot Distance from the `origin` at which relevance scores receive half of the
	// `boost` value.
	// If the `field` value is a `date` or `date_nanos` field, the `pivot` value
	// must be a time unit, such as `1h` or `10d`. If the `field` value is a
	// `geo_point` field, the `pivot` value must be a distance unit, such as `1km`
	// or `12m`.
	Pivot      string  `json:"pivot"`
	QueryName_ *string `json:"_name,omitempty"`
}

GeoDistanceFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L66-L69

func NewGeoDistanceFeatureQuery added in v8.5.0 

func NewGeoDistanceFeatureQuery() *GeoDistanceFeatureQuery

NewGeoDistanceFeatureQuery returns a GeoDistanceFeatureQuery.

func (*GeoDistanceFeatureQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoDistanceFeatureQuery) UnmarshalJSON(data []byte) error

type GeoDistanceQuery 

type GeoDistanceQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Distance The radius of the circle centred on the specified location.
	// Points which fall into this circle are considered to be matches.
	Distance string `json:"distance"`
	// DistanceType How to compute the distance.
	// Set to `plane` for a faster calculation that's inaccurate on long distances
	// and close to the poles.
	DistanceType     *geodistancetype.GeoDistanceType `json:"distance_type,omitempty"`
	GeoDistanceQuery map[string]GeoLocation           `json:"-"`
	// IgnoreUnmapped Set to `true` to ignore an unmapped field and not match any documents for
	// this query.
	// Set to `false` to throw an exception if the field is not mapped.
	IgnoreUnmapped *bool   `json:"ignore_unmapped,omitempty"`
	QueryName_     *string `json:"_name,omitempty"`
	// ValidationMethod Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or
	// longitude.
	// Set to `COERCE` to also try to infer correct latitude or longitude.
	ValidationMethod *geovalidationmethod.GeoValidationMethod `json:"validation_method,omitempty"`
}

GeoDistanceQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L64-L96

func NewGeoDistanceQuery added in v8.5.0 

func NewGeoDistanceQuery() *GeoDistanceQuery

NewGeoDistanceQuery returns a GeoDistanceQuery.

func (GeoDistanceQuery) MarshalJSON 

func (s GeoDistanceQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoDistanceQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoDistanceQuery) UnmarshalJSON(data []byte) error

type GeoDistanceSort 

type GeoDistanceSort struct {
	DistanceType    *geodistancetype.GeoDistanceType `json:"distance_type,omitempty"`
	GeoDistanceSort map[string][]GeoLocation         `json:"-"`
	IgnoreUnmapped  *bool                            `json:"ignore_unmapped,omitempty"`
	Mode            *sortmode.SortMode               `json:"mode,omitempty"`
	Nested          *NestedSortValue                 `json:"nested,omitempty"`
	Order           *sortorder.SortOrder             `json:"order,omitempty"`
	Unit            *distanceunit.DistanceUnit       `json:"unit,omitempty"`
}

GeoDistanceSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L58-L70

func NewGeoDistanceSort added in v8.5.0 

func NewGeoDistanceSort() *GeoDistanceSort

NewGeoDistanceSort returns a GeoDistanceSort.

func (GeoDistanceSort) MarshalJSON 

func (s GeoDistanceSort) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoDistanceSort) UnmarshalJSON added in v8.7.1 

func (s *GeoDistanceSort) UnmarshalJSON(data []byte) error

type GeoGridProcessor added in v8.16.0 

type GeoGridProcessor struct {
	// ChildrenField If specified and children tiles exist, save those tile addresses to this
	// field as an array of strings.
	ChildrenField *string `json:"children_field,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to interpret as a geo-tile.=
	// The field format is determined by the `tile_type`.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// NonChildrenField If specified and intersecting non-child tiles exist, save their addresses to
	// this field as an array of strings.
	NonChildrenField *string `json:"non_children_field,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// ParentField If specified and a parent tile exists, save that tile address to this field.
	ParentField *string `json:"parent_field,omitempty"`
	// PrecisionField If specified, save the tile precision (zoom) as an integer to this field.
	PrecisionField *string `json:"precision_field,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the polygon shape to, by default, the `field` is updated
	// in-place.
	TargetField *string `json:"target_field,omitempty"`
	// TargetFormat Which format to save the generated polygon in.
	TargetFormat *geogridtargetformat.GeoGridTargetFormat `json:"target_format,omitempty"`
	// TileType Three tile formats are understood: geohash, geotile and geohex.
	TileType geogridtiletype.GeoGridTileType `json:"tile_type"`
}

GeoGridProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L388-L429

func NewGeoGridProcessor added in v8.16.0 

func NewGeoGridProcessor() *GeoGridProcessor

NewGeoGridProcessor returns a GeoGridProcessor.

func (*GeoGridProcessor) UnmarshalJSON added in v8.16.0 

func (s *GeoGridProcessor) UnmarshalJSON(data []byte) error

type GeoGridQuery added in v8.18.0 

type GeoGridQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	Geohash    *string  `json:"geohash,omitempty"`
	Geohex     *string  `json:"geohex,omitempty"`
	Geotile    *string  `json:"geotile,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

GeoGridQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L98-L103

func NewGeoGridQuery added in v8.18.0 

func NewGeoGridQuery() *GeoGridQuery

NewGeoGridQuery returns a GeoGridQuery.

func (*GeoGridQuery) UnmarshalJSON added in v8.18.0 

func (s *GeoGridQuery) UnmarshalJSON(data []byte) error

type GeoHashGridAggregate 

type GeoHashGridAggregate struct {
	Buckets BucketsGeoHashGridBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

GeoHashGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L566-L568

func NewGeoHashGridAggregate added in v8.5.0 

func NewGeoHashGridAggregate() *GeoHashGridAggregate

NewGeoHashGridAggregate returns a GeoHashGridAggregate.

func (*GeoHashGridAggregate) UnmarshalJSON added in v8.7.0 

func (s *GeoHashGridAggregate) UnmarshalJSON(data []byte) error

type GeoHashGridAggregation 

type GeoHashGridAggregation struct {
	// Bounds The bounding box to filter the points in each bucket.
	Bounds GeoBounds `json:"bounds,omitempty"`
	// Field Field containing indexed `geo_point` or `geo_shape` values.
	// If the field contains an array, `geohash_grid` aggregates all array values.
	Field *string `json:"field,omitempty"`
	// Precision The string length of the geohashes used to define cells/buckets in the
	// results.
	Precision GeoHashPrecision `json:"precision,omitempty"`
	// ShardSize Allows for more accurate counting of the top cells returned in the final
	// result the aggregation.
	// Defaults to returning `max(10,(size x number-of-shards))` buckets from each
	// shard.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The maximum number of geohash buckets to return.
	Size *int `json:"size,omitempty"`
}

GeoHashGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L421-L449

func NewGeoHashGridAggregation added in v8.5.0 

func NewGeoHashGridAggregation() *GeoHashGridAggregation

NewGeoHashGridAggregation returns a GeoHashGridAggregation.

func (*GeoHashGridAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoHashGridAggregation) UnmarshalJSON(data []byte) error

type GeoHashGridBucket 

type GeoHashGridBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
}

GeoHashGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L570-L572

func NewGeoHashGridBucket added in v8.5.0 

func NewGeoHashGridBucket() *GeoHashGridBucket

NewGeoHashGridBucket returns a GeoHashGridBucket.

func (GeoHashGridBucket) MarshalJSON 

func (s GeoHashGridBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoHashGridBucket) UnmarshalJSON added in v8.7.0 

func (s *GeoHashGridBucket) UnmarshalJSON(data []byte) error

type GeoHashLocation 

type GeoHashLocation struct {
	Geohash string `json:"geohash"`
}

GeoHashLocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L131-L133

func NewGeoHashLocation added in v8.5.0 

func NewGeoHashLocation() *GeoHashLocation

NewGeoHashLocation returns a GeoHashLocation.

func (*GeoHashLocation) UnmarshalJSON added in v8.7.1 

func (s *GeoHashLocation) UnmarshalJSON(data []byte) error

type GeoHashPrecision 

type GeoHashPrecision any

GeoHashPrecision holds the union for the following types: 

int
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L86-L90

type GeoHexGridAggregate added in v8.5.0 

type GeoHexGridAggregate struct {
	Buckets BucketsGeoHexGridBucket `json:"buckets"`
	Meta    Metadata                `json:"meta,omitempty"`
}

GeoHexGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L585-L586

func NewGeoHexGridAggregate added in v8.5.0 

func NewGeoHexGridAggregate() *GeoHexGridAggregate

NewGeoHexGridAggregate returns a GeoHexGridAggregate.

func (*GeoHexGridAggregate) UnmarshalJSON added in v8.7.0 

func (s *GeoHexGridAggregate) UnmarshalJSON(data []byte) error

type GeoHexGridBucket added in v8.5.0 

type GeoHexGridBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
}

GeoHexGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L588-L590

func NewGeoHexGridBucket added in v8.5.0 

func NewGeoHexGridBucket() *GeoHexGridBucket

NewGeoHexGridBucket returns a GeoHexGridBucket.

func (GeoHexGridBucket) MarshalJSON added in v8.5.0 

func (s GeoHexGridBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoHexGridBucket) UnmarshalJSON added in v8.7.0 

func (s *GeoHexGridBucket) UnmarshalJSON(data []byte) error

type GeoIpDownloadStatistics 

type GeoIpDownloadStatistics struct {
	// DatabasesCount Current number of databases available for use.
	DatabasesCount int `json:"databases_count"`
	// ExpiredDatabases Total number of databases not updated after 30 days
	ExpiredDatabases int `json:"expired_databases"`
	// FailedDownloads Total number of failed database downloads.
	FailedDownloads int `json:"failed_downloads"`
	// SkippedUpdates Total number of database updates skipped.
	SkippedUpdates int `json:"skipped_updates"`
	// SuccessfulDownloads Total number of successful database downloads.
	SuccessfulDownloads int `json:"successful_downloads"`
	// TotalDownloadTime Total milliseconds spent downloading databases.
	TotalDownloadTime int64 `json:"total_download_time"`
}

GeoIpDownloadStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/geo_ip_stats/types.ts#L24-L37

func NewGeoIpDownloadStatistics added in v8.5.0 

func NewGeoIpDownloadStatistics() *GeoIpDownloadStatistics

NewGeoIpDownloadStatistics returns a GeoIpDownloadStatistics.

func (*GeoIpDownloadStatistics) UnmarshalJSON added in v8.7.1 

func (s *GeoIpDownloadStatistics) UnmarshalJSON(data []byte) error

type GeoIpNodeDatabaseName 

type GeoIpNodeDatabaseName struct {
	// Name Name of the database.
	Name string `json:"name"`
}

GeoIpNodeDatabaseName type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/geo_ip_stats/types.ts#L47-L50

func NewGeoIpNodeDatabaseName added in v8.5.0 

func NewGeoIpNodeDatabaseName() *GeoIpNodeDatabaseName

NewGeoIpNodeDatabaseName returns a GeoIpNodeDatabaseName.

func (*GeoIpNodeDatabaseName) UnmarshalJSON added in v8.7.1 

func (s *GeoIpNodeDatabaseName) UnmarshalJSON(data []byte) error

type GeoIpNodeDatabases 

type GeoIpNodeDatabases struct {
	// Databases Downloaded databases for the node.
	Databases []GeoIpNodeDatabaseName `json:"databases"`
	// FilesInTemp Downloaded database files, including related license files. Elasticsearch
	// stores these files in the node’s temporary directory:
	// $ES_TMPDIR/geoip-databases/<node_id>.
	FilesInTemp []string `json:"files_in_temp"`
}

GeoIpNodeDatabases type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/geo_ip_stats/types.ts#L39-L45

func NewGeoIpNodeDatabases added in v8.5.0 

func NewGeoIpNodeDatabases() *GeoIpNodeDatabases

NewGeoIpNodeDatabases returns a GeoIpNodeDatabases.

type GeoIpProcessor 

type GeoIpProcessor struct {
	// DatabaseFile The database filename referring to a database the module ships with
	// (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom
	// database in the ingest-geoip config directory.
	DatabaseFile *string `json:"database_file,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// DownloadDatabaseOnPipelineCreation If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the
	// missing database is downloaded when the pipeline is created.
	// Else, the download is triggered by when the pipeline is used as the
	// `default_pipeline` or `final_pipeline` in an index.
	DownloadDatabaseOnPipelineCreation *bool `json:"download_database_on_pipeline_creation,omitempty"`
	// Field The field to get the ip address from for the geographical lookup.
	Field string `json:"field"`
	// FirstOnly If `true`, only the first found geoip data will be returned, even if the
	// field contains an array.
	FirstOnly *bool `json:"first_only,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Properties Controls what properties are added to the `target_field` based on the geoip
	// lookup.
	Properties []string `json:"properties,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that will hold the geographical information looked up from the
	// MaxMind database.
	TargetField *string `json:"target_field,omitempty"`
}

GeoIpProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L442-L476

func NewGeoIpProcessor added in v8.5.0 

func NewGeoIpProcessor() *GeoIpProcessor

NewGeoIpProcessor returns a GeoIpProcessor.

func (*GeoIpProcessor) UnmarshalJSON added in v8.7.1 

func (s *GeoIpProcessor) UnmarshalJSON(data []byte) error

type GeoLine 

type GeoLine struct {
	// Coordinates Array of `[lon, lat]` coordinates
	Coordinates [][]Float64 `json:"coordinates"`
	// Type Always `"LineString"`
	Type string `json:"type"`
}

GeoLine type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L56-L62

func NewGeoLine added in v8.5.0 

func NewGeoLine() *GeoLine

NewGeoLine returns a GeoLine.

func (*GeoLine) UnmarshalJSON added in v8.7.1 

func (s *GeoLine) UnmarshalJSON(data []byte) error

type GeoLineAggregate 

type GeoLineAggregate struct {
	Geometry   GeoLine         `json:"geometry"`
	Meta       Metadata        `json:"meta,omitempty"`
	Properties json.RawMessage `json:"properties,omitempty"`
	Type       string          `json:"type"`
}

GeoLineAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L902-L912

func NewGeoLineAggregate added in v8.5.0 

func NewGeoLineAggregate() *GeoLineAggregate

NewGeoLineAggregate returns a GeoLineAggregate.

func (*GeoLineAggregate) UnmarshalJSON added in v8.7.1 

func (s *GeoLineAggregate) UnmarshalJSON(data []byte) error

type GeoLineAggregation 

type GeoLineAggregation struct {
	// IncludeSort When `true`, returns an additional array of the sort values in the feature
	// properties.
	IncludeSort *bool `json:"include_sort,omitempty"`
	// Point The name of the geo_point field.
	Point GeoLinePoint `json:"point"`
	// Size The maximum length of the line represented in the aggregation.
	// Valid sizes are between 1 and 10000.
	Size *int `json:"size,omitempty"`
	// Sort The name of the numeric field to use as the sort key for ordering the points.
	// When the `geo_line` aggregation is nested inside a `time_series` aggregation,
	// this field defaults to `@timestamp`, and any other value will result in
	// error.
	Sort GeoLineSort `json:"sort"`
	// SortOrder The order in which the line is sorted (ascending or descending).
	SortOrder *sortorder.SortOrder `json:"sort_order,omitempty"`
}

GeoLineAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L124-L149

func NewGeoLineAggregation added in v8.5.0 

func NewGeoLineAggregation() *GeoLineAggregation

NewGeoLineAggregation returns a GeoLineAggregation.

func (*GeoLineAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoLineAggregation) UnmarshalJSON(data []byte) error

type GeoLinePoint 

type GeoLinePoint struct {
	// Field The name of the geo_point field.
	Field string `json:"field"`
}

GeoLinePoint type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L158-L163

func NewGeoLinePoint added in v8.5.0 

func NewGeoLinePoint() *GeoLinePoint

NewGeoLinePoint returns a GeoLinePoint.

func (*GeoLinePoint) UnmarshalJSON added in v8.7.1 

func (s *GeoLinePoint) UnmarshalJSON(data []byte) error

type GeoLineSort 

type GeoLineSort struct {
	// Field The name of the numeric field to use as the sort key for ordering the points.
	Field string `json:"field"`
}

GeoLineSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L151-L156

func NewGeoLineSort added in v8.5.0 

func NewGeoLineSort() *GeoLineSort

NewGeoLineSort returns a GeoLineSort.

func (*GeoLineSort) UnmarshalJSON added in v8.7.1 

func (s *GeoLineSort) UnmarshalJSON(data []byte) error

type GeoLocation 

type GeoLocation any

GeoLocation holds the union for the following types: 

LatLonGeoLocation
GeoHashLocation
[]Float64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L104-L118

type GeoPointProperty 

type GeoPointProperty struct {
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	IgnoreZValue    *bool                          `json:"ignore_z_value,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           GeoLocation                                      `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

GeoPointProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/geo.ts#L24-L32

func NewGeoPointProperty added in v8.5.0 

func NewGeoPointProperty() *GeoPointProperty

NewGeoPointProperty returns a GeoPointProperty.

func (GeoPointProperty) MarshalJSON added in v8.9.0 

func (s GeoPointProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GeoPointProperty) UnmarshalJSON added in v8.7.0 

func (s *GeoPointProperty) UnmarshalJSON(data []byte) error

type GeoPolygonPoints 

type GeoPolygonPoints struct {
	Points []GeoLocation `json:"points"`
}

GeoPolygonPoints type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L105-L107

func NewGeoPolygonPoints added in v8.5.0 

func NewGeoPolygonPoints() *GeoPolygonPoints

NewGeoPolygonPoints returns a GeoPolygonPoints.

type GeoPolygonQuery 

type GeoPolygonQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost            *float32                                 `json:"boost,omitempty"`
	GeoPolygonQuery  map[string]GeoPolygonPoints              `json:"-"`
	IgnoreUnmapped   *bool                                    `json:"ignore_unmapped,omitempty"`
	QueryName_       *string                                  `json:"_name,omitempty"`
	ValidationMethod *geovalidationmethod.GeoValidationMethod `json:"validation_method,omitempty"`
}

GeoPolygonQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L109-L121

func NewGeoPolygonQuery added in v8.5.0 

func NewGeoPolygonQuery() *GeoPolygonQuery

NewGeoPolygonQuery returns a GeoPolygonQuery.

func (GeoPolygonQuery) MarshalJSON 

func (s GeoPolygonQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoPolygonQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoPolygonQuery) UnmarshalJSON(data []byte) error

type GeoResults added in v8.7.0 

type GeoResults struct {
	// ActualPoint The actual value for the bucket formatted as a `geo_point`.
	ActualPoint *string `json:"actual_point,omitempty"`
	// TypicalPoint The typical value for the bucket formatted as a `geo_point`.
	TypicalPoint *string `json:"typical_point,omitempty"`
}

GeoResults type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Anomaly.ts#L146-L155

func NewGeoResults added in v8.7.0 

func NewGeoResults() *GeoResults

NewGeoResults returns a GeoResults.

func (*GeoResults) UnmarshalJSON added in v8.9.0 

func (s *GeoResults) UnmarshalJSON(data []byte) error

type GeoShapeFieldQuery 

type GeoShapeFieldQuery struct {
	// IndexedShape Query using an indexed shape retrieved from the the specified document and
	// path.
	IndexedShape *FieldLookup `json:"indexed_shape,omitempty"`
	// Relation Spatial relation operator used to search a geo field.
	Relation *geoshaperelation.GeoShapeRelation `json:"relation,omitempty"`
	Shape    json.RawMessage                    `json:"shape,omitempty"`
}

GeoShapeFieldQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L128-L139

func NewGeoShapeFieldQuery added in v8.5.0 

func NewGeoShapeFieldQuery() *GeoShapeFieldQuery

NewGeoShapeFieldQuery returns a GeoShapeFieldQuery.

func (*GeoShapeFieldQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoShapeFieldQuery) UnmarshalJSON(data []byte) error

type GeoShapeProperty 

type GeoShapeProperty struct {
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	IgnoreZValue    *bool                          `json:"ignore_z_value,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Orientation         *geoorientation.GeoOrientation                   `json:"orientation,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	Strategy            *geostrategy.GeoStrategy                         `json:"strategy,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

GeoShapeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/geo.ts#L41-L55

func NewGeoShapeProperty added in v8.5.0 

func NewGeoShapeProperty() *GeoShapeProperty

NewGeoShapeProperty returns a GeoShapeProperty.

func (GeoShapeProperty) MarshalJSON added in v8.9.0 

func (s GeoShapeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GeoShapeProperty) UnmarshalJSON added in v8.7.0 

func (s *GeoShapeProperty) UnmarshalJSON(data []byte) error

type GeoShapeQuery 

type GeoShapeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost         *float32                      `json:"boost,omitempty"`
	GeoShapeQuery map[string]GeoShapeFieldQuery `json:"-"`
	// IgnoreUnmapped Set to `true` to ignore an unmapped field and not match any documents for
	// this query.
	// Set to `false` to throw an exception if the field is not mapped.
	IgnoreUnmapped *bool   `json:"ignore_unmapped,omitempty"`
	QueryName_     *string `json:"_name,omitempty"`
}

GeoShapeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/geo.ts#L141-L157

func NewGeoShapeQuery added in v8.5.0 

func NewGeoShapeQuery() *GeoShapeQuery

NewGeoShapeQuery returns a GeoShapeQuery.

func (GeoShapeQuery) MarshalJSON 

func (s GeoShapeQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoShapeQuery) UnmarshalJSON added in v8.7.1 

func (s *GeoShapeQuery) UnmarshalJSON(data []byte) error

type GeoTileGridAggregate 

type GeoTileGridAggregate struct {
	Buckets BucketsGeoTileGridBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

GeoTileGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L574-L579

func NewGeoTileGridAggregate added in v8.5.0 

func NewGeoTileGridAggregate() *GeoTileGridAggregate

NewGeoTileGridAggregate returns a GeoTileGridAggregate.

func (*GeoTileGridAggregate) UnmarshalJSON added in v8.7.0 

func (s *GeoTileGridAggregate) UnmarshalJSON(data []byte) error

type GeoTileGridAggregation 

type GeoTileGridAggregation struct {
	// Bounds A bounding box to filter the geo-points or geo-shapes in each bucket.
	Bounds GeoBounds `json:"bounds,omitempty"`
	// Field Field containing indexed `geo_point` or `geo_shape` values.
	// If the field contains an array, `geotile_grid` aggregates all array values.
	Field *string `json:"field,omitempty"`
	// Precision Integer zoom of the key used to define cells/buckets in the results.
	// Values outside of the range [0,29] will be rejected.
	Precision *int `json:"precision,omitempty"`
	// ShardSize Allows for more accurate counting of the top cells returned in the final
	// result the aggregation.
	// Defaults to returning `max(10,(size x number-of-shards))` buckets from each
	// shard.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The maximum number of buckets to return.
	Size *int `json:"size,omitempty"`
}

GeoTileGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L451-L477

func NewGeoTileGridAggregation added in v8.5.0 

func NewGeoTileGridAggregation() *GeoTileGridAggregation

NewGeoTileGridAggregation returns a GeoTileGridAggregation.

func (*GeoTileGridAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeoTileGridAggregation) UnmarshalJSON(data []byte) error

type GeoTileGridBucket 

type GeoTileGridBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
}

GeoTileGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L581-L583

func NewGeoTileGridBucket added in v8.5.0 

func NewGeoTileGridBucket() *GeoTileGridBucket

NewGeoTileGridBucket returns a GeoTileGridBucket.

func (GeoTileGridBucket) MarshalJSON 

func (s GeoTileGridBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GeoTileGridBucket) UnmarshalJSON added in v8.7.0 

func (s *GeoTileGridBucket) UnmarshalJSON(data []byte) error

type GeohexGridAggregation 

type GeohexGridAggregation struct {
	// Bounds Bounding box used to filter the geo-points in each bucket.
	Bounds GeoBounds `json:"bounds,omitempty"`
	// Field Field containing indexed `geo_point` or `geo_shape` values.
	// If the field contains an array, `geohex_grid` aggregates all array values.
	Field string `json:"field"`
	// Precision Integer zoom of the key used to defined cells or buckets
	// in the results. Value should be between 0-15.
	Precision *int `json:"precision,omitempty"`
	// ShardSize Number of buckets returned from each shard.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size Maximum number of buckets to return.
	Size *int `json:"size,omitempty"`
}

GeohexGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L479-L504

func NewGeohexGridAggregation added in v8.5.0 

func NewGeohexGridAggregation() *GeohexGridAggregation

NewGeohexGridAggregation returns a GeohexGridAggregation.

func (*GeohexGridAggregation) UnmarshalJSON added in v8.7.1 

func (s *GeohexGridAggregation) UnmarshalJSON(data []byte) error

type GeoipDatabaseConfigurationMetadata added in v8.18.0 

type GeoipDatabaseConfigurationMetadata struct {
	Database           DatabaseConfiguration `json:"database"`
	Id                 string                `json:"id"`
	ModifiedDateMillis int64                 `json:"modified_date_millis"`
	Version            int64                 `json:"version"`
}

GeoipDatabaseConfigurationMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/get_geoip_database/GetGeoipDatabaseResponse.ts#L29-L34

func NewGeoipDatabaseConfigurationMetadata added in v8.18.0 

func NewGeoipDatabaseConfigurationMetadata() *GeoipDatabaseConfigurationMetadata

NewGeoipDatabaseConfigurationMetadata returns a GeoipDatabaseConfigurationMetadata.

func (*GeoipDatabaseConfigurationMetadata) UnmarshalJSON added in v8.18.0 

func (s *GeoipDatabaseConfigurationMetadata) UnmarshalJSON(data []byte) error

type GermanAnalyzer added in v8.16.0 

type GermanAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

GermanAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L166-L171

func NewGermanAnalyzer added in v8.16.0 

func NewGermanAnalyzer() *GermanAnalyzer

NewGermanAnalyzer returns a GermanAnalyzer.

func (GermanAnalyzer) MarshalJSON added in v8.16.0 

func (s GermanAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GermanAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *GermanAnalyzer) UnmarshalJSON(data []byte) error

type GermanNormalizationTokenFilter added in v8.18.1 

type GermanNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

GermanNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L489-L491

func NewGermanNormalizationTokenFilter added in v8.18.1 

func NewGermanNormalizationTokenFilter() *GermanNormalizationTokenFilter

NewGermanNormalizationTokenFilter returns a GermanNormalizationTokenFilter.

func (GermanNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s GermanNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GermanNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *GermanNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type GetMigrationFeature added in v8.5.0 

type GetMigrationFeature struct {
	FeatureName         string                          `json:"feature_name"`
	Indices             []MigrationFeatureIndexInfo     `json:"indices"`
	MigrationStatus     migrationstatus.MigrationStatus `json:"migration_status"`
	MinimumIndexVersion string                          `json:"minimum_index_version"`
}

GetMigrationFeature type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L37-L42

func NewGetMigrationFeature added in v8.5.0 

func NewGetMigrationFeature() *GetMigrationFeature

NewGetMigrationFeature returns a GetMigrationFeature.

func (*GetMigrationFeature) UnmarshalJSON added in v8.7.1 

func (s *GetMigrationFeature) UnmarshalJSON(data []byte) error

type GetResult 

type GetResult struct {
	// Fields If the `stored_fields` parameter is set to `true` and `found` is `true`, it
	// contains the document fields stored in the index.
	Fields map[string]json.RawMessage `json:"fields,omitempty"`
	// Found Indicates whether the document exists.
	Found bool `json:"found"`
	// Id_ The unique identifier for the document.
	Id_      string   `json:"_id"`
	Ignored_ []string `json:"_ignored,omitempty"`
	// Index_ The name of the index the document belongs to.
	Index_ string `json:"_index"`
	// PrimaryTerm_ The primary term assigned to the document for the indexing operation.
	PrimaryTerm_ *int64 `json:"_primary_term,omitempty"`
	// Routing_ The explicit routing, if set.
	Routing_ *string `json:"_routing,omitempty"`
	// SeqNo_ The sequence number assigned to the document for the indexing operation.
	// Sequence numbers are used to ensure an older version of a document doesn't
	// overwrite a newer version.
	SeqNo_ *int64 `json:"_seq_no,omitempty"`
	// Source_ If `found` is `true`, it contains the document data formatted in JSON.
	// If the `_source` parameter is set to `false` or the `stored_fields` parameter
	// is set to `true`, it is excluded.
	Source_ json.RawMessage `json:"_source,omitempty"`
	// Version_ The document version, which is ncremented each time the document is updated.
	Version_ *int64 `json:"_version,omitempty"`
}

GetResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/get/types.ts#L25-L67

func NewGetResult added in v8.5.0 

func NewGetResult() *GetResult

NewGetResult returns a GetResult.

func (*GetResult) UnmarshalJSON added in v8.7.1 

func (s *GetResult) UnmarshalJSON(data []byte) error

type GetScriptContext added in v8.5.0 

type GetScriptContext struct {
	Methods []ContextMethod `json:"methods"`
	Name    string          `json:"name"`
}

GetScriptContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/get_script_context/types.ts#L22-L25

func NewGetScriptContext added in v8.5.0 

func NewGetScriptContext() *GetScriptContext

NewGetScriptContext returns a GetScriptContext.

func (*GetScriptContext) UnmarshalJSON added in v8.7.1 

func (s *GetScriptContext) UnmarshalJSON(data []byte) error

type GetStats 

type GetStats struct {
	Current             int64    `json:"current"`
	ExistsTime          Duration `json:"exists_time,omitempty"`
	ExistsTimeInMillis  int64    `json:"exists_time_in_millis"`
	ExistsTotal         int64    `json:"exists_total"`
	MissingTime         Duration `json:"missing_time,omitempty"`
	MissingTimeInMillis int64    `json:"missing_time_in_millis"`
	MissingTotal        int64    `json:"missing_total"`
	Time                Duration `json:"time,omitempty"`
	TimeInMillis        int64    `json:"time_in_millis"`
	Total               int64    `json:"total"`
}

GetStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L133-L144

func NewGetStats added in v8.5.0 

func NewGetStats() *GetStats

NewGetStats returns a GetStats.

func (*GetStats) UnmarshalJSON added in v8.7.1 

func (s *GetStats) UnmarshalJSON(data []byte) error

type GetUserProfileErrors added in v8.5.0 

type GetUserProfileErrors struct {
	Count   int64                 `json:"count"`
	Details map[string]ErrorCause `json:"details"`
}

GetUserProfileErrors type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_user_profile/types.ts#L25-L28

func NewGetUserProfileErrors added in v8.5.0 

func NewGetUserProfileErrors() *GetUserProfileErrors

NewGetUserProfileErrors returns a GetUserProfileErrors.

func (*GetUserProfileErrors) UnmarshalJSON added in v8.7.1 

func (s *GetUserProfileErrors) UnmarshalJSON(data []byte) error

type GlobalAggregate 

type GlobalAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

GlobalAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L546-L550

func NewGlobalAggregate added in v8.5.0 

func NewGlobalAggregate() *GlobalAggregate

NewGlobalAggregate returns a GlobalAggregate.

func (GlobalAggregate) MarshalJSON 

func (s GlobalAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*GlobalAggregate) UnmarshalJSON added in v8.7.0 

func (s *GlobalAggregate) UnmarshalJSON(data []byte) error

type GlobalAggregation 

type GlobalAggregation struct {
}

GlobalAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L506-L506

func NewGlobalAggregation added in v8.5.0 

func NewGlobalAggregation() *GlobalAggregation

NewGlobalAggregation returns a GlobalAggregation.

type GlobalPrivilege 

type GlobalPrivilege struct {
	Application ApplicationGlobalUserPrivileges `json:"application"`
}

GlobalPrivilege type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L430-L432

func NewGlobalPrivilege added in v8.5.0 

func NewGlobalPrivilege() *GlobalPrivilege

NewGlobalPrivilege returns a GlobalPrivilege.

type GoogleAiStudioServiceSettings added in v8.18.0 

type GoogleAiStudioServiceSettings struct {
	// ApiKey A valid API key of your Google Gemini account.
	ApiKey string `json:"api_key"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the Google documentation for the list of supported models.
	ModelId string `json:"model_id"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Google AI Studio.
	// By default, the `googleaistudio` service sets the number of requests allowed
	// per minute to 360.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
}

GoogleAiStudioServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L867-L883

func NewGoogleAiStudioServiceSettings added in v8.18.0 

func NewGoogleAiStudioServiceSettings() *GoogleAiStudioServiceSettings

NewGoogleAiStudioServiceSettings returns a GoogleAiStudioServiceSettings.

func (*GoogleAiStudioServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *GoogleAiStudioServiceSettings) UnmarshalJSON(data []byte) error

type GoogleNormalizedDistanceHeuristic 

type GoogleNormalizedDistanceHeuristic struct {
	// BackgroundIsSuperset Set to `false` if you defined a custom background filter that represents a
	// different set of documents that you want to compare to.
	BackgroundIsSuperset *bool `json:"background_is_superset,omitempty"`
}

GoogleNormalizedDistanceHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L793-L798

func NewGoogleNormalizedDistanceHeuristic added in v8.5.0 

func NewGoogleNormalizedDistanceHeuristic() *GoogleNormalizedDistanceHeuristic

NewGoogleNormalizedDistanceHeuristic returns a GoogleNormalizedDistanceHeuristic.

func (*GoogleNormalizedDistanceHeuristic) UnmarshalJSON added in v8.7.1 

func (s *GoogleNormalizedDistanceHeuristic) UnmarshalJSON(data []byte) error

type GoogleVertexAIServiceSettings added in v8.18.0 

type GoogleVertexAIServiceSettings struct {
	// Location The name of the location to use for the inference task.
	// Refer to the Google documentation for the list of supported locations.
	Location string `json:"location"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the Google documentation for the list of supported models.
	ModelId string `json:"model_id"`
	// ProjectId The name of the project to use for the inference task.
	ProjectId string `json:"project_id"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Google Vertex AI.
	// By default, the `googlevertexai` service sets the number of requests allowed
	// per minute to 30.000.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// ServiceAccountJson A valid service account in JSON format for the Google Vertex AI API.
	ServiceAccountJson string `json:"service_account_json"`
}

GoogleVertexAIServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L894-L920

func NewGoogleVertexAIServiceSettings added in v8.18.0 

func NewGoogleVertexAIServiceSettings() *GoogleVertexAIServiceSettings

NewGoogleVertexAIServiceSettings returns a GoogleVertexAIServiceSettings.

func (*GoogleVertexAIServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *GoogleVertexAIServiceSettings) UnmarshalJSON(data []byte) error

type GoogleVertexAITaskSettings added in v8.18.0 

type GoogleVertexAITaskSettings struct {
	// AutoTruncate For a `text_embedding` task, truncate inputs longer than the maximum token
	// length automatically.
	AutoTruncate *bool `json:"auto_truncate,omitempty"`
	// TopN For a `rerank` task, the number of the top N documents that should be
	// returned.
	TopN *int `json:"top_n,omitempty"`
}

GoogleVertexAITaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L922-L931

func NewGoogleVertexAITaskSettings added in v8.18.0 

func NewGoogleVertexAITaskSettings() *GoogleVertexAITaskSettings

NewGoogleVertexAITaskSettings returns a GoogleVertexAITaskSettings.

func (*GoogleVertexAITaskSettings) UnmarshalJSON added in v8.18.0 

func (s *GoogleVertexAITaskSettings) UnmarshalJSON(data []byte) error

type GrantApiKey 

type GrantApiKey struct {
	// Expiration Expiration time for the API key. By default, API keys never expire.
	Expiration *string `json:"expiration,omitempty"`
	// Metadata Arbitrary metadata that you want to associate with the API key.
	// It supports nested data structure.
	// Within the `metadata` object, keys beginning with `_` are reserved for system
	// usage.
	Metadata Metadata `json:"metadata,omitempty"`
	Name     string   `json:"name"`
	// RoleDescriptors The role descriptors for this API key.
	// When it is not specified or is an empty array, the API key has a point in
	// time snapshot of permissions of the specified user or access token.
	// If you supply role descriptors, the resultant permissions are an intersection
	// of API keys permissions and the permissions of the user or access token.
	RoleDescriptors []map[string]RoleDescriptor `json:"role_descriptors,omitempty"`
}

GrantApiKey type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/grant_api_key/types.ts#L25-L45

func NewGrantApiKey added in v8.5.0 

func NewGrantApiKey() *GrantApiKey

NewGrantApiKey returns a GrantApiKey.

func (*GrantApiKey) UnmarshalJSON added in v8.7.1 

func (s *GrantApiKey) UnmarshalJSON(data []byte) error

type GreaterThanValidation added in v8.15.0 

type GreaterThanValidation struct {
	Constraint Float64 `json:"constraint"`
	Type       string  `json:"type,omitempty"`
}

GreaterThanValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L63-L66

func NewGreaterThanValidation added in v8.15.0 

func NewGreaterThanValidation() *GreaterThanValidation

NewGreaterThanValidation returns a GreaterThanValidation.

func (GreaterThanValidation) MarshalJSON added in v8.15.0 

func (s GreaterThanValidation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GreaterThanValidation) UnmarshalJSON added in v8.15.0 

func (s *GreaterThanValidation) UnmarshalJSON(data []byte) error

type GreekAnalyzer added in v8.16.0 

type GreekAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

GreekAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L173-L177

func NewGreekAnalyzer added in v8.16.0 

func NewGreekAnalyzer() *GreekAnalyzer

NewGreekAnalyzer returns a GreekAnalyzer.

func (GreekAnalyzer) MarshalJSON added in v8.16.0 

func (s GreekAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*GreekAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *GreekAnalyzer) UnmarshalJSON(data []byte) error

type GrokProcessor 

type GrokProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// EcsCompatibility Must be disabled or v1. If v1, the processor uses patterns with Elastic
	// Common Schema (ECS) field names.
	EcsCompatibility *string `json:"ecs_compatibility,omitempty"`
	// Field The field to use for grok expression parsing.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// PatternDefinitions A map of pattern-name and pattern tuples defining custom patterns to be used
	// by the current processor.
	// Patterns matching existing names will override the pre-existing definition.
	PatternDefinitions map[string]string `json:"pattern_definitions,omitempty"`
	// Patterns An ordered list of grok expression to match and extract named captures with.
	// Returns on the first expression in the list that matches.
	Patterns []string `json:"patterns"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TraceMatch When `true`, `_ingest._grok_match_index` will be inserted into your matched
	// document’s metadata with the index into the pattern found in `patterns` that
	// matched.
	TraceMatch *bool `json:"trace_match,omitempty"`
}

GrokProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L950-L981

func NewGrokProcessor added in v8.5.0 

func NewGrokProcessor() *GrokProcessor

NewGrokProcessor returns a GrokProcessor.

func (*GrokProcessor) UnmarshalJSON added in v8.7.1 

func (s *GrokProcessor) UnmarshalJSON(data []byte) error

type Groupings 

type Groupings struct {
	// DateHistogram A date histogram group aggregates a date field into time-based buckets.
	// This group is mandatory; you currently cannot roll up documents without a
	// timestamp and a `date_histogram` group.
	DateHistogram *DateHistogramGrouping `json:"date_histogram,omitempty"`
	// Histogram The histogram group aggregates one or more numeric fields into numeric
	// histogram intervals.
	Histogram *HistogramGrouping `json:"histogram,omitempty"`
	// Terms The terms group can be used on keyword or numeric fields to allow bucketing
	// via the terms aggregation at a later point.
	// The indexer enumerates and stores all values of a field for each time-period.
	// This can be potentially costly for high-cardinality groups such as IP
	// addresses, especially if the time-bucket is particularly sparse.
	Terms *TermsGrouping `json:"terms,omitempty"`
}

Groupings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/_types/Groupings.ts#L24-L40

func NewGroupings added in v8.5.0 

func NewGroupings() *Groupings

NewGroupings returns a Groupings.

type GsubProcessor 

type GsubProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to apply the replacement to.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Pattern The pattern to be replaced.
	Pattern string `json:"pattern"`
	// Replacement The string to replace the matching patterns with.
	Replacement string `json:"replacement"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to
	// By default, the `field` is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

GsubProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L983-L1007

func NewGsubProcessor added in v8.5.0 

func NewGsubProcessor() *GsubProcessor

NewGsubProcessor returns a GsubProcessor.

func (*GsubProcessor) UnmarshalJSON added in v8.7.1 

func (s *GsubProcessor) UnmarshalJSON(data []byte) error

type HalfFloatNumberProperty 

type HalfFloatNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *float32                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

HalfFloatNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L160-L163

func NewHalfFloatNumberProperty added in v8.5.0 

func NewHalfFloatNumberProperty() *HalfFloatNumberProperty

NewHalfFloatNumberProperty returns a HalfFloatNumberProperty.

func (HalfFloatNumberProperty) MarshalJSON added in v8.9.0 

func (s HalfFloatNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HalfFloatNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *HalfFloatNumberProperty) UnmarshalJSON(data []byte) error

type HasChildQuery 

type HasChildQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// IgnoreUnmapped Indicates whether to ignore an unmapped `type` and not return any documents
	// instead of an error.
	IgnoreUnmapped *bool `json:"ignore_unmapped,omitempty"`
	// InnerHits If defined, each search hit will contain inner hits.
	InnerHits *InnerHits `json:"inner_hits,omitempty"`
	// MaxChildren Maximum number of child documents that match the query allowed for a returned
	// parent document.
	// If the parent document exceeds this limit, it is excluded from the search
	// results.
	MaxChildren *int `json:"max_children,omitempty"`
	// MinChildren Minimum number of child documents that match the query required to match the
	// query for a returned parent document.
	// If the parent document does not meet this limit, it is excluded from the
	// search results.
	MinChildren *int `json:"min_children,omitempty"`
	// Query Query you wish to run on child documents of the `type` field.
	// If a child document matches the search, the query returns the parent
	// document.
	Query      *Query  `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// ScoreMode Indicates how scores for matching child documents affect the root parent
	// document’s relevance score.
	ScoreMode *childscoremode.ChildScoreMode `json:"score_mode,omitempty"`
	// Type Name of the child relationship mapped for the `join` field.
	Type string `json:"type"`
}

HasChildQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/joining.ts#L41-L79

func NewHasChildQuery added in v8.5.0 

func NewHasChildQuery() *HasChildQuery

NewHasChildQuery returns a HasChildQuery.

func (*HasChildQuery) UnmarshalJSON added in v8.7.1 

func (s *HasChildQuery) UnmarshalJSON(data []byte) error

type HasParentQuery 

type HasParentQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// IgnoreUnmapped Indicates whether to ignore an unmapped `parent_type` and not return any
	// documents instead of an error.
	// You can use this parameter to query multiple indices that may not contain the
	// `parent_type`.
	IgnoreUnmapped *bool `json:"ignore_unmapped,omitempty"`
	// InnerHits If defined, each search hit will contain inner hits.
	InnerHits *InnerHits `json:"inner_hits,omitempty"`
	// ParentType Name of the parent relationship mapped for the `join` field.
	ParentType string `json:"parent_type"`
	// Query Query you wish to run on parent documents of the `parent_type` field.
	// If a parent document matches the search, the query returns its child
	// documents.
	Query      *Query  `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Score Indicates whether the relevance score of a matching parent document is
	// aggregated into its child documents.
	Score *bool `json:"score,omitempty"`
}

HasParentQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/joining.ts#L81-L110

func NewHasParentQuery added in v8.5.0 

func NewHasParentQuery() *HasParentQuery

NewHasParentQuery returns a HasParentQuery.

func (*HasParentQuery) UnmarshalJSON added in v8.7.1 

func (s *HasParentQuery) UnmarshalJSON(data []byte) error

type HasPrivilegesUserProfileErrors added in v8.5.0 

type HasPrivilegesUserProfileErrors struct {
	Count   int64                 `json:"count"`
	Details map[string]ErrorCause `json:"details"`
}

HasPrivilegesUserProfileErrors type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges_user_profile/types.ts#L39-L42

func NewHasPrivilegesUserProfileErrors added in v8.5.0 

func NewHasPrivilegesUserProfileErrors() *HasPrivilegesUserProfileErrors

NewHasPrivilegesUserProfileErrors returns a HasPrivilegesUserProfileErrors.

func (*HasPrivilegesUserProfileErrors) UnmarshalJSON added in v8.7.1 

func (s *HasPrivilegesUserProfileErrors) UnmarshalJSON(data []byte) error

type HdrMethod 

type HdrMethod struct {
	// NumberOfSignificantValueDigits Specifies the resolution of values for the histogram in number of significant
	// digits.
	NumberOfSignificantValueDigits *int `json:"number_of_significant_value_digits,omitempty"`
}

HdrMethod type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L225-L230

func NewHdrMethod added in v8.5.0 

func NewHdrMethod() *HdrMethod

NewHdrMethod returns a HdrMethod.

func (*HdrMethod) UnmarshalJSON added in v8.7.1 

func (s *HdrMethod) UnmarshalJSON(data []byte) error

type HdrPercentileRanksAggregate 

type HdrPercentileRanksAggregate struct {
	Meta   Metadata    `json:"meta,omitempty"`
	Values Percentiles `json:"values"`
}

HdrPercentileRanksAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L171-L172

func NewHdrPercentileRanksAggregate added in v8.5.0 

func NewHdrPercentileRanksAggregate() *HdrPercentileRanksAggregate

NewHdrPercentileRanksAggregate returns a HdrPercentileRanksAggregate.

func (*HdrPercentileRanksAggregate) UnmarshalJSON added in v8.7.1 

func (s *HdrPercentileRanksAggregate) UnmarshalJSON(data []byte) error

type HdrPercentilesAggregate 

type HdrPercentilesAggregate struct {
	Meta   Metadata    `json:"meta,omitempty"`
	Values Percentiles `json:"values"`
}

HdrPercentilesAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L168-L169

func NewHdrPercentilesAggregate added in v8.5.0 

func NewHdrPercentilesAggregate() *HdrPercentilesAggregate

NewHdrPercentilesAggregate returns a HdrPercentilesAggregate.

func (*HdrPercentilesAggregate) UnmarshalJSON added in v8.7.1 

func (s *HdrPercentilesAggregate) UnmarshalJSON(data []byte) error

type HealthRecord 

type HealthRecord struct {
	// ActiveShardsPercent active number of shards in percent
	ActiveShardsPercent *string `json:"active_shards_percent,omitempty"`
	// Cluster cluster name
	Cluster *string `json:"cluster,omitempty"`
	// Epoch seconds since 1970-01-01 00:00:00
	Epoch StringifiedEpochTimeUnitSeconds `json:"epoch,omitempty"`
	// Init number of initializing nodes
	Init *string `json:"init,omitempty"`
	// MaxTaskWaitTime wait time of longest task pending
	MaxTaskWaitTime *string `json:"max_task_wait_time,omitempty"`
	// NodeData number of nodes that can store data
	NodeData *string `json:"node.data,omitempty"`
	// NodeTotal total number of nodes
	NodeTotal *string `json:"node.total,omitempty"`
	// PendingTasks number of pending tasks
	PendingTasks *string `json:"pending_tasks,omitempty"`
	// Pri number of primary shards
	Pri *string `json:"pri,omitempty"`
	// Relo number of relocating nodes
	Relo *string `json:"relo,omitempty"`
	// Shards total number of shards
	Shards *string `json:"shards,omitempty"`
	// Status health status
	Status *string `json:"status,omitempty"`
	// Timestamp time in HH:MM:SS
	Timestamp *string `json:"timestamp,omitempty"`
	// Unassign number of unassigned shards
	Unassign *string `json:"unassign,omitempty"`
	// UnassignPri number of unassigned primary shards
	UnassignPri *string `json:"unassign.pri,omitempty"`
}

HealthRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/health/types.ts#L23-L99

func NewHealthRecord added in v8.5.0 

func NewHealthRecord() *HealthRecord

NewHealthRecord returns a HealthRecord.

func (*HealthRecord) UnmarshalJSON added in v8.7.1 

func (s *HealthRecord) UnmarshalJSON(data []byte) error

type HealthResponseBody added in v8.7.1 

type HealthResponseBody struct {
	// ActivePrimaryShards The number of active primary shards.
	ActivePrimaryShards int `json:"active_primary_shards"`
	// ActiveShards The total number of active primary and replica shards.
	ActiveShards int `json:"active_shards"`
	// ActiveShardsPercent The ratio of active shards in the cluster expressed as a string formatted
	// percentage.
	ActiveShardsPercent *string `json:"active_shards_percent,omitempty"`
	// ActiveShardsPercentAsNumber The ratio of active shards in the cluster expressed as a percentage.
	ActiveShardsPercentAsNumber Float64 `json:"active_shards_percent_as_number"`
	// ClusterName The name of the cluster.
	ClusterName string `json:"cluster_name"`
	// DelayedUnassignedShards The number of shards whose allocation has been delayed by the timeout
	// settings.
	DelayedUnassignedShards int                         `json:"delayed_unassigned_shards"`
	Indices                 map[string]IndexHealthStats `json:"indices,omitempty"`
	// InitializingShards The number of shards that are under initialization.
	InitializingShards int `json:"initializing_shards"`
	// NumberOfDataNodes The number of nodes that are dedicated data nodes.
	NumberOfDataNodes int `json:"number_of_data_nodes"`
	// NumberOfInFlightFetch The number of unfinished fetches.
	NumberOfInFlightFetch int `json:"number_of_in_flight_fetch"`
	// NumberOfNodes The number of nodes within the cluster.
	NumberOfNodes int `json:"number_of_nodes"`
	// NumberOfPendingTasks The number of cluster-level changes that have not yet been executed.
	NumberOfPendingTasks int `json:"number_of_pending_tasks"`
	// RelocatingShards The number of shards that are under relocation.
	RelocatingShards int                       `json:"relocating_shards"`
	Status           healthstatus.HealthStatus `json:"status"`
	// TaskMaxWaitingInQueue The time since the earliest initiated task is waiting for being performed.
	TaskMaxWaitingInQueue Duration `json:"task_max_waiting_in_queue,omitempty"`
	// TaskMaxWaitingInQueueMillis The time expressed in milliseconds since the earliest initiated task is
	// waiting for being performed.
	TaskMaxWaitingInQueueMillis int64 `json:"task_max_waiting_in_queue_millis"`
	// TimedOut If false the response returned within the period of time that is specified by
	// the timeout parameter (30s by default)
	TimedOut bool `json:"timed_out"`
	// UnassignedPrimaryShards The number of primary shards that are not allocated.
	UnassignedPrimaryShards int `json:"unassigned_primary_shards"`
	// UnassignedShards The number of shards that are not allocated.
	UnassignedShards int `json:"unassigned_shards"`
}

HealthResponseBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/health/ClusterHealthResponse.ts#L39-L76

func NewHealthResponseBody added in v8.7.1 

func NewHealthResponseBody() *HealthResponseBody

NewHealthResponseBody returns a HealthResponseBody.

func (*HealthResponseBody) UnmarshalJSON added in v8.7.1 

func (s *HealthResponseBody) UnmarshalJSON(data []byte) error

type HealthStatistics added in v8.7.0 

type HealthStatistics struct {
	Available   bool        `json:"available"`
	Enabled     bool        `json:"enabled"`
	Invocations Invocations `json:"invocations"`
}

HealthStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L150-L152

func NewHealthStatistics added in v8.7.0 

func NewHealthStatistics() *HealthStatistics

NewHealthStatistics returns a HealthStatistics.

func (*HealthStatistics) UnmarshalJSON added in v8.7.1 

func (s *HealthStatistics) UnmarshalJSON(data []byte) error

type Highlight 

type Highlight struct {
	// BoundaryChars A string that contains each boundary character.
	BoundaryChars *string `json:"boundary_chars,omitempty"`
	// BoundaryMaxScan How far to scan for boundary characters.
	BoundaryMaxScan *int `json:"boundary_max_scan,omitempty"`
	// BoundaryScanner Specifies how to break the highlighted fragments: chars, sentence, or word.
	// Only valid for the unified and fvh highlighters.
	// Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for
	// the `fvh` highlighter.
	BoundaryScanner *boundaryscanner.BoundaryScanner `json:"boundary_scanner,omitempty"`
	// BoundaryScannerLocale Controls which locale is used to search for sentence and word boundaries.
	// This parameter takes a form of a language tag, for example: `"en-US"`,
	// `"fr-FR"`, `"ja-JP"`.
	BoundaryScannerLocale *string                                `json:"boundary_scanner_locale,omitempty"`
	Encoder               *highlighterencoder.HighlighterEncoder `json:"encoder,omitempty"`
	Fields                map[string]HighlightField              `json:"fields"`
	ForceSource           *bool                                  `json:"force_source,omitempty"`
	// FragmentSize The size of the highlighted fragment in characters.
	FragmentSize *int `json:"fragment_size,omitempty"`
	// Fragmenter Specifies how text should be broken up in highlight snippets: `simple` or
	// `span`.
	// Only valid for the `plain` highlighter.
	Fragmenter      *highlighterfragmenter.HighlighterFragmenter `json:"fragmenter,omitempty"`
	HighlightFilter *bool                                        `json:"highlight_filter,omitempty"`
	// HighlightQuery Highlight matches for a query other than the search query.
	// This is especially useful if you use a rescore query because those are not
	// taken into account by highlighting by default.
	HighlightQuery *Query `json:"highlight_query,omitempty"`
	// MaxAnalyzedOffset If set to a non-negative value, highlighting stops at this defined maximum
	// limit.
	// The rest of the text is not processed, thus not highlighted and no error is
	// returned
	// The `max_analyzed_offset` query setting does not override the
	// `index.highlight.max_analyzed_offset` setting, which prevails when it’s set
	// to lower value than the query setting.
	MaxAnalyzedOffset *int `json:"max_analyzed_offset,omitempty"`
	MaxFragmentLength *int `json:"max_fragment_length,omitempty"`
	// NoMatchSize The amount of text you want to return from the beginning of the field if
	// there are no matching fragments to highlight.
	NoMatchSize *int `json:"no_match_size,omitempty"`
	// NumberOfFragments The maximum number of fragments to return.
	// If the number of fragments is set to `0`, no fragments are returned.
	// Instead, the entire field contents are highlighted and returned.
	// This can be handy when you need to highlight short texts such as a title or
	// address, but fragmentation is not required.
	// If `number_of_fragments` is `0`, `fragment_size` is ignored.
	NumberOfFragments *int                       `json:"number_of_fragments,omitempty"`
	Options           map[string]json.RawMessage `json:"options,omitempty"`
	// Order Sorts highlighted fragments by score when set to `score`.
	// By default, fragments will be output in the order they appear in the field
	// (order: `none`).
	// Setting this option to `score` will output the most relevant fragments first.
	// Each highlighter applies its own logic to compute relevancy scores.
	Order *highlighterorder.HighlighterOrder `json:"order,omitempty"`
	// PhraseLimit Controls the number of matching phrases in a document that are considered.
	// Prevents the `fvh` highlighter from analyzing too many phrases and consuming
	// too much memory.
	// When using `matched_fields`, `phrase_limit` phrases per matched field are
	// considered. Raising the limit increases query time and consumes more memory.
	// Only supported by the `fvh` highlighter.
	PhraseLimit *int `json:"phrase_limit,omitempty"`
	// PostTags Use in conjunction with `pre_tags` to define the HTML tags to use for the
	// highlighted text.
	// By default, highlighted text is wrapped in `<em>` and `</em>` tags.
	PostTags []string `json:"post_tags,omitempty"`
	// PreTags Use in conjunction with `post_tags` to define the HTML tags to use for the
	// highlighted text.
	// By default, highlighted text is wrapped in `<em>` and `</em>` tags.
	PreTags []string `json:"pre_tags,omitempty"`
	// RequireFieldMatch By default, only fields that contains a query match are highlighted.
	// Set to `false` to highlight all fields.
	RequireFieldMatch *bool `json:"require_field_match,omitempty"`
	// TagsSchema Set to `styled` to use the built-in tag schema.
	TagsSchema *highlightertagsschema.HighlighterTagsSchema `json:"tags_schema,omitempty"`
	Type       *highlightertype.HighlighterType             `json:"type,omitempty"`
}

Highlight type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/highlighting.ts#L152-L155

func NewHighlight added in v8.5.0 

func NewHighlight() *Highlight

NewHighlight returns a Highlight.

func (*Highlight) UnmarshalJSON added in v8.7.1 

func (s *Highlight) UnmarshalJSON(data []byte) error

type HighlightField 

type HighlightField struct {
	// BoundaryChars A string that contains each boundary character.
	BoundaryChars *string `json:"boundary_chars,omitempty"`
	// BoundaryMaxScan How far to scan for boundary characters.
	BoundaryMaxScan *int `json:"boundary_max_scan,omitempty"`
	// BoundaryScanner Specifies how to break the highlighted fragments: chars, sentence, or word.
	// Only valid for the unified and fvh highlighters.
	// Defaults to `sentence` for the `unified` highlighter. Defaults to `chars` for
	// the `fvh` highlighter.
	BoundaryScanner *boundaryscanner.BoundaryScanner `json:"boundary_scanner,omitempty"`
	// BoundaryScannerLocale Controls which locale is used to search for sentence and word boundaries.
	// This parameter takes a form of a language tag, for example: `"en-US"`,
	// `"fr-FR"`, `"ja-JP"`.
	BoundaryScannerLocale *string `json:"boundary_scanner_locale,omitempty"`
	ForceSource           *bool   `json:"force_source,omitempty"`
	FragmentOffset        *int    `json:"fragment_offset,omitempty"`
	// FragmentSize The size of the highlighted fragment in characters.
	FragmentSize *int `json:"fragment_size,omitempty"`
	// Fragmenter Specifies how text should be broken up in highlight snippets: `simple` or
	// `span`.
	// Only valid for the `plain` highlighter.
	Fragmenter      *highlighterfragmenter.HighlighterFragmenter `json:"fragmenter,omitempty"`
	HighlightFilter *bool                                        `json:"highlight_filter,omitempty"`
	// HighlightQuery Highlight matches for a query other than the search query.
	// This is especially useful if you use a rescore query because those are not
	// taken into account by highlighting by default.
	HighlightQuery *Query   `json:"highlight_query,omitempty"`
	MatchedFields  []string `json:"matched_fields,omitempty"`
	// MaxAnalyzedOffset If set to a non-negative value, highlighting stops at this defined maximum
	// limit.
	// The rest of the text is not processed, thus not highlighted and no error is
	// returned
	// The `max_analyzed_offset` query setting does not override the
	// `index.highlight.max_analyzed_offset` setting, which prevails when it’s set
	// to lower value than the query setting.
	MaxAnalyzedOffset *int `json:"max_analyzed_offset,omitempty"`
	MaxFragmentLength *int `json:"max_fragment_length,omitempty"`
	// NoMatchSize The amount of text you want to return from the beginning of the field if
	// there are no matching fragments to highlight.
	NoMatchSize *int `json:"no_match_size,omitempty"`
	// NumberOfFragments The maximum number of fragments to return.
	// If the number of fragments is set to `0`, no fragments are returned.
	// Instead, the entire field contents are highlighted and returned.
	// This can be handy when you need to highlight short texts such as a title or
	// address, but fragmentation is not required.
	// If `number_of_fragments` is `0`, `fragment_size` is ignored.
	NumberOfFragments *int                       `json:"number_of_fragments,omitempty"`
	Options           map[string]json.RawMessage `json:"options,omitempty"`
	// Order Sorts highlighted fragments by score when set to `score`.
	// By default, fragments will be output in the order they appear in the field
	// (order: `none`).
	// Setting this option to `score` will output the most relevant fragments first.
	// Each highlighter applies its own logic to compute relevancy scores.
	Order *highlighterorder.HighlighterOrder `json:"order,omitempty"`
	// PhraseLimit Controls the number of matching phrases in a document that are considered.
	// Prevents the `fvh` highlighter from analyzing too many phrases and consuming
	// too much memory.
	// When using `matched_fields`, `phrase_limit` phrases per matched field are
	// considered. Raising the limit increases query time and consumes more memory.
	// Only supported by the `fvh` highlighter.
	PhraseLimit *int `json:"phrase_limit,omitempty"`
	// PostTags Use in conjunction with `pre_tags` to define the HTML tags to use for the
	// highlighted text.
	// By default, highlighted text is wrapped in `<em>` and `</em>` tags.
	PostTags []string `json:"post_tags,omitempty"`
	// PreTags Use in conjunction with `post_tags` to define the HTML tags to use for the
	// highlighted text.
	// By default, highlighted text is wrapped in `<em>` and `</em>` tags.
	PreTags []string `json:"pre_tags,omitempty"`
	// RequireFieldMatch By default, only fields that contains a query match are highlighted.
	// Set to `false` to highlight all fields.
	RequireFieldMatch *bool `json:"require_field_match,omitempty"`
	// TagsSchema Set to `styled` to use the built-in tag schema.
	TagsSchema *highlightertagsschema.HighlighterTagsSchema `json:"tags_schema,omitempty"`
	Type       *highlightertype.HighlighterType             `json:"type,omitempty"`
}

HighlightField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/highlighting.ts#L192-L195

func NewHighlightField added in v8.5.0 

func NewHighlightField() *HighlightField

NewHighlightField returns a HighlightField.

func (*HighlightField) UnmarshalJSON added in v8.7.0 

func (s *HighlightField) UnmarshalJSON(data []byte) error

type HindiAnalyzer added in v8.16.0 

type HindiAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

HindiAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L179-L184

func NewHindiAnalyzer added in v8.16.0 

func NewHindiAnalyzer() *HindiAnalyzer

NewHindiAnalyzer returns a HindiAnalyzer.

func (HindiAnalyzer) MarshalJSON added in v8.16.0 

func (s HindiAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HindiAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *HindiAnalyzer) UnmarshalJSON(data []byte) error

type HindiNormalizationTokenFilter added in v8.18.1 

type HindiNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

HindiNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L493-L495

func NewHindiNormalizationTokenFilter added in v8.18.1 

func NewHindiNormalizationTokenFilter() *HindiNormalizationTokenFilter

NewHindiNormalizationTokenFilter returns a HindiNormalizationTokenFilter.

func (HindiNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s HindiNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HindiNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *HindiNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type Hint 

type Hint struct {
	// Labels A single key-value pair to match against the labels section
	// of a profile. A profile is considered matching if it matches
	// at least one of the strings.
	Labels map[string][]string `json:"labels,omitempty"`
	// Uids A list of profile UIDs to match against.
	Uids []string `json:"uids,omitempty"`
}

Hint type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/suggest_user_profiles/types.ts#L23-L34

func NewHint added in v8.5.0 

func NewHint() *Hint

NewHint returns a Hint.

type HistogramAggregate 

type HistogramAggregate struct {
	Buckets BucketsHistogramBucket `json:"buckets"`
	Meta    Metadata               `json:"meta,omitempty"`
}

HistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L372-L376

func NewHistogramAggregate added in v8.5.0 

func NewHistogramAggregate() *HistogramAggregate

NewHistogramAggregate returns a HistogramAggregate.

func (*HistogramAggregate) UnmarshalJSON added in v8.7.0 

func (s *HistogramAggregate) UnmarshalJSON(data []byte) error

type HistogramAggregation 

type HistogramAggregation struct {
	// ExtendedBounds Enables extending the bounds of the histogram beyond the data itself.
	ExtendedBounds *ExtendedBoundsdouble `json:"extended_bounds,omitempty"`
	// Field The name of the field to aggregate on.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// HardBounds Limits the range of buckets in the histogram.
	// It is particularly useful in the case of open data ranges that can result in
	// a very large number of buckets.
	HardBounds *ExtendedBoundsdouble `json:"hard_bounds,omitempty"`
	// Interval The interval for the buckets.
	// Must be a positive decimal.
	Interval *Float64 `json:"interval,omitempty"`
	// Keyed If `true`, returns buckets as a hash instead of an array, keyed by the bucket
	// keys.
	Keyed *bool `json:"keyed,omitempty"`
	// MinDocCount Only returns buckets that have `min_doc_count` number of documents.
	// By default, the response will fill gaps in the histogram with empty buckets.
	MinDocCount *int `json:"min_doc_count,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing *Float64 `json:"missing,omitempty"`
	// Offset By default, the bucket keys start with 0 and then continue in even spaced
	// steps of `interval`.
	// The bucket boundaries can be shifted by using the `offset` option.
	Offset *Float64 `json:"offset,omitempty"`
	// Order The sort order of the returned buckets.
	// By default, the returned buckets are sorted by their key ascending.
	Order  AggregateOrder `json:"order,omitempty"`
	Script *Script        `json:"script,omitempty"`
}

HistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L519-L565

func NewHistogramAggregation added in v8.5.0 

func NewHistogramAggregation() *HistogramAggregation

NewHistogramAggregation returns a HistogramAggregation.

func (*HistogramAggregation) UnmarshalJSON added in v8.7.0 

func (s *HistogramAggregation) UnmarshalJSON(data []byte) error

type HistogramBucket 

type HistogramBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          Float64              `json:"key"`
	KeyAsString  *string              `json:"key_as_string,omitempty"`
}

HistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L378-L381

func NewHistogramBucket added in v8.5.0 

func NewHistogramBucket() *HistogramBucket

NewHistogramBucket returns a HistogramBucket.

func (HistogramBucket) MarshalJSON 

func (s HistogramBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*HistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *HistogramBucket) UnmarshalJSON(data []byte) error

type HistogramGrouping 

type HistogramGrouping struct {
	// Fields The set of fields that you wish to build histograms for.
	// All fields specified must be some kind of numeric.
	// Order does not matter.
	Fields []string `json:"fields"`
	// Interval The interval of histogram buckets to be generated when rolling up.
	// For example, a value of `5` creates buckets that are five units wide (`0-5`,
	// `5-10`, etc).
	// Note that only one interval can be specified in the histogram group, meaning
	// that all fields being grouped via the histogram must share the same interval.
	Interval int64 `json:"interval"`
}

HistogramGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/_types/Groupings.ts#L84-L97

func NewHistogramGrouping added in v8.5.0 

func NewHistogramGrouping() *HistogramGrouping

NewHistogramGrouping returns a HistogramGrouping.

func (*HistogramGrouping) UnmarshalJSON added in v8.7.1 

func (s *HistogramGrouping) UnmarshalJSON(data []byte) error

type HistogramProperty 

type HistogramProperty struct {
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

HistogramProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L69-L72

func NewHistogramProperty added in v8.5.0 

func NewHistogramProperty() *HistogramProperty

NewHistogramProperty returns a HistogramProperty.

func (HistogramProperty) MarshalJSON added in v8.9.0 

func (s HistogramProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HistogramProperty) UnmarshalJSON added in v8.7.0 

func (s *HistogramProperty) UnmarshalJSON(data []byte) error

type Hit 

type Hit struct {
	Explanation_       *Explanation               `json:"_explanation,omitempty"`
	Fields             map[string]json.RawMessage `json:"fields,omitempty"`
	Highlight          map[string][]string        `json:"highlight,omitempty"`
	Id_                *string                    `json:"_id,omitempty"`
	IgnoredFieldValues map[string][]FieldValue    `json:"ignored_field_values,omitempty"`
	Ignored_           []string                   `json:"_ignored,omitempty"`
	Index_             string                     `json:"_index"`
	InnerHits          map[string]InnerHitsResult `json:"inner_hits,omitempty"`
	MatchedQueries     any                        `json:"matched_queries,omitempty"`
	Nested_            *NestedIdentity            `json:"_nested,omitempty"`
	Node_              *string                    `json:"_node,omitempty"`
	PrimaryTerm_       *int64                     `json:"_primary_term,omitempty"`
	Rank_              *int                       `json:"_rank,omitempty"`
	Routing_           *string                    `json:"_routing,omitempty"`
	Score_             *Float64                   `json:"_score,omitempty"`
	SeqNo_             *int64                     `json:"_seq_no,omitempty"`
	Shard_             *string                    `json:"_shard,omitempty"`
	Sort               []FieldValue               `json:"sort,omitempty"`
	Source_            json.RawMessage            `json:"_source,omitempty"`
	Version_           *int64                     `json:"_version,omitempty"`
}

Hit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L41-L66

func NewHit added in v8.5.0 

func NewHit() *Hit

NewHit returns a Hit.

func (*Hit) UnmarshalJSON added in v8.7.1 

func (s *Hit) UnmarshalJSON(data []byte) error

type HitsEvent 

type HitsEvent struct {
	Fields map[string][]json.RawMessage `json:"fields,omitempty"`
	// Id_ Unique identifier for the event. This ID is only unique within the index.
	Id_ string `json:"_id"`
	// Index_ Name of the index containing the event.
	Index_ string `json:"_index"`
	// Missing Set to `true` for events in a timespan-constrained sequence that do not meet
	// a given condition.
	Missing *bool `json:"missing,omitempty"`
	// Source_ Original JSON body passed for the event at index time.
	Source_ json.RawMessage `json:"_source,omitempty"`
}

HitsEvent type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/eql/_types/EqlHits.ts#L41-L54

func NewHitsEvent added in v8.5.0 

func NewHitsEvent() *HitsEvent

NewHitsEvent returns a HitsEvent.

func (*HitsEvent) UnmarshalJSON added in v8.7.1 

func (s *HitsEvent) UnmarshalJSON(data []byte) error

type HitsMetadata 

type HitsMetadata struct {
	Hits     []Hit    `json:"hits"`
	MaxScore *Float64 `json:"max_score,omitempty"`
	// Total Total hit count information, present only if `track_total_hits` wasn't
	// `false` in the search request.
	Total *TotalHits `json:"total,omitempty"`
}

HitsMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L68-L74

func NewHitsMetadata added in v8.5.0 

func NewHitsMetadata() *HitsMetadata

NewHitsMetadata returns a HitsMetadata.

func (*HitsMetadata) UnmarshalJSON added in v8.7.1 

func (s *HitsMetadata) UnmarshalJSON(data []byte) error

type HitsSequence 

type HitsSequence struct {
	// Events Contains events matching the query. Each object represents a matching event.
	Events []HitsEvent `json:"events"`
	// JoinKeys Shared field values used to constrain matches in the sequence. These are
	// defined using the by keyword in the EQL query syntax.
	JoinKeys []json.RawMessage `json:"join_keys,omitempty"`
}

HitsSequence type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/eql/_types/EqlHits.ts#L56-L64

func NewHitsSequence added in v8.5.0 

func NewHitsSequence() *HitsSequence

NewHitsSequence returns a HitsSequence.

type HoltLinearModelSettings 

type HoltLinearModelSettings struct {
	Alpha *float32 `json:"alpha,omitempty"`
	Beta  *float32 `json:"beta,omitempty"`
}

HoltLinearModelSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L297-L300

func NewHoltLinearModelSettings added in v8.5.0 

func NewHoltLinearModelSettings() *HoltLinearModelSettings

NewHoltLinearModelSettings returns a HoltLinearModelSettings.

func (*HoltLinearModelSettings) UnmarshalJSON added in v8.7.1 

func (s *HoltLinearModelSettings) UnmarshalJSON(data []byte) error

type HoltMovingAverageAggregation 

type HoltMovingAverageAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy    `json:"gap_policy,omitempty"`
	Minimize  *bool                   `json:"minimize,omitempty"`
	Model     string                  `json:"model,omitempty"`
	Predict   *int                    `json:"predict,omitempty"`
	Settings  HoltLinearModelSettings `json:"settings"`
	Window    *int                    `json:"window,omitempty"`
}

HoltMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L283-L286

func NewHoltMovingAverageAggregation added in v8.5.0 

func NewHoltMovingAverageAggregation() *HoltMovingAverageAggregation

NewHoltMovingAverageAggregation returns a HoltMovingAverageAggregation.

func (HoltMovingAverageAggregation) MarshalJSON added in v8.9.0 

func (s HoltMovingAverageAggregation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HoltMovingAverageAggregation) UnmarshalJSON added in v8.7.0 

func (s *HoltMovingAverageAggregation) UnmarshalJSON(data []byte) error

type HoltWintersModelSettings 

type HoltWintersModelSettings struct {
	Alpha  *float32                         `json:"alpha,omitempty"`
	Beta   *float32                         `json:"beta,omitempty"`
	Gamma  *float32                         `json:"gamma,omitempty"`
	Pad    *bool                            `json:"pad,omitempty"`
	Period *int                             `json:"period,omitempty"`
	Type   *holtwinterstype.HoltWintersType `json:"type,omitempty"`
}

HoltWintersModelSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L301-L308

func NewHoltWintersModelSettings added in v8.5.0 

func NewHoltWintersModelSettings() *HoltWintersModelSettings

NewHoltWintersModelSettings returns a HoltWintersModelSettings.

func (*HoltWintersModelSettings) UnmarshalJSON added in v8.7.1 

func (s *HoltWintersModelSettings) UnmarshalJSON(data []byte) error

type HoltWintersMovingAverageAggregation 

type HoltWintersMovingAverageAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy     `json:"gap_policy,omitempty"`
	Minimize  *bool                    `json:"minimize,omitempty"`
	Model     string                   `json:"model,omitempty"`
	Predict   *int                     `json:"predict,omitempty"`
	Settings  HoltWintersModelSettings `json:"settings"`
	Window    *int                     `json:"window,omitempty"`
}

HoltWintersMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L288-L291

func NewHoltWintersMovingAverageAggregation added in v8.5.0 

func NewHoltWintersMovingAverageAggregation() *HoltWintersMovingAverageAggregation

NewHoltWintersMovingAverageAggregation returns a HoltWintersMovingAverageAggregation.

func (HoltWintersMovingAverageAggregation) MarshalJSON added in v8.9.0 

func (s HoltWintersMovingAverageAggregation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HoltWintersMovingAverageAggregation) UnmarshalJSON added in v8.7.0 

func (s *HoltWintersMovingAverageAggregation) UnmarshalJSON(data []byte) error

type Hop 

type Hop struct {
	// Connections Specifies one or more fields from which you want to extract terms that are
	// associated with the specified vertices.
	Connections *Hop `json:"connections,omitempty"`
	// Query An optional guiding query that constrains the Graph API as it explores
	// connected terms.
	Query Query `json:"query"`
	// Vertices Contains the fields you are interested in.
	Vertices []VertexDefinition `json:"vertices"`
}

Hop type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/Hop.ts#L23-L36

func NewHop added in v8.5.0 

func NewHop() *Hop

NewHop returns a Hop.

type HourAndMinute 

type HourAndMinute struct {
	Hour   []int `json:"hour"`
	Minute []int `json:"minute"`
}

HourAndMinute type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L106-L109

func NewHourAndMinute added in v8.5.0 

func NewHourAndMinute() *HourAndMinute

NewHourAndMinute returns a HourAndMinute.

type HourlySchedule 

type HourlySchedule struct {
	Minute []int `json:"minute"`
}

HourlySchedule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L47-L49

func NewHourlySchedule added in v8.5.0 

func NewHourlySchedule() *HourlySchedule

NewHourlySchedule returns a HourlySchedule.

type HtmlStripCharFilter 

type HtmlStripCharFilter struct {
	EscapedTags []string `json:"escaped_tags,omitempty"`
	Type        string   `json:"type,omitempty"`
	Version     *string  `json:"version,omitempty"`
}

HtmlStripCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/char_filters.ts#L46-L49

func NewHtmlStripCharFilter added in v8.5.0 

func NewHtmlStripCharFilter() *HtmlStripCharFilter

NewHtmlStripCharFilter returns a HtmlStripCharFilter.

func (HtmlStripCharFilter) MarshalJSON added in v8.9.0 

func (s HtmlStripCharFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HtmlStripCharFilter) UnmarshalJSON added in v8.7.1 

func (s *HtmlStripCharFilter) UnmarshalJSON(data []byte) error

type HtmlStripProcessor added in v8.16.0 

type HtmlStripProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The string-valued field to remove HTML tags from.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document,
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to
	// By default, the `field` is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

HtmlStripProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1009-L1025

func NewHtmlStripProcessor added in v8.16.0 

func NewHtmlStripProcessor() *HtmlStripProcessor

NewHtmlStripProcessor returns a HtmlStripProcessor.

func (*HtmlStripProcessor) UnmarshalJSON added in v8.16.0 

func (s *HtmlStripProcessor) UnmarshalJSON(data []byte) error

type Http 

type Http struct {
	// Clients Information on current and recently-closed HTTP client connections.
	// Clients that have been closed longer than the
	// `http.client_stats.closed_channels.max_age` setting will not be represented
	// here.
	Clients []Client `json:"clients,omitempty"`
	// CurrentOpen Current number of open HTTP connections for the node.
	CurrentOpen *int `json:"current_open,omitempty"`
	// Routes Detailed HTTP stats broken down by route
	Routes map[string]HttpRoute `json:"routes"`
	// TotalOpened Total number of HTTP connections opened for the node.
	TotalOpened *int64 `json:"total_opened,omitempty"`
}

Http type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L669-L688

func NewHttp added in v8.5.0 

func NewHttp() *Http

NewHttp returns a Http.

func (*Http) UnmarshalJSON added in v8.7.1 

func (s *Http) UnmarshalJSON(data []byte) error

type HttpEmailAttachment 

type HttpEmailAttachment struct {
	ContentType *string                     `json:"content_type,omitempty"`
	Inline      *bool                       `json:"inline,omitempty"`
	Request     *HttpInputRequestDefinition `json:"request,omitempty"`
}

HttpEmailAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L218-L222

func NewHttpEmailAttachment added in v8.5.0 

func NewHttpEmailAttachment() *HttpEmailAttachment

NewHttpEmailAttachment returns a HttpEmailAttachment.

func (*HttpEmailAttachment) UnmarshalJSON added in v8.7.1 

func (s *HttpEmailAttachment) UnmarshalJSON(data []byte) error

type HttpHeaders 

type HttpHeaders map[string][]string

HttpHeaders type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L162-L162

type HttpInput 

type HttpInput struct {
	Extract             []string                                 `json:"extract,omitempty"`
	Request             *HttpInputRequestDefinition              `json:"request,omitempty"`
	ResponseContentType *responsecontenttype.ResponseContentType `json:"response_content_type,omitempty"`
}

HttpInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L44-L48

func NewHttpInput added in v8.5.0 

func NewHttpInput() *HttpInput

NewHttpInput returns a HttpInput.

type HttpInputAuthentication 

type HttpInputAuthentication struct {
	Basic HttpInputBasicAuthentication `json:"basic"`
}

HttpInputAuthentication type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L50-L52

func NewHttpInputAuthentication added in v8.5.0 

func NewHttpInputAuthentication() *HttpInputAuthentication

NewHttpInputAuthentication returns a HttpInputAuthentication.

type HttpInputBasicAuthentication 

type HttpInputBasicAuthentication struct {
	Password string `json:"password"`
	Username string `json:"username"`
}

HttpInputBasicAuthentication type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L54-L57

func NewHttpInputBasicAuthentication added in v8.5.0 

func NewHttpInputBasicAuthentication() *HttpInputBasicAuthentication

NewHttpInputBasicAuthentication returns a HttpInputBasicAuthentication.

func (*HttpInputBasicAuthentication) UnmarshalJSON added in v8.7.1 

func (s *HttpInputBasicAuthentication) UnmarshalJSON(data []byte) error

type HttpInputProxy 

type HttpInputProxy struct {
	Host string `json:"host"`
	Port uint   `json:"port"`
}

HttpInputProxy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L67-L70

func NewHttpInputProxy added in v8.5.0 

func NewHttpInputProxy() *HttpInputProxy

NewHttpInputProxy returns a HttpInputProxy.

func (*HttpInputProxy) UnmarshalJSON added in v8.7.1 

func (s *HttpInputProxy) UnmarshalJSON(data []byte) error

type HttpInputRequestDefinition 

type HttpInputRequestDefinition struct {
	Auth              *HttpInputAuthentication           `json:"auth,omitempty"`
	Body              *string                            `json:"body,omitempty"`
	ConnectionTimeout Duration                           `json:"connection_timeout,omitempty"`
	Headers           map[string]string                  `json:"headers,omitempty"`
	Host              *string                            `json:"host,omitempty"`
	Method            *httpinputmethod.HttpInputMethod   `json:"method,omitempty"`
	Params            map[string]string                  `json:"params,omitempty"`
	Path              *string                            `json:"path,omitempty"`
	Port              *uint                              `json:"port,omitempty"`
	Proxy             *HttpInputProxy                    `json:"proxy,omitempty"`
	ReadTimeout       Duration                           `json:"read_timeout,omitempty"`
	Scheme            *connectionscheme.ConnectionScheme `json:"scheme,omitempty"`
	Url               *string                            `json:"url,omitempty"`
}

HttpInputRequestDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L72-L86

func NewHttpInputRequestDefinition added in v8.5.0 

func NewHttpInputRequestDefinition() *HttpInputRequestDefinition

NewHttpInputRequestDefinition returns a HttpInputRequestDefinition.

func (*HttpInputRequestDefinition) UnmarshalJSON added in v8.7.1 

func (s *HttpInputRequestDefinition) UnmarshalJSON(data []byte) error

type HttpInputRequestResult 

type HttpInputRequestResult struct {
	Auth              *HttpInputAuthentication           `json:"auth,omitempty"`
	Body              *string                            `json:"body,omitempty"`
	ConnectionTimeout Duration                           `json:"connection_timeout,omitempty"`
	Headers           map[string]string                  `json:"headers,omitempty"`
	Host              *string                            `json:"host,omitempty"`
	Method            *httpinputmethod.HttpInputMethod   `json:"method,omitempty"`
	Params            map[string]string                  `json:"params,omitempty"`
	Path              *string                            `json:"path,omitempty"`
	Port              *uint                              `json:"port,omitempty"`
	Proxy             *HttpInputProxy                    `json:"proxy,omitempty"`
	ReadTimeout       Duration                           `json:"read_timeout,omitempty"`
	Scheme            *connectionscheme.ConnectionScheme `json:"scheme,omitempty"`
	Url               *string                            `json:"url,omitempty"`
}

HttpInputRequestResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L300-L300

func NewHttpInputRequestResult added in v8.5.0 

func NewHttpInputRequestResult() *HttpInputRequestResult

NewHttpInputRequestResult returns a HttpInputRequestResult.

func (*HttpInputRequestResult) UnmarshalJSON added in v8.7.1 

func (s *HttpInputRequestResult) UnmarshalJSON(data []byte) error

type HttpInputResponseResult 

type HttpInputResponseResult struct {
	Body    string      `json:"body"`
	Headers HttpHeaders `json:"headers"`
	Status  int         `json:"status"`
}

HttpInputResponseResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L302-L306

func NewHttpInputResponseResult added in v8.5.0 

func NewHttpInputResponseResult() *HttpInputResponseResult

NewHttpInputResponseResult returns a HttpInputResponseResult.

func (*HttpInputResponseResult) UnmarshalJSON added in v8.7.1 

func (s *HttpInputResponseResult) UnmarshalJSON(data []byte) error

type HttpRoute added in v8.16.0 

type HttpRoute struct {
	Requests  HttpRouteRequests  `json:"requests"`
	Responses HttpRouteResponses `json:"responses"`
}

HttpRoute type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L690-L693

func NewHttpRoute added in v8.16.0 

func NewHttpRoute() *HttpRoute

NewHttpRoute returns a HttpRoute.

type HttpRouteRequests added in v8.16.0 

type HttpRouteRequests struct {
	Count            int64               `json:"count"`
	SizeHistogram    []SizeHttpHistogram `json:"size_histogram"`
	TotalSizeInBytes int64               `json:"total_size_in_bytes"`
}

HttpRouteRequests type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L695-L699

func NewHttpRouteRequests added in v8.16.0 

func NewHttpRouteRequests() *HttpRouteRequests

NewHttpRouteRequests returns a HttpRouteRequests.

func (*HttpRouteRequests) UnmarshalJSON added in v8.16.0 

func (s *HttpRouteRequests) UnmarshalJSON(data []byte) error

type HttpRouteResponses added in v8.16.0 

type HttpRouteResponses struct {
	Count                 int64               `json:"count"`
	HandlingTimeHistogram []TimeHttpHistogram `json:"handling_time_histogram"`
	SizeHistogram         []SizeHttpHistogram `json:"size_histogram"`
	TotalSizeInBytes      int64               `json:"total_size_in_bytes"`
}

HttpRouteResponses type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L701-L706

func NewHttpRouteResponses added in v8.16.0 

func NewHttpRouteResponses() *HttpRouteResponses

NewHttpRouteResponses returns a HttpRouteResponses.

func (*HttpRouteResponses) UnmarshalJSON added in v8.16.0 

func (s *HttpRouteResponses) UnmarshalJSON(data []byte) error

type HuggingFaceServiceSettings added in v8.18.0 

type HuggingFaceServiceSettings struct {
	// ApiKey A valid access token for your HuggingFace account.
	// You can create or find your access tokens on the HuggingFace settings page.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Hugging Face.
	// By default, the `hugging_face` service sets the number of requests allowed
	// per minute to 3000.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Url The URL endpoint to use for the requests.
	Url string `json:"url"`
}

HuggingFaceServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L942-L963

func NewHuggingFaceServiceSettings added in v8.18.0 

func NewHuggingFaceServiceSettings() *HuggingFaceServiceSettings

NewHuggingFaceServiceSettings returns a HuggingFaceServiceSettings.

func (*HuggingFaceServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *HuggingFaceServiceSettings) UnmarshalJSON(data []byte) error

type HungarianAnalyzer added in v8.16.0 

type HungarianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

HungarianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L186-L191

func NewHungarianAnalyzer added in v8.16.0 

func NewHungarianAnalyzer() *HungarianAnalyzer

NewHungarianAnalyzer returns a HungarianAnalyzer.

func (HungarianAnalyzer) MarshalJSON added in v8.16.0 

func (s HungarianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HungarianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *HungarianAnalyzer) UnmarshalJSON(data []byte) error

type HunspellTokenFilter 

type HunspellTokenFilter struct {
	// Dedup If `true`, duplicate tokens are removed from the filter’s output. Defaults to
	// `true`.
	Dedup *bool `json:"dedup,omitempty"`
	// Dictionary One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the
	// Hunspell dictionary.
	// By default, the `hunspell` filter uses all `.dic` files in the
	// `<$ES_PATH_CONF>/hunspell/<locale>` directory specified using the `lang`,
	// `language`, or `locale` parameter.
	Dictionary *string `json:"dictionary,omitempty"`
	// Locale Locale directory used to specify the `.aff` and `.dic` files for a Hunspell
	// dictionary.
	Locale string `json:"locale"`
	// LongestOnly If `true`, only the longest stemmed version of each token is included in the
	// output. If `false`, all stemmed versions of the token are included. Defaults
	// to `false`.
	LongestOnly *bool   `json:"longest_only,omitempty"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
}

HunspellTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L268-L280

func NewHunspellTokenFilter added in v8.5.0 

func NewHunspellTokenFilter() *HunspellTokenFilter

NewHunspellTokenFilter returns a HunspellTokenFilter.

func (HunspellTokenFilter) MarshalJSON added in v8.9.0 

func (s HunspellTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HunspellTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *HunspellTokenFilter) UnmarshalJSON(data []byte) error

type Hyperparameter 

type Hyperparameter struct {
	// AbsoluteImportance A positive number showing how much the parameter influences the variation of
	// the loss function. For hyperparameters with values that are not specified by
	// the user but tuned during hyperparameter optimization.
	AbsoluteImportance *Float64 `json:"absolute_importance,omitempty"`
	// Name Name of the hyperparameter.
	Name string `json:"name"`
	// RelativeImportance A number between 0 and 1 showing the proportion of influence on the variation
	// of the loss function among all tuned hyperparameters. For hyperparameters
	// with values that are not specified by the user but tuned during
	// hyperparameter optimization.
	RelativeImportance *Float64 `json:"relative_importance,omitempty"`
	// Supplied Indicates if the hyperparameter is specified by the user (true) or optimized
	// (false).
	Supplied bool `json:"supplied"`
	// Value The value of the hyperparameter, either optimized or specified by the user.
	Value Float64 `json:"value"`
}

Hyperparameter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L274-L288

func NewHyperparameter added in v8.5.0 

func NewHyperparameter() *Hyperparameter

NewHyperparameter returns a Hyperparameter.

func (*Hyperparameter) UnmarshalJSON added in v8.7.1 

func (s *Hyperparameter) UnmarshalJSON(data []byte) error

type Hyperparameters 

type Hyperparameters struct {
	// Alpha Advanced configuration option.
	// Machine learning uses loss guided tree growing, which means that the decision
	// trees grow where the regularized loss decreases most quickly.
	// This parameter affects loss calculations by acting as a multiplier of the
	// tree depth.
	// Higher alpha values result in shallower trees and faster training times.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be greater than or equal to zero.
	Alpha *Float64 `json:"alpha,omitempty"`
	// DownsampleFactor Advanced configuration option.
	// Controls the fraction of data that is used to compute the derivatives of the
	// loss function for tree training.
	// A small value results in the use of a small fraction of the data.
	// If this value is set to be less than 1, accuracy typically improves.
	// However, too small a value may result in poor convergence for the ensemble
	// and so require more trees.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be greater than zero and less than or equal to 1.
	DownsampleFactor *Float64 `json:"downsample_factor,omitempty"`
	// Eta Advanced configuration option.
	// The shrinkage applied to the weights.
	// Smaller values result in larger forests which have a better generalization
	// error.
	// However, larger forests cause slower training.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be a value between `0.001` and `1`.
	Eta *Float64 `json:"eta,omitempty"`
	// EtaGrowthRatePerTree Advanced configuration option.
	// Specifies the rate at which `eta` increases for each new tree that is added
	// to the forest.
	// For example, a rate of 1.05 increases `eta` by 5% for each extra tree.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be between `0.5` and `2`.
	EtaGrowthRatePerTree *Float64 `json:"eta_growth_rate_per_tree,omitempty"`
	// FeatureBagFraction Advanced configuration option.
	// Defines the fraction of features that will be used when selecting a random
	// bag for each candidate split.
	// By default, this value is calculated during hyperparameter optimization.
	FeatureBagFraction *Float64 `json:"feature_bag_fraction,omitempty"`
	// Gamma Advanced configuration option.
	// Regularization parameter to prevent overfitting on the training data set.
	// Multiplies a linear penalty associated with the size of individual trees in
	// the forest.
	// A high gamma value causes training to prefer small trees.
	// A small gamma value results in larger individual trees and slower training.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be a nonnegative value.
	Gamma *Float64 `json:"gamma,omitempty"`
	// Lambda Advanced configuration option.
	// Regularization parameter to prevent overfitting on the training data set.
	// Multiplies an L2 regularization term which applies to leaf weights of the
	// individual trees in the forest.
	// A high lambda value causes training to favor small leaf weights.
	// This behavior makes the prediction function smoother at the expense of
	// potentially not being able to capture relevant relationships between the
	// features and the dependent variable.
	// A small lambda value results in large individual trees and slower training.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be a nonnegative value.
	Lambda *Float64 `json:"lambda,omitempty"`
	// MaxAttemptsToAddTree If the algorithm fails to determine a non-trivial tree (more than a single
	// leaf), this parameter determines how many of such consecutive failures are
	// tolerated.
	// Once the number of attempts exceeds the threshold, the forest training stops.
	MaxAttemptsToAddTree *int `json:"max_attempts_to_add_tree,omitempty"`
	// MaxOptimizationRoundsPerHyperparameter Advanced configuration option.
	// A multiplier responsible for determining the maximum number of hyperparameter
	// optimization steps in the Bayesian optimization procedure.
	// The maximum number of steps is determined based on the number of undefined
	// hyperparameters times the maximum optimization rounds per hyperparameter.
	// By default, this value is calculated during hyperparameter optimization.
	MaxOptimizationRoundsPerHyperparameter *int `json:"max_optimization_rounds_per_hyperparameter,omitempty"`
	// MaxTrees Advanced configuration option.
	// Defines the maximum number of decision trees in the forest.
	// The maximum value is 2000.
	// By default, this value is calculated during hyperparameter optimization.
	MaxTrees *int `json:"max_trees,omitempty"`
	// NumFolds The maximum number of folds for the cross-validation procedure.
	NumFolds *int `json:"num_folds,omitempty"`
	// NumSplitsPerFeature Determines the maximum number of splits for every feature that can occur in a
	// decision tree when the tree is trained.
	NumSplitsPerFeature *int `json:"num_splits_per_feature,omitempty"`
	// SoftTreeDepthLimit Advanced configuration option.
	// Machine learning uses loss guided tree growing, which means that the decision
	// trees grow where the regularized loss decreases most quickly.
	// This soft limit combines with the `soft_tree_depth_tolerance` to penalize
	// trees that exceed the specified depth; the regularized loss increases quickly
	// beyond this depth.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be greater than or equal to 0.
	SoftTreeDepthLimit *int `json:"soft_tree_depth_limit,omitempty"`
	// SoftTreeDepthTolerance Advanced configuration option.
	// This option controls how quickly the regularized loss increases when the tree
	// depth exceeds `soft_tree_depth_limit`.
	// By default, this value is calculated during hyperparameter optimization.
	// It must be greater than or equal to 0.01.
	SoftTreeDepthTolerance *Float64 `json:"soft_tree_depth_tolerance,omitempty"`
}

Hyperparameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L420-L526

func NewHyperparameters added in v8.5.0 

func NewHyperparameters() *Hyperparameters

NewHyperparameters returns a Hyperparameters.

func (*Hyperparameters) UnmarshalJSON added in v8.7.1 

func (s *Hyperparameters) UnmarshalJSON(data []byte) error

type HyphenationDecompounderTokenFilter 

type HyphenationDecompounderTokenFilter struct {
	// HyphenationPatternsPath Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern
	// file.
	// This path must be absolute or relative to the `config` location. Only FOP
	// v1.2 compatible files are supported.
	HyphenationPatternsPath string `json:"hyphenation_patterns_path"`
	// MaxSubwordSize Maximum subword character length. Longer subword tokens are excluded from the
	// output. Defaults to `15`.
	MaxSubwordSize *int `json:"max_subword_size,omitempty"`
	// MinSubwordSize Minimum subword character length. Shorter subword tokens are excluded from
	// the output. Defaults to `2`.
	MinSubwordSize *int `json:"min_subword_size,omitempty"`
	// MinWordSize Minimum word character length. Shorter word tokens are excluded from the
	// output. Defaults to `5`.
	MinWordSize *int `json:"min_word_size,omitempty"`
	// NoOverlappingMatches If `true`, do not allow overlapping tokens. Defaults to `false`.
	NoOverlappingMatches *bool `json:"no_overlapping_matches,omitempty"`
	// NoSubMatches If `true`, do not match sub tokens in tokens that are in the word list.
	// Defaults to `false`.
	NoSubMatches *bool `json:"no_sub_matches,omitempty"`
	// OnlyLongestMatch If `true`, only include the longest matching subword. Defaults to `false`.
	OnlyLongestMatch *bool   `json:"only_longest_match,omitempty"`
	Type             string  `json:"type,omitempty"`
	Version          *string `json:"version,omitempty"`
	// WordList A list of subwords to look for in the token stream. If found, the subword is
	// included in the token output.
	// Either this parameter or `word_list_path` must be specified.
	WordList []string `json:"word_list,omitempty"`
	// WordListPath Path to a file that contains a list of subwords to find in the token stream.
	// If found, the subword is included in the token output.
	// This path must be absolute or relative to the config location, and the file
	// must be UTF-8 encoded. Each token in the file must be separated by a line
	// break.
	// Either this parameter or `word_list` must be specified.
	WordListPath *string `json:"word_list_path,omitempty"`
}

HyphenationDecompounderTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L67-L76

func NewHyphenationDecompounderTokenFilter added in v8.5.0 

func NewHyphenationDecompounderTokenFilter() *HyphenationDecompounderTokenFilter

NewHyphenationDecompounderTokenFilter returns a HyphenationDecompounderTokenFilter.

func (HyphenationDecompounderTokenFilter) MarshalJSON added in v8.9.0 

func (s HyphenationDecompounderTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*HyphenationDecompounderTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *HyphenationDecompounderTokenFilter) UnmarshalJSON(data []byte) error

type IcuAnalyzer 

type IcuAnalyzer struct {
	Method icunormalizationtype.IcuNormalizationType `json:"method"`
	Mode   icunormalizationmode.IcuNormalizationMode `json:"mode"`
	Type   string                                    `json:"type,omitempty"`
}

IcuAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L68-L72

func NewIcuAnalyzer added in v8.5.0 

func NewIcuAnalyzer() *IcuAnalyzer

NewIcuAnalyzer returns a IcuAnalyzer.

func (IcuAnalyzer) MarshalJSON added in v8.9.0 

func (s IcuAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type IcuCollationProperty added in v8.14.0 

type IcuCollationProperty struct {
	Alternate              *icucollationalternate.IcuCollationAlternate         `json:"alternate,omitempty"`
	CaseFirst              *icucollationcasefirst.IcuCollationCaseFirst         `json:"case_first,omitempty"`
	CaseLevel              *bool                                                `json:"case_level,omitempty"`
	CopyTo                 []string                                             `json:"copy_to,omitempty"`
	Country                *string                                              `json:"country,omitempty"`
	Decomposition          *icucollationdecomposition.IcuCollationDecomposition `json:"decomposition,omitempty"`
	DocValues              *bool                                                `json:"doc_values,omitempty"`
	Dynamic                *dynamicmapping.DynamicMapping                       `json:"dynamic,omitempty"`
	Fields                 map[string]Property                                  `json:"fields,omitempty"`
	HiraganaQuaternaryMode *bool                                                `json:"hiragana_quaternary_mode,omitempty"`
	IgnoreAbove            *int                                                 `json:"ignore_above,omitempty"`
	// Index Should the field be searchable?
	Index        *bool                      `json:"index,omitempty"`
	IndexOptions *indexoptions.IndexOptions `json:"index_options,omitempty"`
	Language     *string                    `json:"language,omitempty"`
	// Meta Metadata about the field.
	Meta  map[string]string `json:"meta,omitempty"`
	Norms *bool             `json:"norms,omitempty"`
	// NullValue Accepts a string value which is substituted for any explicit null values.
	// Defaults to null, which means the field is treated as missing.
	NullValue           *string                                          `json:"null_value,omitempty"`
	Numeric             *bool                                            `json:"numeric,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Rules               *string                                          `json:"rules,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	Strength            *icucollationstrength.IcuCollationStrength       `json:"strength,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
	VariableTop         *string                                          `json:"variable_top,omitempty"`
	Variant             *string                                          `json:"variant,omitempty"`
}

IcuCollationProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L103-L127

func NewIcuCollationProperty added in v8.14.0 

func NewIcuCollationProperty() *IcuCollationProperty

NewIcuCollationProperty returns a IcuCollationProperty.

func (IcuCollationProperty) MarshalJSON added in v8.14.0 

func (s IcuCollationProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuCollationProperty) UnmarshalJSON added in v8.14.0 

func (s *IcuCollationProperty) UnmarshalJSON(data []byte) error

type IcuCollationTokenFilter 

type IcuCollationTokenFilter struct {
	Alternate              *icucollationalternate.IcuCollationAlternate         `json:"alternate,omitempty"`
	CaseFirst              *icucollationcasefirst.IcuCollationCaseFirst         `json:"case_first,omitempty"`
	CaseLevel              *bool                                                `json:"case_level,omitempty"`
	Country                *string                                              `json:"country,omitempty"`
	Decomposition          *icucollationdecomposition.IcuCollationDecomposition `json:"decomposition,omitempty"`
	HiraganaQuaternaryMode *bool                                                `json:"hiragana_quaternary_mode,omitempty"`
	Language               *string                                              `json:"language,omitempty"`
	Numeric                *bool                                                `json:"numeric,omitempty"`
	Rules                  *string                                              `json:"rules,omitempty"`
	Strength               *icucollationstrength.IcuCollationStrength           `json:"strength,omitempty"`
	Type                   string                                               `json:"type,omitempty"`
	VariableTop            *string                                              `json:"variable_top,omitempty"`
	Variant                *string                                              `json:"variant,omitempty"`
	Version                *string                                              `json:"version,omitempty"`
}

IcuCollationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L52-L66

func NewIcuCollationTokenFilter added in v8.5.0 

func NewIcuCollationTokenFilter() *IcuCollationTokenFilter

NewIcuCollationTokenFilter returns a IcuCollationTokenFilter.

func (IcuCollationTokenFilter) MarshalJSON added in v8.9.0 

func (s IcuCollationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuCollationTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *IcuCollationTokenFilter) UnmarshalJSON(data []byte) error

type IcuFoldingTokenFilter 

type IcuFoldingTokenFilter struct {
	Type             string  `json:"type,omitempty"`
	UnicodeSetFilter string  `json:"unicode_set_filter"`
	Version          *string `json:"version,omitempty"`
}

IcuFoldingTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L47-L50

func NewIcuFoldingTokenFilter added in v8.5.0 

func NewIcuFoldingTokenFilter() *IcuFoldingTokenFilter

NewIcuFoldingTokenFilter returns a IcuFoldingTokenFilter.

func (IcuFoldingTokenFilter) MarshalJSON added in v8.9.0 

func (s IcuFoldingTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuFoldingTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *IcuFoldingTokenFilter) UnmarshalJSON(data []byte) error

type IcuNormalizationCharFilter 

type IcuNormalizationCharFilter struct {
	Mode             *icunormalizationmode.IcuNormalizationMode `json:"mode,omitempty"`
	Name             *icunormalizationtype.IcuNormalizationType `json:"name,omitempty"`
	Type             string                                     `json:"type,omitempty"`
	UnicodeSetFilter *string                                    `json:"unicode_set_filter,omitempty"`
	Version          *string                                    `json:"version,omitempty"`
}

IcuNormalizationCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L40-L45

func NewIcuNormalizationCharFilter added in v8.5.0 

func NewIcuNormalizationCharFilter() *IcuNormalizationCharFilter

NewIcuNormalizationCharFilter returns a IcuNormalizationCharFilter.

func (IcuNormalizationCharFilter) MarshalJSON added in v8.9.0 

func (s IcuNormalizationCharFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuNormalizationCharFilter) UnmarshalJSON added in v8.7.1 

func (s *IcuNormalizationCharFilter) UnmarshalJSON(data []byte) error

type IcuNormalizationTokenFilter 

type IcuNormalizationTokenFilter struct {
	Name    icunormalizationtype.IcuNormalizationType `json:"name"`
	Type    string                                    `json:"type,omitempty"`
	Version *string                                   `json:"version,omitempty"`
}

IcuNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L35-L38

func NewIcuNormalizationTokenFilter added in v8.5.0 

func NewIcuNormalizationTokenFilter() *IcuNormalizationTokenFilter

NewIcuNormalizationTokenFilter returns a IcuNormalizationTokenFilter.

func (IcuNormalizationTokenFilter) MarshalJSON added in v8.9.0 

func (s IcuNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuNormalizationTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *IcuNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type IcuTokenizer 

type IcuTokenizer struct {
	RuleFiles string  `json:"rule_files"`
	Type      string  `json:"type,omitempty"`
	Version   *string `json:"version,omitempty"`
}

IcuTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L30-L33

func NewIcuTokenizer added in v8.5.0 

func NewIcuTokenizer() *IcuTokenizer

NewIcuTokenizer returns a IcuTokenizer.

func (IcuTokenizer) MarshalJSON added in v8.9.0 

func (s IcuTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuTokenizer) UnmarshalJSON added in v8.7.1 

func (s *IcuTokenizer) UnmarshalJSON(data []byte) error

type IcuTransformTokenFilter 

type IcuTransformTokenFilter struct {
	Dir     *icutransformdirection.IcuTransformDirection `json:"dir,omitempty"`
	Id      string                                       `json:"id"`
	Type    string                                       `json:"type,omitempty"`
	Version *string                                      `json:"version,omitempty"`
}

IcuTransformTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/icu-plugin.ts#L24-L28

func NewIcuTransformTokenFilter added in v8.5.0 

func NewIcuTransformTokenFilter() *IcuTransformTokenFilter

NewIcuTransformTokenFilter returns a IcuTransformTokenFilter.

func (IcuTransformTokenFilter) MarshalJSON added in v8.9.0 

func (s IcuTransformTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IcuTransformTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *IcuTransformTokenFilter) UnmarshalJSON(data []byte) error

type Ids 

type Ids []string

Ids type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L62-L62

type IdsQuery 

type IdsQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	// Values An array of document IDs.
	Values []string `json:"values,omitempty"`
}

IdsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L88-L96

func NewIdsQuery added in v8.5.0 

func NewIdsQuery() *IdsQuery

NewIdsQuery returns a IdsQuery.

func (*IdsQuery) UnmarshalJSON added in v8.7.1 

func (s *IdsQuery) UnmarshalJSON(data []byte) error

type Ilm 

type Ilm struct {
	PolicyCount int                   `json:"policy_count"`
	PolicyStats []IlmPolicyStatistics `json:"policy_stats"`
}

Ilm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L172-L175

func NewIlm added in v8.5.0 

func NewIlm() *Ilm

NewIlm returns a Ilm.

func (*Ilm) UnmarshalJSON added in v8.7.1 

func (s *Ilm) UnmarshalJSON(data []byte) error

type IlmActions added in v8.5.0 

type IlmActions struct {
	// Allocate Phases allowed: warm, cold.
	Allocate *AllocateAction `json:"allocate,omitempty"`
	// Delete Phases allowed: delete.
	Delete *DeleteAction `json:"delete,omitempty"`
	// Downsample Phases allowed: hot, warm, cold.
	Downsample *DownsampleAction `json:"downsample,omitempty"`
	// Forcemerge Phases allowed: hot, warm.
	Forcemerge *ForceMergeAction `json:"forcemerge,omitempty"`
	// Freeze The freeze action is a noop in 8.x
	Freeze *EmptyObject `json:"freeze,omitempty"`
	// Migrate Phases allowed: warm, cold.
	Migrate *MigrateAction `json:"migrate,omitempty"`
	// Readonly Phases allowed: hot, warm, cold.
	Readonly *EmptyObject `json:"readonly,omitempty"`
	// Rollover Phases allowed: hot.
	Rollover *RolloverAction `json:"rollover,omitempty"`
	// SearchableSnapshot Phases allowed: hot, cold, frozen.
	SearchableSnapshot *SearchableSnapshotAction `json:"searchable_snapshot,omitempty"`
	// SetPriority Phases allowed: hot, warm, cold.
	SetPriority *SetPriorityAction `json:"set_priority,omitempty"`
	// Shrink Phases allowed: hot, warm.
	Shrink *ShrinkAction `json:"shrink,omitempty"`
	// Unfollow Phases allowed: hot, warm, cold, frozen.
	Unfollow *EmptyObject `json:"unfollow,omitempty"`
	// WaitForSnapshot Phases allowed: delete.
	WaitForSnapshot *WaitForSnapshotAction `json:"wait_for_snapshot,omitempty"`
}

IlmActions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L39-L93

func NewIlmActions added in v8.15.0 

func NewIlmActions() *IlmActions

NewIlmActions returns a IlmActions.

type IlmIndicator added in v8.7.1 

type IlmIndicator struct {
	Details   *IlmIndicatorDetails                        `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

IlmIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L163-L167

func NewIlmIndicator added in v8.7.1 

func NewIlmIndicator() *IlmIndicator

NewIlmIndicator returns a IlmIndicator.

func (*IlmIndicator) UnmarshalJSON added in v8.9.0 

func (s *IlmIndicator) UnmarshalJSON(data []byte) error

type IlmIndicatorDetails added in v8.7.1 

type IlmIndicatorDetails struct {
	IlmStatus         lifecycleoperationmode.LifecycleOperationMode `json:"ilm_status"`
	Policies          int64                                         `json:"policies"`
	StagnatingIndices int                                           `json:"stagnating_indices"`
}

IlmIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L168-L172

func NewIlmIndicatorDetails added in v8.7.1 

func NewIlmIndicatorDetails() *IlmIndicatorDetails

NewIlmIndicatorDetails returns a IlmIndicatorDetails.

func (*IlmIndicatorDetails) UnmarshalJSON added in v8.7.1 

func (s *IlmIndicatorDetails) UnmarshalJSON(data []byte) error

type IlmPolicy added in v8.5.0 

type IlmPolicy struct {
	// Meta_ Arbitrary metadata that is not automatically generated or used by
	// Elasticsearch.
	Meta_  Metadata `json:"_meta,omitempty"`
	Phases Phases   `json:"phases"`
}

IlmPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Policy.ts#L23-L29

func NewIlmPolicy added in v8.5.0 

func NewIlmPolicy() *IlmPolicy

NewIlmPolicy returns a IlmPolicy.

func (*IlmPolicy) UnmarshalJSON added in v8.7.1 

func (s *IlmPolicy) UnmarshalJSON(data []byte) error

type IlmPolicyStatistics 

type IlmPolicyStatistics struct {
	IndicesManaged int         `json:"indices_managed"`
	Phases         UsagePhases `json:"phases"`
}

IlmPolicyStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L167-L170

func NewIlmPolicyStatistics added in v8.5.0 

func NewIlmPolicyStatistics() *IlmPolicyStatistics

NewIlmPolicyStatistics returns a IlmPolicyStatistics.

func (*IlmPolicyStatistics) UnmarshalJSON added in v8.7.1 

func (s *IlmPolicyStatistics) UnmarshalJSON(data []byte) error

type Impact added in v8.7.1 

type Impact struct {
	Description string                  `json:"description"`
	Id          string                  `json:"id"`
	ImpactAreas []impactarea.ImpactArea `json:"impact_areas"`
	Severity    int                     `json:"severity"`
}

Impact type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L66-L71

func NewImpact added in v8.7.1 

func NewImpact() *Impact

NewImpact returns a Impact.

func (*Impact) UnmarshalJSON added in v8.7.1 

func (s *Impact) UnmarshalJSON(data []byte) error

type InProgress 

type InProgress struct {
	Name            string `json:"name"`
	StartTimeMillis int64  `json:"start_time_millis"`
	State           string `json:"state"`
	Uuid            string `json:"uuid"`
}

InProgress type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L141-L146

func NewInProgress added in v8.5.0 

func NewInProgress() *InProgress

NewInProgress returns a InProgress.

func (*InProgress) UnmarshalJSON added in v8.7.1 

func (s *InProgress) UnmarshalJSON(data []byte) error

type IncludedInValidation added in v8.15.0 

type IncludedInValidation struct {
	Constraint []ScalarValue `json:"constraint"`
	Type       string        `json:"type,omitempty"`
}

IncludedInValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L73-L76

func NewIncludedInValidation added in v8.15.0 

func NewIncludedInValidation() *IncludedInValidation

NewIncludedInValidation returns a IncludedInValidation.

func (IncludedInValidation) MarshalJSON added in v8.15.0 

func (s IncludedInValidation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type IndexAction 

type IndexAction struct {
	DocId              *string          `json:"doc_id,omitempty"`
	ExecutionTimeField *string          `json:"execution_time_field,omitempty"`
	Index              string           `json:"index"`
	OpType             *optype.OpType   `json:"op_type,omitempty"`
	Refresh            *refresh.Refresh `json:"refresh,omitempty"`
	Timeout            Duration         `json:"timeout,omitempty"`
}

IndexAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L256-L265

func NewIndexAction added in v8.5.0 

func NewIndexAction() *IndexAction

NewIndexAction returns a IndexAction.

func (*IndexAction) UnmarshalJSON added in v8.7.1 

func (s *IndexAction) UnmarshalJSON(data []byte) error

type IndexAliases 

type IndexAliases struct {
	Aliases map[string]AliasDefinition `json:"aliases"`
}

IndexAliases type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_alias/IndicesGetAliasResponse.ts#L37-L39

func NewIndexAliases added in v8.5.0 

func NewIndexAliases() *IndexAliases

NewIndexAliases returns a IndexAliases.

type IndexAndDataStreamAction 

type IndexAndDataStreamAction struct {
	// DataStream Data stream targeted by the action.
	DataStream string `json:"data_stream"`
	// Index Index for the action.
	Index string `json:"index"`
}

IndexAndDataStreamAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/modify_data_stream/types.ts#L39-L44

func NewIndexAndDataStreamAction added in v8.5.0 

func NewIndexAndDataStreamAction() *IndexAndDataStreamAction

NewIndexAndDataStreamAction returns a IndexAndDataStreamAction.

func (*IndexAndDataStreamAction) UnmarshalJSON added in v8.7.1 

func (s *IndexAndDataStreamAction) UnmarshalJSON(data []byte) error

type IndexCapabilities 

type IndexCapabilities struct {
	RollupJobs []RollupJobSummary `json:"rollup_jobs"`
}

IndexCapabilities type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_index_caps/types.ts#L24-L26

func NewIndexCapabilities added in v8.5.0 

func NewIndexCapabilities() *IndexCapabilities

NewIndexCapabilities returns a IndexCapabilities.

type IndexDetails 

type IndexDetails struct {
	MaxSegmentsPerShard int64    `json:"max_segments_per_shard"`
	ShardCount          int      `json:"shard_count"`
	Size                ByteSize `json:"size,omitempty"`
	SizeInBytes         int64    `json:"size_in_bytes"`
}

IndexDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotIndexDetails.ts#L23-L28

func NewIndexDetails added in v8.5.0 

func NewIndexDetails() *IndexDetails

NewIndexDetails returns a IndexDetails.

func (*IndexDetails) UnmarshalJSON added in v8.7.1 

func (s *IndexDetails) UnmarshalJSON(data []byte) error

type IndexField 

type IndexField struct {
	Enabled bool `json:"enabled"`
}

IndexField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L46-L48

func NewIndexField added in v8.5.0 

func NewIndexField() *IndexField

NewIndexField returns a IndexField.

func (*IndexField) UnmarshalJSON added in v8.7.1 

func (s *IndexField) UnmarshalJSON(data []byte) error

type IndexHealthStats 

type IndexHealthStats struct {
	ActivePrimaryShards     int                         `json:"active_primary_shards"`
	ActiveShards            int                         `json:"active_shards"`
	InitializingShards      int                         `json:"initializing_shards"`
	NumberOfReplicas        int                         `json:"number_of_replicas"`
	NumberOfShards          int                         `json:"number_of_shards"`
	RelocatingShards        int                         `json:"relocating_shards"`
	Shards                  map[string]ShardHealthStats `json:"shards,omitempty"`
	Status                  healthstatus.HealthStatus   `json:"status"`
	UnassignedPrimaryShards int                         `json:"unassigned_primary_shards"`
	UnassignedShards        int                         `json:"unassigned_shards"`
}

IndexHealthStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/health/types.ts#L24-L35

func NewIndexHealthStats added in v8.5.0 

func NewIndexHealthStats() *IndexHealthStats

NewIndexHealthStats returns a IndexHealthStats.

func (*IndexHealthStats) UnmarshalJSON added in v8.7.1 

func (s *IndexHealthStats) UnmarshalJSON(data []byte) error

type IndexMappingRecord 

type IndexMappingRecord struct {
	Item     *TypeMapping `json:"item,omitempty"`
	Mappings TypeMapping  `json:"mappings"`
}

IndexMappingRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_mapping/IndicesGetMappingResponse.ts#L29-L32

func NewIndexMappingRecord added in v8.5.0 

func NewIndexMappingRecord() *IndexMappingRecord

NewIndexMappingRecord returns a IndexMappingRecord.

type IndexOperation added in v8.9.0 

type IndexOperation struct {
	// DynamicTemplates A map from the full name of fields to the name of dynamic templates.
	// It defaults to an empty map.
	// If a name matches a dynamic template, that template will be applied
	// regardless of other match predicates defined in the template.
	// If a field is already defined in the mapping, then this parameter won't be
	// used.
	DynamicTemplates map[string]string `json:"dynamic_templates,omitempty"`
	// Id_ The document ID.
	Id_           *string `json:"_id,omitempty"`
	IfPrimaryTerm *int64  `json:"if_primary_term,omitempty"`
	IfSeqNo       *int64  `json:"if_seq_no,omitempty"`
	// Index_ The name of the index or index alias to perform the action on.
	Index_ *string `json:"_index,omitempty"`
	// Pipeline The ID of the pipeline to use to preprocess incoming documents.
	// If the index has a default ingest pipeline specified, setting the value to
	// `_none` turns off the default ingest pipeline for this request.
	// If a final pipeline is configured, it will always run regardless of the value
	// of this parameter.
	Pipeline *string `json:"pipeline,omitempty"`
	// RequireAlias If `true`, the request's actions must target an index alias.
	RequireAlias *bool `json:"require_alias,omitempty"`
	// Routing A custom value used to route operations to a specific shard.
	Routing     *string                  `json:"routing,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

IndexOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L142-L142

func NewIndexOperation added in v8.9.0 

func NewIndexOperation() *IndexOperation

NewIndexOperation returns a IndexOperation.

func (*IndexOperation) UnmarshalJSON added in v8.9.0 

func (s *IndexOperation) UnmarshalJSON(data []byte) error

type IndexPrivilegesCheck 

type IndexPrivilegesCheck struct {
	// AllowRestrictedIndices This needs to be set to `true` (default is `false`) if using wildcards or
	// regexps for patterns that cover restricted indices.
	// Implicitly, restricted indices do not match index patterns because restricted
	// indices usually have limited privileges and including them in pattern tests
	// would render most such tests false.
	// If restricted indices are explicitly included in the names list, privileges
	// will be checked against them regardless of the value of
	// `allow_restricted_indices`.
	AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
	// Names A list of indices.
	Names []string `json:"names"`
	// Privileges A list of the privileges that you want to check for the specified indices.
	Privileges []indexprivilege.IndexPrivilege `json:"privileges"`
}

IndexPrivilegesCheck type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges/types.ts#L34-L45

func NewIndexPrivilegesCheck added in v8.5.0 

func NewIndexPrivilegesCheck() *IndexPrivilegesCheck

NewIndexPrivilegesCheck returns a IndexPrivilegesCheck.

func (*IndexPrivilegesCheck) UnmarshalJSON added in v8.7.1 

func (s *IndexPrivilegesCheck) UnmarshalJSON(data []byte) error

type IndexResult 

type IndexResult struct {
	Response IndexResultSummary `json:"response"`
}

IndexResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L267-L269

func NewIndexResult added in v8.5.0 

func NewIndexResult() *IndexResult

NewIndexResult returns a IndexResult.

type IndexResultSummary 

type IndexResultSummary struct {
	Created bool          `json:"created"`
	Id      string        `json:"id"`
	Index   string        `json:"index"`
	Result  result.Result `json:"result"`
	Version int64         `json:"version"`
}

IndexResultSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L271-L277

func NewIndexResultSummary added in v8.5.0 

func NewIndexResultSummary() *IndexResultSummary

NewIndexResultSummary returns a IndexResultSummary.

func (*IndexResultSummary) UnmarshalJSON added in v8.7.1 

func (s *IndexResultSummary) UnmarshalJSON(data []byte) error

type IndexRouting 

type IndexRouting struct {
	Allocation *IndexRoutingAllocation `json:"allocation,omitempty"`
	Rebalance  *IndexRoutingRebalance  `json:"rebalance,omitempty"`
}

IndexRouting type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L22-L25

func NewIndexRouting added in v8.5.0 

func NewIndexRouting() *IndexRouting

NewIndexRouting returns a IndexRouting.

type IndexRoutingAllocation 

type IndexRoutingAllocation struct {
	Disk            *IndexRoutingAllocationDisk                                  `json:"disk,omitempty"`
	Enable          *indexroutingallocationoptions.IndexRoutingAllocationOptions `json:"enable,omitempty"`
	Include         *IndexRoutingAllocationInclude                               `json:"include,omitempty"`
	InitialRecovery *IndexRoutingAllocationInitialRecovery                       `json:"initial_recovery,omitempty"`
}

IndexRoutingAllocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L27-L32

func NewIndexRoutingAllocation added in v8.5.0 

func NewIndexRoutingAllocation() *IndexRoutingAllocation

NewIndexRoutingAllocation returns a IndexRoutingAllocation.

type IndexRoutingAllocationDisk 

type IndexRoutingAllocationDisk struct {
	ThresholdEnabled string `json:"threshold_enabled,omitempty"`
}

IndexRoutingAllocationDisk type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L62-L64

func NewIndexRoutingAllocationDisk added in v8.5.0 

func NewIndexRoutingAllocationDisk() *IndexRoutingAllocationDisk

NewIndexRoutingAllocationDisk returns a IndexRoutingAllocationDisk.

func (*IndexRoutingAllocationDisk) UnmarshalJSON added in v8.7.1 

func (s *IndexRoutingAllocationDisk) UnmarshalJSON(data []byte) error

type IndexRoutingAllocationInclude 

type IndexRoutingAllocationInclude struct {
	Id_             *string `json:"_id,omitempty"`
	TierPreference_ *string `json:"_tier_preference,omitempty"`
}

IndexRoutingAllocationInclude type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L52-L55

func NewIndexRoutingAllocationInclude added in v8.5.0 

func NewIndexRoutingAllocationInclude() *IndexRoutingAllocationInclude

NewIndexRoutingAllocationInclude returns a IndexRoutingAllocationInclude.

func (*IndexRoutingAllocationInclude) UnmarshalJSON added in v8.7.1 

func (s *IndexRoutingAllocationInclude) UnmarshalJSON(data []byte) error

type IndexRoutingAllocationInitialRecovery 

type IndexRoutingAllocationInitialRecovery struct {
	Id_ *string `json:"_id,omitempty"`
}

IndexRoutingAllocationInitialRecovery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L57-L59

func NewIndexRoutingAllocationInitialRecovery added in v8.5.0 

func NewIndexRoutingAllocationInitialRecovery() *IndexRoutingAllocationInitialRecovery

NewIndexRoutingAllocationInitialRecovery returns a IndexRoutingAllocationInitialRecovery.

func (*IndexRoutingAllocationInitialRecovery) UnmarshalJSON added in v8.7.1 

func (s *IndexRoutingAllocationInitialRecovery) UnmarshalJSON(data []byte) error

type IndexRoutingRebalance 

type IndexRoutingRebalance struct {
	Enable indexroutingrebalanceoptions.IndexRoutingRebalanceOptions `json:"enable"`
}

IndexRoutingRebalance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexRouting.ts#L34-L36

func NewIndexRoutingRebalance added in v8.5.0 

func NewIndexRoutingRebalance() *IndexRoutingRebalance

NewIndexRoutingRebalance returns a IndexRoutingRebalance.

type IndexSegment 

type IndexSegment struct {
	Shards map[string][]ShardsSegment `json:"shards"`
}

IndexSegment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/segments/types.ts#L24-L26

func NewIndexSegment added in v8.5.0 

func NewIndexSegment() *IndexSegment

NewIndexSegment returns a IndexSegment.

type IndexSegmentSort 

type IndexSegmentSort struct {
	Field   []string                                `json:"field,omitempty"`
	Missing []segmentsortmissing.SegmentSortMissing `json:"missing,omitempty"`
	Mode    []segmentsortmode.SegmentSortMode       `json:"mode,omitempty"`
	Order   []segmentsortorder.SegmentSortOrder     `json:"order,omitempty"`
}

IndexSegmentSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSegmentSort.ts#L22-L27

func NewIndexSegmentSort added in v8.5.0 

func NewIndexSegmentSort() *IndexSegmentSort

NewIndexSegmentSort returns a IndexSegmentSort.

func (*IndexSegmentSort) UnmarshalJSON added in v8.7.1 

func (s *IndexSegmentSort) UnmarshalJSON(data []byte) error

type IndexSettingBlocks 

type IndexSettingBlocks struct {
	Metadata            Stringifiedboolean `json:"metadata,omitempty"`
	Read                Stringifiedboolean `json:"read,omitempty"`
	ReadOnly            Stringifiedboolean `json:"read_only,omitempty"`
	ReadOnlyAllowDelete Stringifiedboolean `json:"read_only_allow_delete,omitempty"`
	Write               Stringifiedboolean `json:"write,omitempty"`
}

IndexSettingBlocks type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L262-L268

func NewIndexSettingBlocks added in v8.5.0 

func NewIndexSettingBlocks() *IndexSettingBlocks

NewIndexSettingBlocks returns a IndexSettingBlocks.

func (*IndexSettingBlocks) UnmarshalJSON added in v8.7.1 

func (s *IndexSettingBlocks) UnmarshalJSON(data []byte) error

type IndexSettings 

type IndexSettings struct {
	Analysis *IndexSettingsAnalysis `json:"analysis,omitempty"`
	// Analyze Settings to define analyzers, tokenizers, token filters and character
	// filters.
	Analyze            *SettingsAnalyze                         `json:"analyze,omitempty"`
	AutoExpandReplicas any                                      `json:"auto_expand_replicas,omitempty"`
	Blocks             *IndexSettingBlocks                      `json:"blocks,omitempty"`
	CheckOnStartup     *indexcheckonstartup.IndexCheckOnStartup `json:"check_on_startup,omitempty"`
	Codec              *string                                  `json:"codec,omitempty"`
	CreationDate       StringifiedEpochTimeUnitMillis           `json:"creation_date,omitempty"`
	CreationDateString DateTime                                 `json:"creation_date_string,omitempty"`
	DefaultPipeline    *string                                  `json:"default_pipeline,omitempty"`
	FinalPipeline      *string                                  `json:"final_pipeline,omitempty"`
	Format             string                                   `json:"format,omitempty"`
	GcDeletes          Duration                                 `json:"gc_deletes,omitempty"`
	Hidden             string                                   `json:"hidden,omitempty"`
	Highlight          *SettingsHighlight                       `json:"highlight,omitempty"`
	Index              *IndexSettings                           `json:"index,omitempty"`
	IndexSettings      map[string]json.RawMessage               `json:"-"`
	// IndexingPressure Configure indexing back pressure limits.
	IndexingPressure              *IndicesIndexingPressure `json:"indexing_pressure,omitempty"`
	IndexingSlowlog               *IndexingSlowlogSettings `json:"indexing.slowlog,omitempty"`
	Lifecycle                     *IndexSettingsLifecycle  `json:"lifecycle,omitempty"`
	LoadFixedBitsetFiltersEagerly *bool                    `json:"load_fixed_bitset_filters_eagerly,omitempty"`
	// Mapping Enable or disable dynamic mapping for an index.
	Mapping                 *MappingLimitSettings `json:"mapping,omitempty"`
	MaxDocvalueFieldsSearch *int                  `json:"max_docvalue_fields_search,omitempty"`
	MaxInnerResultWindow    *int                  `json:"max_inner_result_window,omitempty"`
	MaxNgramDiff            *int                  `json:"max_ngram_diff,omitempty"`
	MaxRefreshListeners     *int                  `json:"max_refresh_listeners,omitempty"`
	MaxRegexLength          *int                  `json:"max_regex_length,omitempty"`
	MaxRescoreWindow        *int                  `json:"max_rescore_window,omitempty"`
	MaxResultWindow         *int                  `json:"max_result_window,omitempty"`
	MaxScriptFields         *int                  `json:"max_script_fields,omitempty"`
	MaxShingleDiff          *int                  `json:"max_shingle_diff,omitempty"`
	MaxSlicesPerScroll      *int                  `json:"max_slices_per_scroll,omitempty"`
	MaxTermsCount           *int                  `json:"max_terms_count,omitempty"`
	Merge                   *Merge                `json:"merge,omitempty"`
	Mode                    *string               `json:"mode,omitempty"`
	NumberOfReplicas        string                `json:"number_of_replicas,omitempty"`
	NumberOfRoutingShards   *int                  `json:"number_of_routing_shards,omitempty"`
	NumberOfShards          string                `json:"number_of_shards,omitempty"`
	Priority                string                `json:"priority,omitempty"`
	ProvidedName            *string               `json:"provided_name,omitempty"`
	Queries                 *Queries              `json:"queries,omitempty"`
	QueryString             *SettingsQueryString  `json:"query_string,omitempty"`
	RefreshInterval         Duration              `json:"refresh_interval,omitempty"`
	Routing                 *IndexRouting         `json:"routing,omitempty"`
	RoutingPartitionSize    Stringifiedinteger    `json:"routing_partition_size,omitempty"`
	RoutingPath             []string              `json:"routing_path,omitempty"`
	Search                  *SettingsSearch       `json:"search,omitempty"`
	Settings                *IndexSettings        `json:"settings,omitempty"`
	// Similarity Configure custom similarity settings to customize how search results are
	// scored.
	Similarity  map[string]SettingsSimilarity `json:"similarity,omitempty"`
	SoftDeletes *SoftDeletes                  `json:"soft_deletes,omitempty"`
	Sort        *IndexSegmentSort             `json:"sort,omitempty"`
	// Store The store module allows you to control how index data is stored and accessed
	// on disk.
	Store               *Storage                 `json:"store,omitempty"`
	TimeSeries          *IndexSettingsTimeSeries `json:"time_series,omitempty"`
	TopMetricsMaxSize   *int                     `json:"top_metrics_max_size,omitempty"`
	Translog            *Translog                `json:"translog,omitempty"`
	Uuid                *string                  `json:"uuid,omitempty"`
	VerifiedBeforeClose string                   `json:"verified_before_close,omitempty"`
	Version             *IndexVersioning         `json:"version,omitempty"`
}

IndexSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L70-L176

func NewIndexSettings added in v8.5.0 

func NewIndexSettings() *IndexSettings

NewIndexSettings returns a IndexSettings.

func (IndexSettings) MarshalJSON 

func (s IndexSettings) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*IndexSettings) UnmarshalJSON added in v8.7.1 

func (s *IndexSettings) UnmarshalJSON(data []byte) error

type IndexSettingsAnalysis 

type IndexSettingsAnalysis struct {
	Analyzer   map[string]Analyzer    `json:"analyzer,omitempty"`
	CharFilter map[string]CharFilter  `json:"char_filter,omitempty"`
	Filter     map[string]TokenFilter `json:"filter,omitempty"`
	Normalizer map[string]Normalizer  `json:"normalizer,omitempty"`
	Tokenizer  map[string]Tokenizer   `json:"tokenizer,omitempty"`
}

IndexSettingsAnalysis type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L333-L339

func NewIndexSettingsAnalysis added in v8.5.0 

func NewIndexSettingsAnalysis() *IndexSettingsAnalysis

NewIndexSettingsAnalysis returns a IndexSettingsAnalysis.

func (*IndexSettingsAnalysis) UnmarshalJSON added in v8.7.0 

func (s *IndexSettingsAnalysis) UnmarshalJSON(data []byte) error

type IndexSettingsLifecycle 

type IndexSettingsLifecycle struct {
	// IndexingComplete Indicates whether or not the index has been rolled over. Automatically set to
	// true when ILM completes the rollover action.
	// You can explicitly set it to skip rollover.
	IndexingComplete Stringifiedboolean `json:"indexing_complete,omitempty"`
	// Name The name of the policy to use to manage the index. For information about how
	// Elasticsearch applies policy changes, see Policy updates.
	Name *string `json:"name,omitempty"`
	// OriginationDate If specified, this is the timestamp used to calculate the index age for its
	// phase transitions. Use this setting
	// if you create a new index that contains old data and want to use the original
	// creation date to calculate the index
	// age. Specified as a Unix epoch value in milliseconds.
	OriginationDate *int64 `json:"origination_date,omitempty"`
	// ParseOriginationDate Set to true to parse the origination date from the index name. This
	// origination date is used to calculate the index age
	// for its phase transitions. The index name must match the pattern
	// ^.*-{date_format}-\\d+, where the date_format is
	// yyyy.MM.dd and the trailing digits are optional. An index that was rolled
	// over would normally match the full format,
	// for example logs-2016.10.31-000002). If the index name doesn’t match the
	// pattern, index creation fails.
	ParseOriginationDate *bool `json:"parse_origination_date,omitempty"`
	// PreferIlm Preference for the system that manages a data stream backing index
	// (preferring ILM when both ILM and DLM are
	// applicable for an index).
	PreferIlm string `json:"prefer_ilm,omitempty"`
	// RolloverAlias The index alias to update when the index rolls over. Specify when using a
	// policy that contains a rollover action.
	// When the index rolls over, the alias is updated to reflect that the index is
	// no longer the write index. For more
	// information about rolling indices, see Rollover.
	RolloverAlias *string                     `json:"rollover_alias,omitempty"`
	Step          *IndexSettingsLifecycleStep `json:"step,omitempty"`
}

IndexSettingsLifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L284-L323

func NewIndexSettingsLifecycle added in v8.5.0 

func NewIndexSettingsLifecycle() *IndexSettingsLifecycle

NewIndexSettingsLifecycle returns a IndexSettingsLifecycle.

func (*IndexSettingsLifecycle) UnmarshalJSON added in v8.7.1 

func (s *IndexSettingsLifecycle) UnmarshalJSON(data []byte) error

type IndexSettingsLifecycleStep 

type IndexSettingsLifecycleStep struct {
	// WaitTimeThreshold Time to wait for the cluster to resolve allocation issues during an ILM
	// shrink action. Must be greater than 1h (1 hour).
	// See Shard allocation for shrink.
	WaitTimeThreshold Duration `json:"wait_time_threshold,omitempty"`
}

IndexSettingsLifecycleStep type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L325-L331

func NewIndexSettingsLifecycleStep added in v8.5.0 

func NewIndexSettingsLifecycleStep() *IndexSettingsLifecycleStep

NewIndexSettingsLifecycleStep returns a IndexSettingsLifecycleStep.

func (*IndexSettingsLifecycleStep) UnmarshalJSON added in v8.7.1 

func (s *IndexSettingsLifecycleStep) UnmarshalJSON(data []byte) error

type IndexSettingsTimeSeries 

type IndexSettingsTimeSeries struct {
	EndTime   DateTime `json:"end_time,omitempty"`
	StartTime DateTime `json:"start_time,omitempty"`
}

IndexSettingsTimeSeries type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L341-L344

func NewIndexSettingsTimeSeries added in v8.5.0 

func NewIndexSettingsTimeSeries() *IndexSettingsTimeSeries

NewIndexSettingsTimeSeries returns a IndexSettingsTimeSeries.

func (*IndexSettingsTimeSeries) UnmarshalJSON added in v8.7.1 

func (s *IndexSettingsTimeSeries) UnmarshalJSON(data []byte) error

type IndexState 

type IndexState struct {
	Aliases    map[string]Alias `json:"aliases,omitempty"`
	DataStream *string          `json:"data_stream,omitempty"`
	// Defaults Default settings, included when the request's `include_default` is `true`.
	Defaults *IndexSettings `json:"defaults,omitempty"`
	// Lifecycle Data stream lifecycle applicable if this is a data stream.
	Lifecycle *DataStreamLifecycle `json:"lifecycle,omitempty"`
	Mappings  *TypeMapping         `json:"mappings,omitempty"`
	Settings  *IndexSettings       `json:"settings,omitempty"`
}

IndexState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexState.ts#L27-L40

func NewIndexState added in v8.5.0 

func NewIndexState() *IndexState

NewIndexState returns a IndexState.

func (*IndexState) UnmarshalJSON added in v8.7.1 

func (s *IndexState) UnmarshalJSON(data []byte) error

type IndexStats 

type IndexStats struct {
	Bulk *BulkStats `json:"bulk,omitempty"`
	// Completion Contains statistics about completions across all shards assigned to the node.
	Completion *CompletionStats `json:"completion,omitempty"`
	// Docs Contains statistics about documents across all primary shards assigned to the
	// node.
	Docs *DocStats `json:"docs,omitempty"`
	// Fielddata Contains statistics about the field data cache across all shards assigned to
	// the node.
	Fielddata *FielddataStats `json:"fielddata,omitempty"`
	// Flush Contains statistics about flush operations for the node.
	Flush *FlushStats `json:"flush,omitempty"`
	// Get Contains statistics about get operations for the node.
	Get *GetStats `json:"get,omitempty"`
	// Indexing Contains statistics about indexing operations for the node.
	Indexing *IndexingStats `json:"indexing,omitempty"`
	// Indices Contains statistics about indices operations for the node.
	Indices *IndicesStats `json:"indices,omitempty"`
	// Merges Contains statistics about merge operations for the node.
	Merges *MergesStats `json:"merges,omitempty"`
	// QueryCache Contains statistics about the query cache across all shards assigned to the
	// node.
	QueryCache *QueryCacheStats `json:"query_cache,omitempty"`
	// Recovery Contains statistics about recovery operations for the node.
	Recovery *RecoveryStats `json:"recovery,omitempty"`
	// Refresh Contains statistics about refresh operations for the node.
	Refresh *RefreshStats `json:"refresh,omitempty"`
	// RequestCache Contains statistics about the request cache across all shards assigned to the
	// node.
	RequestCache *RequestCacheStats `json:"request_cache,omitempty"`
	// Search Contains statistics about search operations for the node.
	Search *SearchStats `json:"search,omitempty"`
	// Segments Contains statistics about segments across all shards assigned to the node.
	Segments   *SegmentsStats    `json:"segments,omitempty"`
	ShardStats *ShardsTotalStats `json:"shard_stats,omitempty"`
	// Store Contains statistics about the size of shards assigned to the node.
	Store *StoreStats `json:"store,omitempty"`
	// Translog Contains statistics about transaction log operations for the node.
	Translog *TranslogStats `json:"translog,omitempty"`
	// Warmer Contains statistics about index warming operations for the node.
	Warmer *WarmerStats `json:"warmer,omitempty"`
}

IndexStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L52-L93

func NewIndexStats added in v8.5.0 

func NewIndexStats() *IndexStats

NewIndexStats returns a IndexStats.

type IndexTemplate 

type IndexTemplate struct {
	AllowAutoCreate *bool `json:"allow_auto_create,omitempty"`
	// ComposedOf An ordered list of component template names.
	// Component templates are merged in the order specified, meaning that the last
	// component template specified has the highest precedence.
	ComposedOf []string `json:"composed_of"`
	// DataStream If this object is included, the template is used to create data streams and
	// their backing indices.
	// Supports an empty object.
	// Data streams require a matching index template with a `data_stream` object.
	DataStream *IndexTemplateDataStreamConfiguration `json:"data_stream,omitempty"`
	// Deprecated Marks this index template as deprecated.
	// When creating or updating a non-deprecated index template that uses
	// deprecated components,
	// Elasticsearch will emit a deprecation warning.
	Deprecated *bool `json:"deprecated,omitempty"`
	// IgnoreMissingComponentTemplates A list of component template names that are allowed to be absent.
	IgnoreMissingComponentTemplates []string `json:"ignore_missing_component_templates,omitempty"`
	// IndexPatterns Name of the index template.
	IndexPatterns []string `json:"index_patterns"`
	// Meta_ Optional user metadata about the index template. May have any contents.
	// This map is not automatically generated by Elasticsearch.
	Meta_ Metadata `json:"_meta,omitempty"`
	// Priority Priority to determine index template precedence when a new data stream or
	// index is created.
	// The index template with the highest priority is chosen.
	// If no priority is specified the template is treated as though it is of
	// priority 0 (lowest priority).
	// This number is not automatically generated by Elasticsearch.
	Priority *int64 `json:"priority,omitempty"`
	// Template Template to be applied.
	// It may optionally include an `aliases`, `mappings`, or `settings`
	// configuration.
	Template *IndexTemplateSummary `json:"template,omitempty"`
	// Version Version number used to manage index templates externally.
	// This number is not automatically generated by Elasticsearch.
	Version *int64 `json:"version,omitempty"`
}

IndexTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexTemplate.ts#L28-L81

func NewIndexTemplate added in v8.5.0 

func NewIndexTemplate() *IndexTemplate

NewIndexTemplate returns a IndexTemplate.

func (*IndexTemplate) UnmarshalJSON added in v8.7.1 

func (s *IndexTemplate) UnmarshalJSON(data []byte) error

type IndexTemplateDataStreamConfiguration 

type IndexTemplateDataStreamConfiguration struct {
	// AllowCustomRouting If true, the data stream supports custom routing.
	AllowCustomRouting *bool `json:"allow_custom_routing,omitempty"`
	// Hidden If true, the data stream is hidden.
	Hidden *bool `json:"hidden,omitempty"`
}

IndexTemplateDataStreamConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexTemplate.ts#L83-L94

func NewIndexTemplateDataStreamConfiguration added in v8.5.0 

func NewIndexTemplateDataStreamConfiguration() *IndexTemplateDataStreamConfiguration

NewIndexTemplateDataStreamConfiguration returns a IndexTemplateDataStreamConfiguration.

func (*IndexTemplateDataStreamConfiguration) UnmarshalJSON added in v8.7.1 

func (s *IndexTemplateDataStreamConfiguration) UnmarshalJSON(data []byte) error

type IndexTemplateItem 

type IndexTemplateItem struct {
	IndexTemplate IndexTemplate `json:"index_template"`
	Name          string        `json:"name"`
}

IndexTemplateItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L29-L32

func NewIndexTemplateItem added in v8.5.0 

func NewIndexTemplateItem() *IndexTemplateItem

NewIndexTemplateItem returns a IndexTemplateItem.

func (*IndexTemplateItem) UnmarshalJSON added in v8.7.1 

func (s *IndexTemplateItem) UnmarshalJSON(data []byte) error

type IndexTemplateMapping 

type IndexTemplateMapping struct {
	// Aliases Aliases to add.
	// If the index template includes a `data_stream` object, these are data stream
	// aliases.
	// Otherwise, these are index aliases.
	// Data stream aliases ignore the `index_routing`, `routing`, and
	// `search_routing` options.
	Aliases   map[string]Alias     `json:"aliases,omitempty"`
	Lifecycle *DataStreamLifecycle `json:"lifecycle,omitempty"`
	// Mappings Mapping for fields in the index.
	// If specified, this mapping can include field names, field data types, and
	// mapping parameters.
	Mappings *TypeMapping `json:"mappings,omitempty"`
	// Settings Configuration options for the index.
	Settings *IndexSettings `json:"settings,omitempty"`
}

IndexTemplateMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L159-L181

func NewIndexTemplateMapping added in v8.5.0 

func NewIndexTemplateMapping() *IndexTemplateMapping

NewIndexTemplateMapping returns a IndexTemplateMapping.

type IndexTemplateSummary 

type IndexTemplateSummary struct {
	// Aliases Aliases to add.
	// If the index template includes a `data_stream` object, these are data stream
	// aliases.
	// Otherwise, these are index aliases.
	// Data stream aliases ignore the `index_routing`, `routing`, and
	// `search_routing` options.
	Aliases   map[string]Alias                 `json:"aliases,omitempty"`
	Lifecycle *DataStreamLifecycleWithRollover `json:"lifecycle,omitempty"`
	// Mappings Mapping for fields in the index.
	// If specified, this mapping can include field names, field data types, and
	// mapping parameters.
	Mappings *TypeMapping `json:"mappings,omitempty"`
	// Settings Configuration options for the index.
	Settings *IndexSettings `json:"settings,omitempty"`
}

IndexTemplateSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexTemplate.ts#L96-L118

func NewIndexTemplateSummary added in v8.5.0 

func NewIndexTemplateSummary() *IndexTemplateSummary

NewIndexTemplateSummary returns a IndexTemplateSummary.

type IndexVersioning 

type IndexVersioning struct {
	Created       *string `json:"created,omitempty"`
	CreatedString *string `json:"created_string,omitempty"`
}

IndexVersioning type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L279-L282

func NewIndexVersioning added in v8.5.0 

func NewIndexVersioning() *IndexVersioning

NewIndexVersioning returns a IndexVersioning.

func (*IndexVersioning) UnmarshalJSON added in v8.7.1 

func (s *IndexVersioning) UnmarshalJSON(data []byte) error

type IndexingPressureMemorySummary 

type IndexingPressureMemorySummary struct {
	AllInBytes                            int64  `json:"all_in_bytes"`
	CombinedCoordinatingAndPrimaryInBytes int64  `json:"combined_coordinating_and_primary_in_bytes"`
	CoordinatingInBytes                   int64  `json:"coordinating_in_bytes"`
	CoordinatingRejections                *int64 `json:"coordinating_rejections,omitempty"`
	PrimaryInBytes                        int64  `json:"primary_in_bytes"`
	PrimaryRejections                     *int64 `json:"primary_rejections,omitempty"`
	ReplicaInBytes                        int64  `json:"replica_in_bytes"`
	ReplicaRejections                     *int64 `json:"replica_rejections,omitempty"`
}

IndexingPressureMemorySummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L580-L589

func NewIndexingPressureMemorySummary added in v8.5.0 

func NewIndexingPressureMemorySummary() *IndexingPressureMemorySummary

NewIndexingPressureMemorySummary returns a IndexingPressureMemorySummary.

func (*IndexingPressureMemorySummary) UnmarshalJSON added in v8.7.1 

func (s *IndexingPressureMemorySummary) UnmarshalJSON(data []byte) error

type IndexingSlowlogSettings added in v8.10.0 

type IndexingSlowlogSettings struct {
	Level     *string                   `json:"level,omitempty"`
	Reformat  *bool                     `json:"reformat,omitempty"`
	Source    *int                      `json:"source,omitempty"`
	Threshold *IndexingSlowlogTresholds `json:"threshold,omitempty"`
}

IndexingSlowlogSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L588-L593

func NewIndexingSlowlogSettings added in v8.10.0 

func NewIndexingSlowlogSettings() *IndexingSlowlogSettings

NewIndexingSlowlogSettings returns a IndexingSlowlogSettings.

func (*IndexingSlowlogSettings) UnmarshalJSON added in v8.10.0 

func (s *IndexingSlowlogSettings) UnmarshalJSON(data []byte) error

type IndexingSlowlogTresholds added in v8.10.0 

type IndexingSlowlogTresholds struct {
	// Index The indexing slow log, similar in functionality to the search slow log. The
	// log file name ends with `_index_indexing_slowlog.json`.
	// Log and the thresholds are configured in the same way as the search slowlog.
	Index *SlowlogTresholdLevels `json:"index,omitempty"`
}

IndexingSlowlogTresholds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L595-L602

func NewIndexingSlowlogTresholds added in v8.10.0 

func NewIndexingSlowlogTresholds() *IndexingSlowlogTresholds

NewIndexingSlowlogTresholds returns a IndexingSlowlogTresholds.

type IndexingStats 

type IndexingStats struct {
	DeleteCurrent        int64                    `json:"delete_current"`
	DeleteTime           Duration                 `json:"delete_time,omitempty"`
	DeleteTimeInMillis   int64                    `json:"delete_time_in_millis"`
	DeleteTotal          int64                    `json:"delete_total"`
	IndexCurrent         int64                    `json:"index_current"`
	IndexFailed          int64                    `json:"index_failed"`
	IndexTime            Duration                 `json:"index_time,omitempty"`
	IndexTimeInMillis    int64                    `json:"index_time_in_millis"`
	IndexTotal           int64                    `json:"index_total"`
	IsThrottled          bool                     `json:"is_throttled"`
	NoopUpdateTotal      int64                    `json:"noop_update_total"`
	ThrottleTime         Duration                 `json:"throttle_time,omitempty"`
	ThrottleTimeInMillis int64                    `json:"throttle_time_in_millis"`
	Types                map[string]IndexingStats `json:"types,omitempty"`
	WriteLoad            *Float64                 `json:"write_load,omitempty"`
}

IndexingStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L146-L162

func NewIndexingStats added in v8.5.0 

func NewIndexingStats() *IndexingStats

NewIndexingStats returns a IndexingStats.

func (*IndexingStats) UnmarshalJSON added in v8.7.1 

func (s *IndexingStats) UnmarshalJSON(data []byte) error

type IndicNormalizationTokenFilter added in v8.18.1 

type IndicNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

IndicNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L497-L499

func NewIndicNormalizationTokenFilter added in v8.18.1 

func NewIndicNormalizationTokenFilter() *IndicNormalizationTokenFilter

NewIndicNormalizationTokenFilter returns a IndicNormalizationTokenFilter.

func (IndicNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s IndicNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IndicNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *IndicNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type IndicatorNode added in v8.7.1 

type IndicatorNode struct {
	Name   *string `json:"name,omitempty"`
	NodeId *string `json:"node_id,omitempty"`
}

IndicatorNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L91-L94

func NewIndicatorNode added in v8.7.1 

func NewIndicatorNode() *IndicatorNode

NewIndicatorNode returns a IndicatorNode.

func (*IndicatorNode) UnmarshalJSON added in v8.7.1 

func (s *IndicatorNode) UnmarshalJSON(data []byte) error

type Indicators added in v8.7.1 

type Indicators struct {
	DataStreamLifecycle *DataStreamLifecycleIndicator `json:"data_stream_lifecycle,omitempty"`
	Disk                *DiskIndicator                `json:"disk,omitempty"`
	Ilm                 *IlmIndicator                 `json:"ilm,omitempty"`
	MasterIsStable      *MasterIsStableIndicator      `json:"master_is_stable,omitempty"`
	RepositoryIntegrity *RepositoryIntegrityIndicator `json:"repository_integrity,omitempty"`
	ShardsAvailability  *ShardsAvailabilityIndicator  `json:"shards_availability,omitempty"`
	ShardsCapacity      *ShardsCapacityIndicator      `json:"shards_capacity,omitempty"`
	Slm                 *SlmIndicator                 `json:"slm,omitempty"`
}

Indicators type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L32-L41

func NewIndicators added in v8.7.1 

func NewIndicators() *Indicators

NewIndicators returns a Indicators.

type Indices 

type Indices []string

Indices type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L67-L67

type IndicesAction added in v8.5.0 

type IndicesAction struct {
	// Add Adds a data stream or index to an alias.
	// If the alias doesn’t exist, the `add` action creates it.
	Add *AddAction `json:"add,omitempty"`
	// Remove Removes a data stream or index from an alias.
	Remove *RemoveAction `json:"remove,omitempty"`
	// RemoveIndex Deletes an index.
	// You cannot use this action on aliases or data streams.
	RemoveIndex *RemoveIndexAction `json:"remove_index,omitempty"`
}

IndicesAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/update_aliases/types.ts#L23-L39

func NewIndicesAction added in v8.5.0 

func NewIndicesAction() *IndicesAction

NewIndicesAction returns a IndicesAction.

type IndicesBlockStatus 

type IndicesBlockStatus struct {
	Blocked bool   `json:"blocked"`
	Name    string `json:"name"`
}

IndicesBlockStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/add_block/IndicesAddBlockResponse.ts#L30-L33

func NewIndicesBlockStatus added in v8.5.0 

func NewIndicesBlockStatus() *IndicesBlockStatus

NewIndicesBlockStatus returns a IndicesBlockStatus.

func (*IndicesBlockStatus) UnmarshalJSON added in v8.7.1 

func (s *IndicesBlockStatus) UnmarshalJSON(data []byte) error

type IndicesIndexingPressure added in v8.5.0 

type IndicesIndexingPressure struct {
	Memory IndicesIndexingPressureMemory `json:"memory"`
}

IndicesIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L575-L577

func NewIndicesIndexingPressure added in v8.5.0 

func NewIndicesIndexingPressure() *IndicesIndexingPressure

NewIndicesIndexingPressure returns a IndicesIndexingPressure.

type IndicesIndexingPressureMemory added in v8.5.0 

type IndicesIndexingPressureMemory struct {
	// Limit Number of outstanding bytes that may be consumed by indexing requests. When
	// this limit is reached or exceeded,
	// the node will reject new coordinating and primary operations. When replica
	// operations consume 1.5x this limit,
	// the node will reject new replica operations. Defaults to 10% of the heap.
	Limit *int `json:"limit,omitempty"`
}

IndicesIndexingPressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L579-L586

func NewIndicesIndexingPressureMemory added in v8.5.0 

func NewIndicesIndexingPressureMemory() *IndicesIndexingPressureMemory

NewIndicesIndexingPressureMemory returns a IndicesIndexingPressureMemory.

func (*IndicesIndexingPressureMemory) UnmarshalJSON added in v8.7.1 

func (s *IndicesIndexingPressureMemory) UnmarshalJSON(data []byte) error

type IndicesModifyAction added in v8.5.0 

type IndicesModifyAction struct {
	// AddBackingIndex Adds an existing index as a backing index for a data stream.
	// The index is hidden as part of this operation.
	// WARNING: Adding indices with the `add_backing_index` action can potentially
	// result in improper data stream behavior.
	// This should be considered an expert level API.
	AddBackingIndex *IndexAndDataStreamAction `json:"add_backing_index,omitempty"`
	// RemoveBackingIndex Removes a backing index from a data stream.
	// The index is unhidden as part of this operation.
	// A data stream’s write index cannot be removed.
	RemoveBackingIndex *IndexAndDataStreamAction `json:"remove_backing_index,omitempty"`
}

IndicesModifyAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/modify_data_stream/types.ts#L22-L37

func NewIndicesModifyAction added in v8.5.0 

func NewIndicesModifyAction() *IndicesModifyAction

NewIndicesModifyAction returns a IndicesModifyAction.

type IndicesOptions 

type IndicesOptions struct {
	// AllowNoIndices If false, the request returns an error if any wildcard expression, index
	// alias, or `_all` value targets only
	// missing or closed indices. This behavior applies even if the request targets
	// other open indices. For example,
	// a request targeting `foo*,bar*` returns an error if an index starts with
	// `foo` but no index starts with `bar`.
	AllowNoIndices *bool `json:"allow_no_indices,omitempty"`
	// ExpandWildcards Type of index that wildcard patterns can match. If the request can target
	// data streams, this argument
	// determines whether wildcard expressions match hidden data streams. Supports
	// comma-separated values,
	// such as `open,hidden`.
	ExpandWildcards []expandwildcard.ExpandWildcard `json:"expand_wildcards,omitempty"`
	// IgnoreThrottled If true, concrete, expanded or aliased indices are ignored when frozen.
	IgnoreThrottled *bool `json:"ignore_throttled,omitempty"`
	// IgnoreUnavailable If true, missing or closed indices are not included in the response.
	IgnoreUnavailable *bool `json:"ignore_unavailable,omitempty"`
}

IndicesOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L339-L366

func NewIndicesOptions added in v8.5.0 

func NewIndicesOptions() *IndicesOptions

NewIndicesOptions returns a IndicesOptions.

func (*IndicesOptions) UnmarshalJSON added in v8.7.1 

func (s *IndicesOptions) UnmarshalJSON(data []byte) error

type IndicesPrivileges 

type IndicesPrivileges struct {
	// AllowRestrictedIndices Set to `true` if using wildcard or regular expressions for patterns that
	// cover restricted indices. Implicitly, restricted indices have limited
	// privileges that can cause pattern tests to fail. If restricted indices are
	// explicitly included in the `names` list, Elasticsearch checks privileges
	// against these indices regardless of the value set for
	// `allow_restricted_indices`.
	AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
	// FieldSecurity The document fields that the owners of the role have read access to.
	FieldSecurity *FieldSecurity `json:"field_security,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
	// Privileges The index level privileges that owners of the role have on the specified
	// indices.
	Privileges []indexprivilege.IndexPrivilege `json:"privileges"`
	// Query A search query that defines the documents the owners of the role have access
	// to. A document within the specified indices must match this query for it to
	// be accessible by the owners of the role.
	Query IndicesPrivilegesQuery `json:"query,omitempty"`
}

IndicesPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L216-L242

func NewIndicesPrivileges added in v8.5.0 

func NewIndicesPrivileges() *IndicesPrivileges

NewIndicesPrivileges returns a IndicesPrivileges.

func (*IndicesPrivileges) UnmarshalJSON added in v8.7.1 

func (s *IndicesPrivileges) UnmarshalJSON(data []byte) error

type IndicesPrivilegesQuery 

type IndicesPrivilegesQuery any

IndicesPrivilegesQuery holds the union for the following types: 

string
Query
RoleTemplateQuery

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L341-L349

type IndicesRecord 

type IndicesRecord struct {
	// BulkAvgSizeInBytes average size in bytes of shard bulk
	BulkAvgSizeInBytes *string `json:"bulk.avg_size_in_bytes,omitempty"`
	// BulkAvgTime average time spend in shard bulk
	BulkAvgTime *string `json:"bulk.avg_time,omitempty"`
	// BulkTotalOperations number of bulk shard ops
	BulkTotalOperations *string `json:"bulk.total_operations,omitempty"`
	// BulkTotalSizeInBytes total size in bytes of shard bulk
	BulkTotalSizeInBytes *string `json:"bulk.total_size_in_bytes,omitempty"`
	// BulkTotalTime time spend in shard bulk
	BulkTotalTime *string `json:"bulk.total_time,omitempty"`
	// CompletionSize size of completion
	CompletionSize *string `json:"completion.size,omitempty"`
	// CreationDate index creation date (millisecond value)
	CreationDate *string `json:"creation.date,omitempty"`
	// CreationDateString index creation date (as string)
	CreationDateString *string `json:"creation.date.string,omitempty"`
	// DatasetSize total size of dataset (including the cache for partially mounted indices)
	DatasetSize *string `json:"dataset.size,omitempty"`
	// DocsCount available docs
	DocsCount *string `json:"docs.count,omitempty"`
	// DocsDeleted deleted docs
	DocsDeleted *string `json:"docs.deleted,omitempty"`
	// FielddataEvictions fielddata evictions
	FielddataEvictions *string `json:"fielddata.evictions,omitempty"`
	// FielddataMemorySize used fielddata cache
	FielddataMemorySize *string `json:"fielddata.memory_size,omitempty"`
	// FlushTotal number of flushes
	FlushTotal *string `json:"flush.total,omitempty"`
	// FlushTotalTime time spent in flush
	FlushTotalTime *string `json:"flush.total_time,omitempty"`
	// GetCurrent number of current get ops
	GetCurrent *string `json:"get.current,omitempty"`
	// GetExistsTime time spent in successful gets
	GetExistsTime *string `json:"get.exists_time,omitempty"`
	// GetExistsTotal number of successful gets
	GetExistsTotal *string `json:"get.exists_total,omitempty"`
	// GetMissingTime time spent in failed gets
	GetMissingTime *string `json:"get.missing_time,omitempty"`
	// GetMissingTotal number of failed gets
	GetMissingTotal *string `json:"get.missing_total,omitempty"`
	// GetTime time spent in get
	GetTime *string `json:"get.time,omitempty"`
	// GetTotal number of get ops
	GetTotal *string `json:"get.total,omitempty"`
	// Health current health status
	Health *string `json:"health,omitempty"`
	// Index index name
	Index *string `json:"index,omitempty"`
	// IndexingDeleteCurrent number of current deletions
	IndexingDeleteCurrent *string `json:"indexing.delete_current,omitempty"`
	// IndexingDeleteTime time spent in deletions
	IndexingDeleteTime *string `json:"indexing.delete_time,omitempty"`
	// IndexingDeleteTotal number of delete ops
	IndexingDeleteTotal *string `json:"indexing.delete_total,omitempty"`
	// IndexingIndexCurrent number of current indexing ops
	IndexingIndexCurrent *string `json:"indexing.index_current,omitempty"`
	// IndexingIndexFailed number of failed indexing ops
	IndexingIndexFailed *string `json:"indexing.index_failed,omitempty"`
	// IndexingIndexTime time spent in indexing
	IndexingIndexTime *string `json:"indexing.index_time,omitempty"`
	// IndexingIndexTotal number of indexing ops
	IndexingIndexTotal *string `json:"indexing.index_total,omitempty"`
	// MemoryTotal total used memory
	MemoryTotal *string `json:"memory.total,omitempty"`
	// MergesCurrent number of current merges
	MergesCurrent *string `json:"merges.current,omitempty"`
	// MergesCurrentDocs number of current merging docs
	MergesCurrentDocs *string `json:"merges.current_docs,omitempty"`
	// MergesCurrentSize size of current merges
	MergesCurrentSize *string `json:"merges.current_size,omitempty"`
	// MergesTotal number of completed merge ops
	MergesTotal *string `json:"merges.total,omitempty"`
	// MergesTotalDocs docs merged
	MergesTotalDocs *string `json:"merges.total_docs,omitempty"`
	// MergesTotalSize size merged
	MergesTotalSize *string `json:"merges.total_size,omitempty"`
	// MergesTotalTime time spent in merges
	MergesTotalTime *string `json:"merges.total_time,omitempty"`
	// Pri number of primary shards
	Pri *string `json:"pri,omitempty"`
	// PriBulkAvgSizeInBytes average size in bytes of shard bulk
	PriBulkAvgSizeInBytes *string `json:"pri.bulk.avg_size_in_bytes,omitempty"`
	// PriBulkAvgTime average time spend in shard bulk
	PriBulkAvgTime *string `json:"pri.bulk.avg_time,omitempty"`
	// PriBulkTotalOperations number of bulk shard ops
	PriBulkTotalOperations *string `json:"pri.bulk.total_operations,omitempty"`
	// PriBulkTotalSizeInBytes total size in bytes of shard bulk
	PriBulkTotalSizeInBytes *string `json:"pri.bulk.total_size_in_bytes,omitempty"`
	// PriBulkTotalTime time spend in shard bulk
	PriBulkTotalTime *string `json:"pri.bulk.total_time,omitempty"`
	// PriCompletionSize size of completion
	PriCompletionSize *string `json:"pri.completion.size,omitempty"`
	// PriFielddataEvictions fielddata evictions
	PriFielddataEvictions *string `json:"pri.fielddata.evictions,omitempty"`
	// PriFielddataMemorySize used fielddata cache
	PriFielddataMemorySize *string `json:"pri.fielddata.memory_size,omitempty"`
	// PriFlushTotal number of flushes
	PriFlushTotal *string `json:"pri.flush.total,omitempty"`
	// PriFlushTotalTime time spent in flush
	PriFlushTotalTime *string `json:"pri.flush.total_time,omitempty"`
	// PriGetCurrent number of current get ops
	PriGetCurrent *string `json:"pri.get.current,omitempty"`
	// PriGetExistsTime time spent in successful gets
	PriGetExistsTime *string `json:"pri.get.exists_time,omitempty"`
	// PriGetExistsTotal number of successful gets
	PriGetExistsTotal *string `json:"pri.get.exists_total,omitempty"`
	// PriGetMissingTime time spent in failed gets
	PriGetMissingTime *string `json:"pri.get.missing_time,omitempty"`
	// PriGetMissingTotal number of failed gets
	PriGetMissingTotal *string `json:"pri.get.missing_total,omitempty"`
	// PriGetTime time spent in get
	PriGetTime *string `json:"pri.get.time,omitempty"`
	// PriGetTotal number of get ops
	PriGetTotal *string `json:"pri.get.total,omitempty"`
	// PriIndexingDeleteCurrent number of current deletions
	PriIndexingDeleteCurrent *string `json:"pri.indexing.delete_current,omitempty"`
	// PriIndexingDeleteTime time spent in deletions
	PriIndexingDeleteTime *string `json:"pri.indexing.delete_time,omitempty"`
	// PriIndexingDeleteTotal number of delete ops
	PriIndexingDeleteTotal *string `json:"pri.indexing.delete_total,omitempty"`
	// PriIndexingIndexCurrent number of current indexing ops
	PriIndexingIndexCurrent *string `json:"pri.indexing.index_current,omitempty"`
	// PriIndexingIndexFailed number of failed indexing ops
	PriIndexingIndexFailed *string `json:"pri.indexing.index_failed,omitempty"`
	// PriIndexingIndexTime time spent in indexing
	PriIndexingIndexTime *string `json:"pri.indexing.index_time,omitempty"`
	// PriIndexingIndexTotal number of indexing ops
	PriIndexingIndexTotal *string `json:"pri.indexing.index_total,omitempty"`
	// PriMemoryTotal total user memory
	PriMemoryTotal *string `json:"pri.memory.total,omitempty"`
	// PriMergesCurrent number of current merges
	PriMergesCurrent *string `json:"pri.merges.current,omitempty"`
	// PriMergesCurrentDocs number of current merging docs
	PriMergesCurrentDocs *string `json:"pri.merges.current_docs,omitempty"`
	// PriMergesCurrentSize size of current merges
	PriMergesCurrentSize *string `json:"pri.merges.current_size,omitempty"`
	// PriMergesTotal number of completed merge ops
	PriMergesTotal *string `json:"pri.merges.total,omitempty"`
	// PriMergesTotalDocs docs merged
	PriMergesTotalDocs *string `json:"pri.merges.total_docs,omitempty"`
	// PriMergesTotalSize size merged
	PriMergesTotalSize *string `json:"pri.merges.total_size,omitempty"`
	// PriMergesTotalTime time spent in merges
	PriMergesTotalTime *string `json:"pri.merges.total_time,omitempty"`
	// PriQueryCacheEvictions query cache evictions
	PriQueryCacheEvictions *string `json:"pri.query_cache.evictions,omitempty"`
	// PriQueryCacheMemorySize used query cache
	PriQueryCacheMemorySize *string `json:"pri.query_cache.memory_size,omitempty"`
	// PriRefreshExternalTime time spent in external refreshes
	PriRefreshExternalTime *string `json:"pri.refresh.external_time,omitempty"`
	// PriRefreshExternalTotal total external refreshes
	PriRefreshExternalTotal *string `json:"pri.refresh.external_total,omitempty"`
	// PriRefreshListeners number of pending refresh listeners
	PriRefreshListeners *string `json:"pri.refresh.listeners,omitempty"`
	// PriRefreshTime time spent in refreshes
	PriRefreshTime *string `json:"pri.refresh.time,omitempty"`
	// PriRefreshTotal total refreshes
	PriRefreshTotal *string `json:"pri.refresh.total,omitempty"`
	// PriRequestCacheEvictions request cache evictions
	PriRequestCacheEvictions *string `json:"pri.request_cache.evictions,omitempty"`
	// PriRequestCacheHitCount request cache hit count
	PriRequestCacheHitCount *string `json:"pri.request_cache.hit_count,omitempty"`
	// PriRequestCacheMemorySize used request cache
	PriRequestCacheMemorySize *string `json:"pri.request_cache.memory_size,omitempty"`
	// PriRequestCacheMissCount request cache miss count
	PriRequestCacheMissCount *string `json:"pri.request_cache.miss_count,omitempty"`
	// PriSearchFetchCurrent current fetch phase ops
	PriSearchFetchCurrent *string `json:"pri.search.fetch_current,omitempty"`
	// PriSearchFetchTime time spent in fetch phase
	PriSearchFetchTime *string `json:"pri.search.fetch_time,omitempty"`
	// PriSearchFetchTotal total fetch ops
	PriSearchFetchTotal *string `json:"pri.search.fetch_total,omitempty"`
	// PriSearchOpenContexts open search contexts
	PriSearchOpenContexts *string `json:"pri.search.open_contexts,omitempty"`
	// PriSearchQueryCurrent current query phase ops
	PriSearchQueryCurrent *string `json:"pri.search.query_current,omitempty"`
	// PriSearchQueryTime time spent in query phase
	PriSearchQueryTime *string `json:"pri.search.query_time,omitempty"`
	// PriSearchQueryTotal total query phase ops
	PriSearchQueryTotal *string `json:"pri.search.query_total,omitempty"`
	// PriSearchScrollCurrent open scroll contexts
	PriSearchScrollCurrent *string `json:"pri.search.scroll_current,omitempty"`
	// PriSearchScrollTime time scroll contexts held open
	PriSearchScrollTime *string `json:"pri.search.scroll_time,omitempty"`
	// PriSearchScrollTotal completed scroll contexts
	PriSearchScrollTotal *string `json:"pri.search.scroll_total,omitempty"`
	// PriSegmentsCount number of segments
	PriSegmentsCount *string `json:"pri.segments.count,omitempty"`
	// PriSegmentsFixedBitsetMemory memory used by fixed bit sets for nested object field types and export type
	// filters for types referred in _parent fields
	PriSegmentsFixedBitsetMemory *string `json:"pri.segments.fixed_bitset_memory,omitempty"`
	// PriSegmentsIndexWriterMemory memory used by index writer
	PriSegmentsIndexWriterMemory *string `json:"pri.segments.index_writer_memory,omitempty"`
	// PriSegmentsMemory memory used by segments
	PriSegmentsMemory *string `json:"pri.segments.memory,omitempty"`
	// PriSegmentsVersionMapMemory memory used by version map
	PriSegmentsVersionMapMemory *string `json:"pri.segments.version_map_memory,omitempty"`
	// PriStoreSize store size of primaries
	PriStoreSize *string `json:"pri.store.size,omitempty"`
	// PriSuggestCurrent number of current suggest ops
	PriSuggestCurrent *string `json:"pri.suggest.current,omitempty"`
	// PriSuggestTime time spend in suggest
	PriSuggestTime *string `json:"pri.suggest.time,omitempty"`
	// PriSuggestTotal number of suggest ops
	PriSuggestTotal *string `json:"pri.suggest.total,omitempty"`
	// PriWarmerCurrent current warmer ops
	PriWarmerCurrent *string `json:"pri.warmer.current,omitempty"`
	// PriWarmerTotal total warmer ops
	PriWarmerTotal *string `json:"pri.warmer.total,omitempty"`
	// PriWarmerTotalTime time spent in warmers
	PriWarmerTotalTime *string `json:"pri.warmer.total_time,omitempty"`
	// QueryCacheEvictions query cache evictions
	QueryCacheEvictions *string `json:"query_cache.evictions,omitempty"`
	// QueryCacheMemorySize used query cache
	QueryCacheMemorySize *string `json:"query_cache.memory_size,omitempty"`
	// RefreshExternalTime time spent in external refreshes
	RefreshExternalTime *string `json:"refresh.external_time,omitempty"`
	// RefreshExternalTotal total external refreshes
	RefreshExternalTotal *string `json:"refresh.external_total,omitempty"`
	// RefreshListeners number of pending refresh listeners
	RefreshListeners *string `json:"refresh.listeners,omitempty"`
	// RefreshTime time spent in refreshes
	RefreshTime *string `json:"refresh.time,omitempty"`
	// RefreshTotal total refreshes
	RefreshTotal *string `json:"refresh.total,omitempty"`
	// Rep number of replica shards
	Rep *string `json:"rep,omitempty"`
	// RequestCacheEvictions request cache evictions
	RequestCacheEvictions *string `json:"request_cache.evictions,omitempty"`
	// RequestCacheHitCount request cache hit count
	RequestCacheHitCount *string `json:"request_cache.hit_count,omitempty"`
	// RequestCacheMemorySize used request cache
	RequestCacheMemorySize *string `json:"request_cache.memory_size,omitempty"`
	// RequestCacheMissCount request cache miss count
	RequestCacheMissCount *string `json:"request_cache.miss_count,omitempty"`
	// SearchFetchCurrent current fetch phase ops
	SearchFetchCurrent *string `json:"search.fetch_current,omitempty"`
	// SearchFetchTime time spent in fetch phase
	SearchFetchTime *string `json:"search.fetch_time,omitempty"`
	// SearchFetchTotal total fetch ops
	SearchFetchTotal *string `json:"search.fetch_total,omitempty"`
	// SearchOpenContexts open search contexts
	SearchOpenContexts *string `json:"search.open_contexts,omitempty"`
	// SearchQueryCurrent current query phase ops
	SearchQueryCurrent *string `json:"search.query_current,omitempty"`
	// SearchQueryTime time spent in query phase
	SearchQueryTime *string `json:"search.query_time,omitempty"`
	// SearchQueryTotal total query phase ops
	SearchQueryTotal *string `json:"search.query_total,omitempty"`
	// SearchScrollCurrent open scroll contexts
	SearchScrollCurrent *string `json:"search.scroll_current,omitempty"`
	// SearchScrollTime time scroll contexts held open
	SearchScrollTime *string `json:"search.scroll_time,omitempty"`
	// SearchScrollTotal completed scroll contexts
	SearchScrollTotal *string `json:"search.scroll_total,omitempty"`
	// SearchThrottled indicates if the index is search throttled
	SearchThrottled *string `json:"search.throttled,omitempty"`
	// SegmentsCount number of segments
	SegmentsCount *string `json:"segments.count,omitempty"`
	// SegmentsFixedBitsetMemory memory used by fixed bit sets for nested object field types and export type
	// filters for types referred in _parent fields
	SegmentsFixedBitsetMemory *string `json:"segments.fixed_bitset_memory,omitempty"`
	// SegmentsIndexWriterMemory memory used by index writer
	SegmentsIndexWriterMemory *string `json:"segments.index_writer_memory,omitempty"`
	// SegmentsMemory memory used by segments
	SegmentsMemory *string `json:"segments.memory,omitempty"`
	// SegmentsVersionMapMemory memory used by version map
	SegmentsVersionMapMemory *string `json:"segments.version_map_memory,omitempty"`
	// Status open/close status
	Status *string `json:"status,omitempty"`
	// StoreSize store size of primaries & replicas
	StoreSize *string `json:"store.size,omitempty"`
	// SuggestCurrent number of current suggest ops
	SuggestCurrent *string `json:"suggest.current,omitempty"`
	// SuggestTime time spend in suggest
	SuggestTime *string `json:"suggest.time,omitempty"`
	// SuggestTotal number of suggest ops
	SuggestTotal *string `json:"suggest.total,omitempty"`
	// Uuid index uuid
	Uuid *string `json:"uuid,omitempty"`
	// WarmerCurrent current warmer ops
	WarmerCurrent *string `json:"warmer.current,omitempty"`
	// WarmerTotal total warmer ops
	WarmerTotal *string `json:"warmer.total,omitempty"`
	// WarmerTotalTime time spent in warmers
	WarmerTotalTime *string `json:"warmer.total_time,omitempty"`
}

IndicesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/indices/types.ts#L20-L808

func NewIndicesRecord added in v8.5.0 

func NewIndicesRecord() *IndicesRecord

NewIndicesRecord returns a IndicesRecord.

func (*IndicesRecord) UnmarshalJSON added in v8.7.1 

func (s *IndicesRecord) UnmarshalJSON(data []byte) error

type IndicesShardStats added in v8.5.0 

type IndicesShardStats struct {
	Bulk            *BulkStats                 `json:"bulk,omitempty"`
	Commit          *ShardCommit               `json:"commit,omitempty"`
	Completion      *CompletionStats           `json:"completion,omitempty"`
	Docs            *DocStats                  `json:"docs,omitempty"`
	Fielddata       *FielddataStats            `json:"fielddata,omitempty"`
	Flush           *FlushStats                `json:"flush,omitempty"`
	Get             *GetStats                  `json:"get,omitempty"`
	Indexing        *IndexingStats             `json:"indexing,omitempty"`
	Indices         *IndicesStats              `json:"indices,omitempty"`
	Mappings        *MappingStats              `json:"mappings,omitempty"`
	Merges          *MergesStats               `json:"merges,omitempty"`
	QueryCache      *ShardQueryCache           `json:"query_cache,omitempty"`
	Recovery        *RecoveryStats             `json:"recovery,omitempty"`
	Refresh         *RefreshStats              `json:"refresh,omitempty"`
	RequestCache    *RequestCacheStats         `json:"request_cache,omitempty"`
	RetentionLeases *ShardRetentionLeases      `json:"retention_leases,omitempty"`
	Routing         *ShardRouting              `json:"routing,omitempty"`
	Search          *SearchStats               `json:"search,omitempty"`
	Segments        *SegmentsStats             `json:"segments,omitempty"`
	SeqNo           *ShardSequenceNumber       `json:"seq_no,omitempty"`
	ShardPath       *ShardPath                 `json:"shard_path,omitempty"`
	ShardStats      *ShardsTotalStats          `json:"shard_stats,omitempty"`
	Shards          map[string]json.RawMessage `json:"shards,omitempty"`
	Store           *StoreStats                `json:"store,omitempty"`
	Translog        *TranslogStats             `json:"translog,omitempty"`
	Warmer          *WarmerStats               `json:"warmer,omitempty"`
}

IndicesShardStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L192-L223

func NewIndicesShardStats added in v8.5.0 

func NewIndicesShardStats() *IndicesShardStats

NewIndicesShardStats returns a IndicesShardStats.

type IndicesShardStores 

type IndicesShardStores struct {
	Shards map[string]ShardStoreWrapper `json:"shards"`
}

IndicesShardStores type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/shard_stores/types.ts#L25-L27

func NewIndicesShardStores added in v8.5.0 

func NewIndicesShardStores() *IndicesShardStores

NewIndicesShardStores returns a IndicesShardStores.

type IndicesShardsStats added in v8.5.0 

type IndicesShardsStats struct {
	AllFields FieldSummary            `json:"all_fields"`
	Fields    map[string]FieldSummary `json:"fields"`
}

IndicesShardsStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L52-L55

func NewIndicesShardsStats added in v8.5.0 

func NewIndicesShardsStats() *IndicesShardsStats

NewIndicesShardsStats returns a IndicesShardsStats.

type IndicesStats 

type IndicesStats struct {
	Health    *healthstatus.HealthStatus             `json:"health,omitempty"`
	Primaries *IndexStats                            `json:"primaries,omitempty"`
	Shards    map[string][]IndicesShardStats         `json:"shards,omitempty"`
	Status    *indexmetadatastate.IndexMetadataState `json:"status,omitempty"`
	Total     *IndexStats                            `json:"total,omitempty"`
	Uuid      *string                                `json:"uuid,omitempty"`
}

IndicesStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L95-L110

func NewIndicesStats added in v8.5.0 

func NewIndicesStats() *IndicesStats

NewIndicesStats returns a IndicesStats.

func (*IndicesStats) UnmarshalJSON added in v8.7.1 

func (s *IndicesStats) UnmarshalJSON(data []byte) error

type IndicesValidationExplanation 

type IndicesValidationExplanation struct {
	Error       *string `json:"error,omitempty"`
	Explanation *string `json:"explanation,omitempty"`
	Index       string  `json:"index"`
	Valid       bool    `json:"valid"`
}

IndicesValidationExplanation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/validate_query/IndicesValidateQueryResponse.ts#L32-L37

func NewIndicesValidationExplanation added in v8.5.0 

func NewIndicesValidationExplanation() *IndicesValidationExplanation

NewIndicesValidationExplanation returns a IndicesValidationExplanation.

func (*IndicesValidationExplanation) UnmarshalJSON added in v8.7.1 

func (s *IndicesValidationExplanation) UnmarshalJSON(data []byte) error

type IndicesVersions 

type IndicesVersions struct {
	IndexCount        int    `json:"index_count"`
	PrimaryShardCount int    `json:"primary_shard_count"`
	TotalPrimaryBytes int64  `json:"total_primary_bytes"`
	Version           string `json:"version"`
}

IndicesVersions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L263-L268

func NewIndicesVersions added in v8.5.0 

func NewIndicesVersions() *IndicesVersions

NewIndicesVersions returns a IndicesVersions.

func (*IndicesVersions) UnmarshalJSON added in v8.7.1 

func (s *IndicesVersions) UnmarshalJSON(data []byte) error

type IndonesianAnalyzer added in v8.16.0 

type IndonesianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

IndonesianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L193-L198

func NewIndonesianAnalyzer added in v8.16.0 

func NewIndonesianAnalyzer() *IndonesianAnalyzer

NewIndonesianAnalyzer returns a IndonesianAnalyzer.

func (IndonesianAnalyzer) MarshalJSON added in v8.16.0 

func (s IndonesianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IndonesianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *IndonesianAnalyzer) UnmarshalJSON(data []byte) error

type InferenceAggregate 

type InferenceAggregate struct {
	Data              map[string]json.RawMessage   `json:"-"`
	FeatureImportance []InferenceFeatureImportance `json:"feature_importance,omitempty"`
	Meta              Metadata                     `json:"meta,omitempty"`
	TopClasses        []InferenceTopClassEntry     `json:"top_classes,omitempty"`
	Value             FieldValue                   `json:"value,omitempty"`
	Warning           *string                      `json:"warning,omitempty"`
}

InferenceAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L755-L770

func NewInferenceAggregate added in v8.5.0 

func NewInferenceAggregate() *InferenceAggregate

NewInferenceAggregate returns a InferenceAggregate.

func (InferenceAggregate) MarshalJSON 

func (s InferenceAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*InferenceAggregate) UnmarshalJSON added in v8.7.1 

func (s *InferenceAggregate) UnmarshalJSON(data []byte) error

type InferenceAggregation 

type InferenceAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// InferenceConfig Contains the inference type and its options.
	InferenceConfig *InferenceConfigContainer `json:"inference_config,omitempty"`
	// ModelId The ID or alias for the trained model.
	ModelId string `json:"model_id"`
}

InferenceAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L225-L234

func NewInferenceAggregation added in v8.5.0 

func NewInferenceAggregation() *InferenceAggregation

NewInferenceAggregation returns a InferenceAggregation.

func (*InferenceAggregation) UnmarshalJSON added in v8.7.0 

func (s *InferenceAggregation) UnmarshalJSON(data []byte) error

type InferenceChunkingSettings added in v8.18.0 

type InferenceChunkingSettings struct {
	// MaxChunkSize The maximum size of a chunk in words.
	// This value cannot be higher than `300` or lower than `20` (for `sentence`
	// strategy) or `10` (for `word` strategy).
	MaxChunkSize *int `json:"max_chunk_size,omitempty"`
	// Overlap The number of overlapping words for chunks.
	// It is applicable only to a `word` chunking strategy.
	// This value cannot be higher than half the `max_chunk_size` value.
	Overlap *int `json:"overlap,omitempty"`
	// SentenceOverlap The number of overlapping sentences for chunks.
	// It is applicable only for a `sentence` chunking strategy.
	// It can be either `1` or `0`.
	SentenceOverlap *int `json:"sentence_overlap,omitempty"`
	// Strategy The chunking strategy: `sentence` or `word`.
	Strategy *string `json:"strategy,omitempty"`
}

InferenceChunkingSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L254-L283

func NewInferenceChunkingSettings added in v8.18.0 

func NewInferenceChunkingSettings() *InferenceChunkingSettings

NewInferenceChunkingSettings returns a InferenceChunkingSettings.

func (*InferenceChunkingSettings) UnmarshalJSON added in v8.18.0 

func (s *InferenceChunkingSettings) UnmarshalJSON(data []byte) error

type InferenceClassImportance 

type InferenceClassImportance struct {
	ClassName  string  `json:"class_name"`
	Importance Float64 `json:"importance"`
}

InferenceClassImportance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L784-L787

func NewInferenceClassImportance added in v8.5.0 

func NewInferenceClassImportance() *InferenceClassImportance

NewInferenceClassImportance returns a InferenceClassImportance.

func (*InferenceClassImportance) UnmarshalJSON added in v8.7.1 

func (s *InferenceClassImportance) UnmarshalJSON(data []byte) error

type InferenceConfig 

type InferenceConfig struct {
	// Classification Classification configuration for inference.
	Classification *InferenceConfigClassification `json:"classification,omitempty"`
	// Regression Regression configuration for inference.
	Regression *InferenceConfigRegression `json:"regression,omitempty"`
}

InferenceConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1066-L1078

func NewInferenceConfig added in v8.5.0 

func NewInferenceConfig() *InferenceConfig

NewInferenceConfig returns a InferenceConfig.

type InferenceConfigClassification 

type InferenceConfigClassification struct {
	// NumTopClasses Specifies the number of top class predictions to return.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// NumTopFeatureImportanceValues Specifies the maximum number of feature importance values per document.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// PredictionFieldType Specifies the type of the predicted field to write.
	// Valid values are: `string`, `number`, `boolean`.
	PredictionFieldType *string `json:"prediction_field_type,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction.
	ResultsField *string `json:"results_field,omitempty"`
	// TopClassesResultsField Specifies the field to which the top classes are written.
	TopClassesResultsField *string `json:"top_classes_results_field,omitempty"`
}

InferenceConfigClassification type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1093-L1119

func NewInferenceConfigClassification added in v8.5.0 

func NewInferenceConfigClassification() *InferenceConfigClassification

NewInferenceConfigClassification returns a InferenceConfigClassification.

func (*InferenceConfigClassification) UnmarshalJSON added in v8.7.1 

func (s *InferenceConfigClassification) UnmarshalJSON(data []byte) error

type InferenceConfigContainer 

type InferenceConfigContainer struct {
	// Classification Classification configuration for inference.
	Classification *ClassificationInferenceOptions `json:"classification,omitempty"`
	// Regression Regression configuration for inference.
	Regression *RegressionInferenceOptions `json:"regression,omitempty"`
}

InferenceConfigContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L236-L242

func NewInferenceConfigContainer added in v8.5.0 

func NewInferenceConfigContainer() *InferenceConfigContainer

NewInferenceConfigContainer returns a InferenceConfigContainer.

type InferenceConfigCreateContainer 

type InferenceConfigCreateContainer struct {
	// Classification Classification configuration for inference.
	Classification *ClassificationInferenceOptions `json:"classification,omitempty"`
	// FillMask Fill mask configuration for inference.
	FillMask       *FillMaskInferenceOptions `json:"fill_mask,omitempty"`
	LearningToRank *LearningToRankConfig     `json:"learning_to_rank,omitempty"`
	// Ner Named entity recognition configuration for inference.
	Ner *NerInferenceOptions `json:"ner,omitempty"`
	// PassThrough Pass through configuration for inference.
	PassThrough *PassThroughInferenceOptions `json:"pass_through,omitempty"`
	// QuestionAnswering Question answering configuration for inference.
	QuestionAnswering *QuestionAnsweringInferenceOptions `json:"question_answering,omitempty"`
	// Regression Regression configuration for inference.
	Regression *RegressionInferenceOptions `json:"regression,omitempty"`
	// TextClassification Text classification configuration for inference.
	TextClassification *TextClassificationInferenceOptions `json:"text_classification,omitempty"`
	// TextEmbedding Text embedding configuration for inference.
	TextEmbedding *TextEmbeddingInferenceOptions `json:"text_embedding,omitempty"`
	// TextExpansion Text expansion configuration for inference.
	TextExpansion *TextExpansionInferenceOptions `json:"text_expansion,omitempty"`
	// ZeroShotClassification Zeroshot classification configuration for inference.
	ZeroShotClassification *ZeroShotClassificationInferenceOptions `json:"zero_shot_classification,omitempty"`
}

InferenceConfigCreateContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L26-L85

func NewInferenceConfigCreateContainer added in v8.5.0 

func NewInferenceConfigCreateContainer() *InferenceConfigCreateContainer

NewInferenceConfigCreateContainer returns a InferenceConfigCreateContainer.

type InferenceConfigRegression 

type InferenceConfigRegression struct {
	// NumTopFeatureImportanceValues Specifies the maximum number of feature importance values per document.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction.
	ResultsField *string `json:"results_field,omitempty"`
}

InferenceConfigRegression type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1080-L1091

func NewInferenceConfigRegression added in v8.5.0 

func NewInferenceConfigRegression() *InferenceConfigRegression

NewInferenceConfigRegression returns a InferenceConfigRegression.

func (*InferenceConfigRegression) UnmarshalJSON added in v8.7.1 

func (s *InferenceConfigRegression) UnmarshalJSON(data []byte) error

type InferenceConfigUpdateContainer 

type InferenceConfigUpdateContainer struct {
	// Classification Classification configuration for inference.
	Classification *ClassificationInferenceOptions `json:"classification,omitempty"`
	// FillMask Fill mask configuration for inference.
	FillMask *FillMaskInferenceUpdateOptions `json:"fill_mask,omitempty"`
	// Ner Named entity recognition configuration for inference.
	Ner *NerInferenceUpdateOptions `json:"ner,omitempty"`
	// PassThrough Pass through configuration for inference.
	PassThrough *PassThroughInferenceUpdateOptions `json:"pass_through,omitempty"`
	// QuestionAnswering Question answering configuration for inference
	QuestionAnswering *QuestionAnsweringInferenceUpdateOptions `json:"question_answering,omitempty"`
	// Regression Regression configuration for inference.
	Regression *RegressionInferenceOptions `json:"regression,omitempty"`
	// TextClassification Text classification configuration for inference.
	TextClassification *TextClassificationInferenceUpdateOptions `json:"text_classification,omitempty"`
	// TextEmbedding Text embedding configuration for inference.
	TextEmbedding *TextEmbeddingInferenceUpdateOptions `json:"text_embedding,omitempty"`
	// TextExpansion Text expansion configuration for inference.
	TextExpansion *TextExpansionInferenceUpdateOptions `json:"text_expansion,omitempty"`
	// ZeroShotClassification Zeroshot classification configuration for inference.
	ZeroShotClassification *ZeroShotClassificationInferenceUpdateOptions `json:"zero_shot_classification,omitempty"`
}

InferenceConfigUpdateContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L315-L337

func NewInferenceConfigUpdateContainer added in v8.5.0 

func NewInferenceConfigUpdateContainer() *InferenceConfigUpdateContainer

NewInferenceConfigUpdateContainer returns a InferenceConfigUpdateContainer.

type InferenceEndpoint added in v8.15.0 

type InferenceEndpoint struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
}

InferenceEndpoint type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L42-L62

func NewInferenceEndpoint added in v8.15.0 

func NewInferenceEndpoint() *InferenceEndpoint

NewInferenceEndpoint returns a InferenceEndpoint.

func (*InferenceEndpoint) UnmarshalJSON added in v8.15.0 

func (s *InferenceEndpoint) UnmarshalJSON(data []byte) error

type InferenceEndpointInfo added in v8.15.0 

type InferenceEndpointInfo struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktype.TaskType `json:"task_type"`
}

InferenceEndpointInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L64-L76

func NewInferenceEndpointInfo added in v8.15.0 

func NewInferenceEndpointInfo() *InferenceEndpointInfo

NewInferenceEndpointInfo returns a InferenceEndpointInfo.

func (*InferenceEndpointInfo) UnmarshalJSON added in v8.15.0 

func (s *InferenceEndpointInfo) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoAlibabaCloudAI added in v8.18.1 

type InferenceEndpointInfoAlibabaCloudAI struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypealibabacloudai.TaskTypeAlibabaCloudAI `json:"task_type"`
}

InferenceEndpointInfoAlibabaCloudAI type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L89-L98

func NewInferenceEndpointInfoAlibabaCloudAI added in v8.18.1 

func NewInferenceEndpointInfoAlibabaCloudAI() *InferenceEndpointInfoAlibabaCloudAI

NewInferenceEndpointInfoAlibabaCloudAI returns a InferenceEndpointInfoAlibabaCloudAI.

func (*InferenceEndpointInfoAlibabaCloudAI) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoAlibabaCloudAI) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoAmazonBedrock added in v8.18.1 

type InferenceEndpointInfoAmazonBedrock struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeamazonbedrock.TaskTypeAmazonBedrock `json:"task_type"`
}

InferenceEndpointInfoAmazonBedrock type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L100-L109

func NewInferenceEndpointInfoAmazonBedrock added in v8.18.1 

func NewInferenceEndpointInfoAmazonBedrock() *InferenceEndpointInfoAmazonBedrock

NewInferenceEndpointInfoAmazonBedrock returns a InferenceEndpointInfoAmazonBedrock.

func (*InferenceEndpointInfoAmazonBedrock) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoAmazonBedrock) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoAnthropic added in v8.18.1 

type InferenceEndpointInfoAnthropic struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeanthropic.TaskTypeAnthropic `json:"task_type"`
}

InferenceEndpointInfoAnthropic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L111-L120

func NewInferenceEndpointInfoAnthropic added in v8.18.1 

func NewInferenceEndpointInfoAnthropic() *InferenceEndpointInfoAnthropic

NewInferenceEndpointInfoAnthropic returns a InferenceEndpointInfoAnthropic.

func (*InferenceEndpointInfoAnthropic) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoAnthropic) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoAzureAIStudio added in v8.18.1 

type InferenceEndpointInfoAzureAIStudio struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeazureaistudio.TaskTypeAzureAIStudio `json:"task_type"`
}

InferenceEndpointInfoAzureAIStudio type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L122-L131

func NewInferenceEndpointInfoAzureAIStudio added in v8.18.1 

func NewInferenceEndpointInfoAzureAIStudio() *InferenceEndpointInfoAzureAIStudio

NewInferenceEndpointInfoAzureAIStudio returns a InferenceEndpointInfoAzureAIStudio.

func (*InferenceEndpointInfoAzureAIStudio) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoAzureAIStudio) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoAzureOpenAI added in v8.18.1 

type InferenceEndpointInfoAzureOpenAI struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeazureopenai.TaskTypeAzureOpenAI `json:"task_type"`
}

InferenceEndpointInfoAzureOpenAI type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L133-L142

func NewInferenceEndpointInfoAzureOpenAI added in v8.18.1 

func NewInferenceEndpointInfoAzureOpenAI() *InferenceEndpointInfoAzureOpenAI

NewInferenceEndpointInfoAzureOpenAI returns a InferenceEndpointInfoAzureOpenAI.

func (*InferenceEndpointInfoAzureOpenAI) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoAzureOpenAI) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoCohere added in v8.18.1 

type InferenceEndpointInfoCohere struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypecohere.TaskTypeCohere `json:"task_type"`
}

InferenceEndpointInfoCohere type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L144-L153

func NewInferenceEndpointInfoCohere added in v8.18.1 

func NewInferenceEndpointInfoCohere() *InferenceEndpointInfoCohere

NewInferenceEndpointInfoCohere returns a InferenceEndpointInfoCohere.

func (*InferenceEndpointInfoCohere) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoCohere) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoELSER added in v8.18.1 

type InferenceEndpointInfoELSER struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeelser.TaskTypeELSER `json:"task_type"`
}

InferenceEndpointInfoELSER type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L166-L175

func NewInferenceEndpointInfoELSER added in v8.18.1 

func NewInferenceEndpointInfoELSER() *InferenceEndpointInfoELSER

NewInferenceEndpointInfoELSER returns a InferenceEndpointInfoELSER.

func (*InferenceEndpointInfoELSER) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoELSER) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoElasticsearch added in v8.18.1 

type InferenceEndpointInfoElasticsearch struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeelasticsearch.TaskTypeElasticsearch `json:"task_type"`
}

InferenceEndpointInfoElasticsearch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L155-L164

func NewInferenceEndpointInfoElasticsearch added in v8.18.1 

func NewInferenceEndpointInfoElasticsearch() *InferenceEndpointInfoElasticsearch

NewInferenceEndpointInfoElasticsearch returns a InferenceEndpointInfoElasticsearch.

func (*InferenceEndpointInfoElasticsearch) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoElasticsearch) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoGoogleAIStudio added in v8.18.1 

type InferenceEndpointInfoGoogleAIStudio struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypegoogleaistudio.TaskTypeGoogleAIStudio `json:"task_type"`
}

InferenceEndpointInfoGoogleAIStudio type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L177-L186

func NewInferenceEndpointInfoGoogleAIStudio added in v8.18.1 

func NewInferenceEndpointInfoGoogleAIStudio() *InferenceEndpointInfoGoogleAIStudio

NewInferenceEndpointInfoGoogleAIStudio returns a InferenceEndpointInfoGoogleAIStudio.

func (*InferenceEndpointInfoGoogleAIStudio) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoGoogleAIStudio) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoGoogleVertexAI added in v8.18.1 

type InferenceEndpointInfoGoogleVertexAI struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypegooglevertexai.TaskTypeGoogleVertexAI `json:"task_type"`
}

InferenceEndpointInfoGoogleVertexAI type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L188-L197

func NewInferenceEndpointInfoGoogleVertexAI added in v8.18.1 

func NewInferenceEndpointInfoGoogleVertexAI() *InferenceEndpointInfoGoogleVertexAI

NewInferenceEndpointInfoGoogleVertexAI returns a InferenceEndpointInfoGoogleVertexAI.

func (*InferenceEndpointInfoGoogleVertexAI) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoGoogleVertexAI) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoHuggingFace added in v8.18.1 

type InferenceEndpointInfoHuggingFace struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypehuggingface.TaskTypeHuggingFace `json:"task_type"`
}

InferenceEndpointInfoHuggingFace type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L199-L208

func NewInferenceEndpointInfoHuggingFace added in v8.18.1 

func NewInferenceEndpointInfoHuggingFace() *InferenceEndpointInfoHuggingFace

NewInferenceEndpointInfoHuggingFace returns a InferenceEndpointInfoHuggingFace.

func (*InferenceEndpointInfoHuggingFace) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoHuggingFace) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoJinaAi added in v8.18.1 

type InferenceEndpointInfoJinaAi struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypejinaai.TaskTypeJinaAi `json:"task_type"`
}

InferenceEndpointInfoJinaAi type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L78-L87

func NewInferenceEndpointInfoJinaAi added in v8.18.1 

func NewInferenceEndpointInfoJinaAi() *InferenceEndpointInfoJinaAi

NewInferenceEndpointInfoJinaAi returns a InferenceEndpointInfoJinaAi.

func (*InferenceEndpointInfoJinaAi) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoJinaAi) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoMistral added in v8.18.1 

type InferenceEndpointInfoMistral struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypemistral.TaskTypeMistral `json:"task_type"`
}

InferenceEndpointInfoMistral type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L210-L219

func NewInferenceEndpointInfoMistral added in v8.18.1 

func NewInferenceEndpointInfoMistral() *InferenceEndpointInfoMistral

NewInferenceEndpointInfoMistral returns a InferenceEndpointInfoMistral.

func (*InferenceEndpointInfoMistral) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoMistral) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoOpenAI added in v8.18.1 

type InferenceEndpointInfoOpenAI struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypeopenai.TaskTypeOpenAI `json:"task_type"`
}

InferenceEndpointInfoOpenAI type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L221-L230

func NewInferenceEndpointInfoOpenAI added in v8.18.1 

func NewInferenceEndpointInfoOpenAI() *InferenceEndpointInfoOpenAI

NewInferenceEndpointInfoOpenAI returns a InferenceEndpointInfoOpenAI.

func (*InferenceEndpointInfoOpenAI) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoOpenAI) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoVoyageAI added in v8.18.1 

type InferenceEndpointInfoVoyageAI struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypevoyageai.TaskTypeVoyageAI `json:"task_type"`
}

InferenceEndpointInfoVoyageAI type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L232-L241

func NewInferenceEndpointInfoVoyageAI added in v8.18.1 

func NewInferenceEndpointInfoVoyageAI() *InferenceEndpointInfoVoyageAI

NewInferenceEndpointInfoVoyageAI returns a InferenceEndpointInfoVoyageAI.

func (*InferenceEndpointInfoVoyageAI) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoVoyageAI) UnmarshalJSON(data []byte) error

type InferenceEndpointInfoWatsonx added in v8.18.1 

type InferenceEndpointInfoWatsonx struct {
	// ChunkingSettings Chunking configuration object
	ChunkingSettings *InferenceChunkingSettings `json:"chunking_settings,omitempty"`
	// InferenceId The inference Id
	InferenceId string `json:"inference_id"`
	// Service The service type
	Service string `json:"service"`
	// ServiceSettings Settings specific to the service
	ServiceSettings json.RawMessage `json:"service_settings"`
	// TaskSettings Task settings specific to the service and task type
	TaskSettings json.RawMessage `json:"task_settings,omitempty"`
	// TaskType The task type
	TaskType tasktypewatsonx.TaskTypeWatsonx `json:"task_type"`
}

InferenceEndpointInfoWatsonx type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L243-L252

func NewInferenceEndpointInfoWatsonx added in v8.18.1 

func NewInferenceEndpointInfoWatsonx() *InferenceEndpointInfoWatsonx

NewInferenceEndpointInfoWatsonx returns a InferenceEndpointInfoWatsonx.

func (*InferenceEndpointInfoWatsonx) UnmarshalJSON added in v8.18.1 

func (s *InferenceEndpointInfoWatsonx) UnmarshalJSON(data []byte) error

type InferenceFeatureImportance 

type InferenceFeatureImportance struct {
	Classes     []InferenceClassImportance `json:"classes,omitempty"`
	FeatureName string                     `json:"feature_name"`
	Importance  *Float64                   `json:"importance,omitempty"`
}

InferenceFeatureImportance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L778-L782

func NewInferenceFeatureImportance added in v8.5.0 

func NewInferenceFeatureImportance() *InferenceFeatureImportance

NewInferenceFeatureImportance returns a InferenceFeatureImportance.

func (*InferenceFeatureImportance) UnmarshalJSON added in v8.7.1 

func (s *InferenceFeatureImportance) UnmarshalJSON(data []byte) error

type InferenceProcessor 

type InferenceProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// FieldMap Maps the document field names to the known field names of the model.
	// This mapping takes precedence over any default mappings provided in the model
	// configuration.
	FieldMap map[string]json.RawMessage `json:"field_map,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If true and any of the input fields defined in input_ouput are missing
	// then those missing fields are quietly ignored, otherwise a missing field
	// causes a failure.
	// Only applies when using input_output configurations to explicitly list the
	// input fields.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// InferenceConfig Contains the inference type and its options.
	InferenceConfig *InferenceConfig `json:"inference_config,omitempty"`
	// InputOutput Input fields for inference and output (destination) fields for the inference
	// results.
	// This option is incompatible with the target_field and field_map options.
	InputOutput []InputConfig `json:"input_output,omitempty"`
	// ModelId The ID or alias for the trained model, or the ID of the deployment.
	ModelId string `json:"model_id"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Field added to incoming documents to contain results objects.
	TargetField *string `json:"target_field,omitempty"`
}

InferenceProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1027-L1059

func NewInferenceProcessor added in v8.5.0 

func NewInferenceProcessor() *InferenceProcessor

NewInferenceProcessor returns a InferenceProcessor.

func (*InferenceProcessor) UnmarshalJSON added in v8.7.1 

func (s *InferenceProcessor) UnmarshalJSON(data []byte) error

type InferenceResponseResult 

type InferenceResponseResult struct {
	// Entities If the model is trained for named entity recognition (NER) tasks, the
	// response contains the recognized entities.
	Entities []TrainedModelEntities `json:"entities,omitempty"`
	// FeatureImportance The feature importance for the inference results. Relevant only for
	// classification or regression models
	FeatureImportance []TrainedModelInferenceFeatureImportance `json:"feature_importance,omitempty"`
	// IsTruncated Indicates whether the input text was truncated to meet the model's maximum
	// sequence length limit. This property
	// is present only when it is true.
	IsTruncated *bool `json:"is_truncated,omitempty"`
	// PredictedValue If the model is trained for a text classification or zero shot classification
	// task, the response is the
	// predicted class.
	// For named entity recognition (NER) tasks, it contains the annotated text
	// output.
	// For fill mask tasks, it contains the top prediction for replacing the mask
	// token.
	// For text embedding tasks, it contains the raw numerical text embedding
	// values.
	// For regression models, its a numerical value
	// For classification models, it may be an integer, double, boolean or string
	// depending on prediction type
	PredictedValue [][]ScalarValue `json:"predicted_value,omitempty"`
	// PredictedValueSequence For fill mask tasks, the response contains the input text sequence with the
	// mask token replaced by the predicted
	// value.
	// Additionally
	PredictedValueSequence *string `json:"predicted_value_sequence,omitempty"`
	// PredictionProbability Specifies a probability for the predicted value.
	PredictionProbability *Float64 `json:"prediction_probability,omitempty"`
	// PredictionScore Specifies a confidence score for the predicted value.
	PredictionScore *Float64 `json:"prediction_score,omitempty"`
	// TopClasses For fill mask, text classification, and zero shot classification tasks, the
	// response contains a list of top
	// class entries.
	TopClasses []TopClassEntry `json:"top_classes,omitempty"`
	// Warning If the request failed, the response contains the reason for the failure.
	Warning *string `json:"warning,omitempty"`
}

InferenceResponseResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L478-L526

func NewInferenceResponseResult added in v8.5.0 

func NewInferenceResponseResult() *InferenceResponseResult

NewInferenceResponseResult returns a InferenceResponseResult.

func (*InferenceResponseResult) UnmarshalJSON added in v8.7.1 

func (s *InferenceResponseResult) UnmarshalJSON(data []byte) error

type InferenceResult added in v8.12.0 

type InferenceResult struct {
	Completion         []CompletionResult        `json:"completion,omitempty"`
	Rerank             []RankedDocument          `json:"rerank,omitempty"`
	SparseEmbedding    []SparseEmbeddingResult   `json:"sparse_embedding,omitempty"`
	TextEmbedding      []TextEmbeddingResult     `json:"text_embedding,omitempty"`
	TextEmbeddingBits  []TextEmbeddingByteResult `json:"text_embedding_bits,omitempty"`
	TextEmbeddingBytes []TextEmbeddingByteResult `json:"text_embedding_bytes,omitempty"`
}

InferenceResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L116-L127

func NewInferenceResult added in v8.12.0 

func NewInferenceResult() *InferenceResult

NewInferenceResult returns a InferenceResult.

type InferenceTopClassEntry 

type InferenceTopClassEntry struct {
	ClassName        FieldValue `json:"class_name"`
	ClassProbability Float64    `json:"class_probability"`
	ClassScore       Float64    `json:"class_score"`
}

InferenceTopClassEntry type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L772-L776

func NewInferenceTopClassEntry added in v8.5.0 

func NewInferenceTopClassEntry() *InferenceTopClassEntry

NewInferenceTopClassEntry returns a InferenceTopClassEntry.

func (*InferenceTopClassEntry) UnmarshalJSON added in v8.7.1 

func (s *InferenceTopClassEntry) UnmarshalJSON(data []byte) error

type Influence 

type Influence struct {
	InfluencerFieldName   string   `json:"influencer_field_name"`
	InfluencerFieldValues []string `json:"influencer_field_values"`
}

Influence type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Anomaly.ts#L141-L144

func NewInfluence added in v8.5.0 

func NewInfluence() *Influence

NewInfluence returns a Influence.

func (*Influence) UnmarshalJSON added in v8.9.0 

func (s *Influence) UnmarshalJSON(data []byte) error

type Influencer 

type Influencer struct {
	// BucketSpan The length of the bucket in seconds. This value matches the bucket span that
	// is specified in the job.
	BucketSpan int64 `json:"bucket_span"`
	// Foo Additional influencer properties are added, depending on the fields being
	// analyzed. For example, if it’s
	// analyzing `user_name` as an influencer, a field `user_name` is added to the
	// result document. This
	// information enables you to filter the anomaly results more easily.
	Foo *string `json:"foo,omitempty"`
	// InfluencerFieldName The field name of the influencer.
	InfluencerFieldName string `json:"influencer_field_name"`
	// InfluencerFieldValue The entity that influenced, contributed to, or was to blame for the anomaly.
	InfluencerFieldValue string `json:"influencer_field_value"`
	// InfluencerScore A normalized score between 0-100, which is based on the probability of the
	// influencer in this bucket aggregated
	// across detectors. Unlike `initial_influencer_score`, this value is updated by
	// a re-normalization process as new
	// data is analyzed.
	InfluencerScore Float64 `json:"influencer_score"`
	// InitialInfluencerScore A normalized score between 0-100, which is based on the probability of the
	// influencer aggregated across detectors.
	// This is the initial value that was calculated at the time the bucket was
	// processed.
	InitialInfluencerScore Float64 `json:"initial_influencer_score"`
	// IsInterim If true, this is an interim result. In other words, the results are
	// calculated based on partial input data.
	IsInterim bool `json:"is_interim"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// Probability The probability that the influencer has this behavior, in the range 0 to 1.
	// This value can be held to a high
	// precision of over 300 decimal places, so the `influencer_score` is provided
	// as a human-readable and friendly
	// interpretation of this value.
	Probability Float64 `json:"probability"`
	// ResultType Internal. This value is always set to `influencer`.
	ResultType string `json:"result_type"`
	// Timestamp The start time of the bucket for which these results were calculated.
	Timestamp int64 `json:"timestamp"`
}

Influencer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Influencer.ts#L24-L76

func NewInfluencer added in v8.5.0 

func NewInfluencer() *Influencer

NewInfluencer returns a Influencer.

func (*Influencer) UnmarshalJSON added in v8.7.1 

func (s *Influencer) UnmarshalJSON(data []byte) error

type InfoFeatureState 

type InfoFeatureState struct {
	FeatureName string   `json:"feature_name"`
	Indices     []string `json:"indices"`
}

InfoFeatureState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotInfoFeatureState.ts#L22-L25

func NewInfoFeatureState added in v8.5.0 

func NewInfoFeatureState() *InfoFeatureState

NewInfoFeatureState returns a InfoFeatureState.

func (*InfoFeatureState) UnmarshalJSON added in v8.7.1 

func (s *InfoFeatureState) UnmarshalJSON(data []byte) error

type Ingest 

type Ingest struct {
	Pipeline  *string  `json:"pipeline,omitempty"`
	Redact_   *Redact  `json:"_redact,omitempty"`
	Timestamp DateTime `json:"timestamp"`
}

Ingest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L28-L36

func NewIngest added in v8.18.0 

func NewIngest() *Ingest

NewIngest returns a Ingest.

func (*Ingest) UnmarshalJSON added in v8.18.0 

func (s *Ingest) UnmarshalJSON(data []byte) error

type IngestDocumentSimulation added in v8.18.0 

type IngestDocumentSimulation struct {
	// Error Any error resulting from simulatng ingest on this doc. This can be an error
	// generated by
	// executing a processor, or a mapping validation error when simulating indexing
	// the resulting
	// doc.
	Error *ErrorCause `json:"error,omitempty"`
	// ExecutedPipelines A list of the names of the pipelines executed on this document.
	ExecutedPipelines []string `json:"executed_pipelines"`
	// Id_ Identifier for the document.
	Id_ string `json:"_id"`
	// IgnoredFields A list of the fields that would be ignored at the indexing step. For example,
	// a field whose
	// value is larger than the allowed limit would make it through all of the
	// pipelines, but
	// would not be indexed into Elasticsearch.
	IgnoredFields []map[string]string `json:"ignored_fields,omitempty"`
	// Index_ Name of the index that the document would be indexed into if this were not a
	// simulation.
	Index_                   string            `json:"_index"`
	IngestDocumentSimulation map[string]string `json:"-"`
	// Source_ JSON body for the document.
	Source_  map[string]json.RawMessage `json:"_source"`
	Version_ StringifiedVersionNumber   `json:"_version"`
}

IngestDocumentSimulation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/simulate/ingest/SimulateIngestResponse.ts#L35-L78

func NewIngestDocumentSimulation added in v8.18.0 

func NewIngestDocumentSimulation() *IngestDocumentSimulation

NewIngestDocumentSimulation returns a IngestDocumentSimulation.

func (IngestDocumentSimulation) MarshalJSON added in v8.18.0 

func (s IngestDocumentSimulation) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*IngestDocumentSimulation) UnmarshalJSON added in v8.18.0 

func (s *IngestDocumentSimulation) UnmarshalJSON(data []byte) error

type IngestPipeline added in v8.5.0 

type IngestPipeline struct {
	// Deprecated Marks this ingest pipeline as deprecated.
	// When a deprecated ingest pipeline is referenced as the default or final
	// pipeline when creating or updating a non-deprecated index template,
	// Elasticsearch will emit a deprecation warning.
	Deprecated *bool `json:"deprecated,omitempty"`
	// Description Description of the ingest pipeline.
	Description *string `json:"description,omitempty"`
	// Meta_ Arbitrary metadata about the ingest pipeline. This map is not automatically
	// generated by Elasticsearch.
	Meta_ Metadata `json:"_meta,omitempty"`
	// OnFailure Processors to run immediately after a processor failure.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Processors Processors used to perform transformations on documents before indexing.
	// Processors run sequentially in the order specified.
	Processors []ProcessorContainer `json:"processors,omitempty"`
	// Version Version number used by external systems to track ingest pipelines.
	Version *int64 `json:"version,omitempty"`
}

IngestPipeline type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Pipeline.ts#L23-L51

func NewIngestPipeline added in v8.5.0 

func NewIngestPipeline() *IngestPipeline

NewIngestPipeline returns a IngestPipeline.

func (*IngestPipeline) UnmarshalJSON added in v8.7.1 

func (s *IngestPipeline) UnmarshalJSON(data []byte) error

type IngestPipelineParams added in v8.15.0 

type IngestPipelineParams struct {
	ExtractBinaryContent bool   `json:"extract_binary_content"`
	Name                 string `json:"name"`
	ReduceWhitespace     bool   `json:"reduce_whitespace"`
	RunMlInference       bool   `json:"run_ml_inference"`
}

IngestPipelineParams type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L148-L153

func NewIngestPipelineParams added in v8.15.0 

func NewIngestPipelineParams() *IngestPipelineParams

NewIngestPipelineParams returns a IngestPipelineParams.

func (*IngestPipelineParams) UnmarshalJSON added in v8.15.0 

func (s *IngestPipelineParams) UnmarshalJSON(data []byte) error

type IngestStats added in v8.16.0 

type IngestStats struct {
	// Count Total number of documents ingested during the lifetime of this node.
	Count int64 `json:"count"`
	// Current Total number of documents currently being ingested.
	Current int64 `json:"current"`
	// Failed Total number of failed ingest operations during the lifetime of this node.
	Failed int64 `json:"failed"`
	// IngestedAsFirstPipelineInBytes Total number of bytes of all documents ingested by the pipeline.
	// This field is only present on pipelines which are the first to process a
	// document.
	// Thus, it is not present on pipelines which only serve as a final pipeline
	// after a default pipeline, a pipeline run after a reroute processor, or
	// pipelines in pipeline processors.
	IngestedAsFirstPipelineInBytes int64 `json:"ingested_as_first_pipeline_in_bytes"`
	// Processors Total number of ingest processors.
	Processors []map[string]KeyedProcessor `json:"processors"`
	// ProducedAsFirstPipelineInBytes Total number of bytes of all documents produced by the pipeline.
	// This field is only present on pipelines which are the first to process a
	// document.
	// Thus, it is not present on pipelines which only serve as a final pipeline
	// after a default pipeline, a pipeline run after a reroute processor, or
	// pipelines in pipeline processors.
	// In situations where there are subsequent pipelines, the value represents the
	// size of the document after all pipelines have run.
	ProducedAsFirstPipelineInBytes int64 `json:"produced_as_first_pipeline_in_bytes"`
	// TimeInMillis Total time, in milliseconds, spent preprocessing ingest documents during the
	// lifetime of this node.
	TimeInMillis int64 `json:"time_in_millis"`
}

IngestStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L356-L394

func NewIngestStats added in v8.16.0 

func NewIngestStats() *IngestStats

NewIngestStats returns a IngestStats.

func (*IngestStats) UnmarshalJSON added in v8.16.0 

func (s *IngestStats) UnmarshalJSON(data []byte) error

type IngestTotal 

type IngestTotal struct {
	// Count Total number of documents ingested during the lifetime of this node.
	Count int64 `json:"count"`
	// Current Total number of documents currently being ingested.
	Current int64 `json:"current"`
	// Failed Total number of failed ingest operations during the lifetime of this node.
	Failed int64 `json:"failed"`
	// TimeInMillis Total time, in milliseconds, spent preprocessing ingest documents during the
	// lifetime of this node.
	TimeInMillis int64 `json:"time_in_millis"`
}

IngestTotal type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L396-L413

func NewIngestTotal added in v8.5.0 

func NewIngestTotal() *IngestTotal

NewIngestTotal returns a IngestTotal.

func (*IngestTotal) UnmarshalJSON added in v8.7.1 

func (s *IngestTotal) UnmarshalJSON(data []byte) error

type InlineGet 

type InlineGet struct {
	Fields       map[string]json.RawMessage `json:"fields,omitempty"`
	Found        bool                       `json:"found"`
	Metadata     map[string]json.RawMessage `json:"-"`
	PrimaryTerm_ *int64                     `json:"_primary_term,omitempty"`
	Routing_     *string                    `json:"_routing,omitempty"`
	SeqNo_       *int64                     `json:"_seq_no,omitempty"`
	Source_      json.RawMessage            `json:"_source,omitempty"`
}

InlineGet type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L324-L337

func NewInlineGet added in v8.5.0 

func NewInlineGet() *InlineGet

NewInlineGet returns a InlineGet.

func (InlineGet) MarshalJSON 

func (s InlineGet) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*InlineGet) UnmarshalJSON added in v8.7.1 

func (s *InlineGet) UnmarshalJSON(data []byte) error

type InlineGetDictUserDefined 

type InlineGetDictUserDefined struct {
	Fields                   map[string]json.RawMessage `json:"fields,omitempty"`
	Found                    bool                       `json:"found"`
	InlineGetDictUserDefined map[string]json.RawMessage `json:"-"`
	PrimaryTerm_             *int64                     `json:"_primary_term,omitempty"`
	Routing_                 *string                    `json:"_routing,omitempty"`
	SeqNo_                   *int64                     `json:"_seq_no,omitempty"`
	Source_                  map[string]json.RawMessage `json:"_source,omitempty"`
}

InlineGetDictUserDefined type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L324-L337

func NewInlineGetDictUserDefined added in v8.5.0 

func NewInlineGetDictUserDefined() *InlineGetDictUserDefined

NewInlineGetDictUserDefined returns a InlineGetDictUserDefined.

func (InlineGetDictUserDefined) MarshalJSON 

func (s InlineGetDictUserDefined) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*InlineGetDictUserDefined) UnmarshalJSON added in v8.7.1 

func (s *InlineGetDictUserDefined) UnmarshalJSON(data []byte) error

type InnerHits 

type InnerHits struct {
	Collapse       *FieldCollapse   `json:"collapse,omitempty"`
	DocvalueFields []FieldAndFormat `json:"docvalue_fields,omitempty"`
	Explain        *bool            `json:"explain,omitempty"`
	Fields         []string         `json:"fields,omitempty"`
	// From Inner hit starting document offset.
	From           *int       `json:"from,omitempty"`
	Highlight      *Highlight `json:"highlight,omitempty"`
	IgnoreUnmapped *bool      `json:"ignore_unmapped,omitempty"`
	// Name The name for the particular inner hit definition in the response.
	// Useful when a search request contains multiple inner hits.
	Name             *string                `json:"name,omitempty"`
	ScriptFields     map[string]ScriptField `json:"script_fields,omitempty"`
	SeqNoPrimaryTerm *bool                  `json:"seq_no_primary_term,omitempty"`
	// Size The maximum number of hits to return per `inner_hits`.
	Size *int `json:"size,omitempty"`
	// Sort How the inner hits should be sorted per `inner_hits`.
	// By default, inner hits are sorted by score.
	Sort         []SortCombinations `json:"sort,omitempty"`
	Source_      SourceConfig       `json:"_source,omitempty"`
	StoredFields []string           `json:"stored_fields,omitempty"`
	TrackScores  *bool              `json:"track_scores,omitempty"`
	Version      *bool              `json:"version,omitempty"`
}

InnerHits type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L108-L142

func NewInnerHits added in v8.5.0 

func NewInnerHits() *InnerHits

NewInnerHits returns a InnerHits.

func (*InnerHits) UnmarshalJSON added in v8.7.1 

func (s *InnerHits) UnmarshalJSON(data []byte) error

type InnerHitsResult 

type InnerHitsResult struct {
	Hits *HitsMetadata `json:"hits,omitempty"`
}

InnerHitsResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L86-L88

func NewInnerHitsResult added in v8.5.0 

func NewInnerHitsResult() *InnerHitsResult

NewInnerHitsResult returns a InnerHitsResult.

type InnerRetriever added in v8.18.1 

type InnerRetriever struct {
	Normalizer scorenormalizer.ScoreNormalizer `json:"normalizer"`
	Retriever  *RetrieverContainer             `json:"retriever,omitempty"`
	Weight     float32                         `json:"weight"`
}

InnerRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L82-L86

func NewInnerRetriever added in v8.18.1 

func NewInnerRetriever() *InnerRetriever

NewInnerRetriever returns a InnerRetriever.

func (*InnerRetriever) UnmarshalJSON added in v8.18.1 

func (s *InnerRetriever) UnmarshalJSON(data []byte) error

type Input 

type Input struct {
	FieldNames []string `json:"field_names"`
}

Input type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L56-L58

func NewInput added in v8.5.0 

func NewInput() *Input

NewInput returns a Input.

func (*Input) UnmarshalJSON added in v8.7.1 

func (s *Input) UnmarshalJSON(data []byte) error

type InputConfig added in v8.18.0 

type InputConfig struct {
	InputField  string `json:"input_field"`
	OutputField string `json:"output_field"`
}

InputConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1061-L1064

func NewInputConfig added in v8.18.0 

func NewInputConfig() *InputConfig

NewInputConfig returns a InputConfig.

func (*InputConfig) UnmarshalJSON added in v8.18.0 

func (s *InputConfig) UnmarshalJSON(data []byte) error

type IntegerNumberProperty 

type IntegerNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *int                                             `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

IntegerNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L170-L173

func NewIntegerNumberProperty added in v8.5.0 

func NewIntegerNumberProperty() *IntegerNumberProperty

NewIntegerNumberProperty returns a IntegerNumberProperty.

func (IntegerNumberProperty) MarshalJSON added in v8.9.0 

func (s IntegerNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IntegerNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *IntegerNumberProperty) UnmarshalJSON(data []byte) error

type IntegerRangeProperty 

type IntegerRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

IntegerRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L42-L44

func NewIntegerRangeProperty added in v8.5.0 

func NewIntegerRangeProperty() *IntegerRangeProperty

NewIntegerRangeProperty returns a IntegerRangeProperty.

func (IntegerRangeProperty) MarshalJSON added in v8.9.0 

func (s IntegerRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IntegerRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *IntegerRangeProperty) UnmarshalJSON(data []byte) error

type Intervals added in v8.5.0 

type Intervals struct {
	// AllOf Returns matches that span a combination of other rules.
	AllOf *IntervalsAllOf `json:"all_of,omitempty"`
	// AnyOf Returns intervals produced by any of its sub-rules.
	AnyOf *IntervalsAnyOf `json:"any_of,omitempty"`
	// Fuzzy Matches analyzed text.
	Fuzzy *IntervalsFuzzy `json:"fuzzy,omitempty"`
	// Match Matches analyzed text.
	Match *IntervalsMatch `json:"match,omitempty"`
	// Prefix Matches terms that start with a specified set of characters.
	Prefix *IntervalsPrefix `json:"prefix,omitempty"`
	Range  *IntervalsRange  `json:"range,omitempty"`
	Regexp *IntervalsRegexp `json:"regexp,omitempty"`
	// Wildcard Matches terms using a wildcard pattern.
	Wildcard *IntervalsWildcard `json:"wildcard,omitempty"`
}

Intervals type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L83-L112

func NewIntervals added in v8.5.0 

func NewIntervals() *Intervals

NewIntervals returns a Intervals.

type IntervalsAllOf 

type IntervalsAllOf struct {
	// Filter Rule used to filter returned intervals.
	Filter *IntervalsFilter `json:"filter,omitempty"`
	// Intervals An array of rules to combine. All rules must produce a match in a document
	// for the overall source to match.
	Intervals []Intervals `json:"intervals"`
	// MaxGaps Maximum number of positions between the matching terms.
	// Intervals produced by the rules further apart than this are not considered
	// matches.
	MaxGaps *int `json:"max_gaps,omitempty"`
	// Ordered If `true`, intervals produced by the rules should appear in the order in
	// which they are specified.
	Ordered *bool `json:"ordered,omitempty"`
}

IntervalsAllOf type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L50-L70

func NewIntervalsAllOf added in v8.5.0 

func NewIntervalsAllOf() *IntervalsAllOf

NewIntervalsAllOf returns a IntervalsAllOf.

func (*IntervalsAllOf) UnmarshalJSON added in v8.7.1 

func (s *IntervalsAllOf) UnmarshalJSON(data []byte) error

type IntervalsAnyOf 

type IntervalsAnyOf struct {
	// Filter Rule used to filter returned intervals.
	Filter *IntervalsFilter `json:"filter,omitempty"`
	// Intervals An array of rules to match.
	Intervals []Intervals `json:"intervals"`
}

IntervalsAnyOf type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L72-L81

func NewIntervalsAnyOf added in v8.5.0 

func NewIntervalsAnyOf() *IntervalsAnyOf

NewIntervalsAnyOf returns a IntervalsAnyOf.

type IntervalsFilter 

type IntervalsFilter struct {
	// After Query used to return intervals that follow an interval from the `filter`
	// rule.
	After *Intervals `json:"after,omitempty"`
	// Before Query used to return intervals that occur before an interval from the
	// `filter` rule.
	Before *Intervals `json:"before,omitempty"`
	// ContainedBy Query used to return intervals contained by an interval from the `filter`
	// rule.
	ContainedBy *Intervals `json:"contained_by,omitempty"`
	// Containing Query used to return intervals that contain an interval from the `filter`
	// rule.
	Containing *Intervals `json:"containing,omitempty"`
	// NotContainedBy Query used to return intervals that are **not** contained by an interval from
	// the `filter` rule.
	NotContainedBy *Intervals `json:"not_contained_by,omitempty"`
	// NotContaining Query used to return intervals that do **not** contain an interval from the
	// `filter` rule.
	NotContaining *Intervals `json:"not_containing,omitempty"`
	// NotOverlapping Query used to return intervals that do **not** overlap with an interval from
	// the `filter` rule.
	NotOverlapping *Intervals `json:"not_overlapping,omitempty"`
	// Overlapping Query used to return intervals that overlap with an interval from the
	// `filter` rule.
	Overlapping *Intervals `json:"overlapping,omitempty"`
	// Script Script used to return matching documents.
	// This script must return a boolean value: `true` or `false`.
	Script *Script `json:"script,omitempty"`
}

IntervalsFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L114-L154

func NewIntervalsFilter added in v8.5.0 

func NewIntervalsFilter() *IntervalsFilter

NewIntervalsFilter returns a IntervalsFilter.

type IntervalsFuzzy 

type IntervalsFuzzy struct {
	// Analyzer Analyzer used to normalize the term.
	Analyzer *string `json:"analyzer,omitempty"`
	// Fuzziness Maximum edit distance allowed for matching.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// PrefixLength Number of beginning characters left unchanged when creating expansions.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Term The term to match.
	Term string `json:"term"`
	// Transpositions Indicates whether edits include transpositions of two adjacent characters
	// (for example, `ab` to `ba`).
	Transpositions *bool `json:"transpositions,omitempty"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `term` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsFuzzy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L156-L186

func NewIntervalsFuzzy added in v8.5.0 

func NewIntervalsFuzzy() *IntervalsFuzzy

NewIntervalsFuzzy returns a IntervalsFuzzy.

func (*IntervalsFuzzy) UnmarshalJSON added in v8.7.1 

func (s *IntervalsFuzzy) UnmarshalJSON(data []byte) error

type IntervalsMatch 

type IntervalsMatch struct {
	// Analyzer Analyzer used to analyze terms in the query.
	Analyzer *string `json:"analyzer,omitempty"`
	// Filter An optional interval filter.
	Filter *IntervalsFilter `json:"filter,omitempty"`
	// MaxGaps Maximum number of positions between the matching terms.
	// Terms further apart than this are not considered matches.
	MaxGaps *int `json:"max_gaps,omitempty"`
	// Ordered If `true`, matching terms must appear in their specified order.
	Ordered *bool `json:"ordered,omitempty"`
	// Query Text you wish to find in the provided field.
	Query string `json:"query"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `term` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsMatch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L188-L218

func NewIntervalsMatch added in v8.5.0 

func NewIntervalsMatch() *IntervalsMatch

NewIntervalsMatch returns a IntervalsMatch.

func (*IntervalsMatch) UnmarshalJSON added in v8.7.1 

func (s *IntervalsMatch) UnmarshalJSON(data []byte) error

type IntervalsPrefix 

type IntervalsPrefix struct {
	// Analyzer Analyzer used to analyze the `prefix`.
	Analyzer *string `json:"analyzer,omitempty"`
	// Prefix Beginning characters of terms you wish to find in the top-level field.
	Prefix string `json:"prefix"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `prefix` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsPrefix type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L220-L235

func NewIntervalsPrefix added in v8.5.0 

func NewIntervalsPrefix() *IntervalsPrefix

NewIntervalsPrefix returns a IntervalsPrefix.

func (*IntervalsPrefix) UnmarshalJSON added in v8.7.1 

func (s *IntervalsPrefix) UnmarshalJSON(data []byte) error

type IntervalsQuery 

type IntervalsQuery struct {
	// AllOf Returns matches that span a combination of other rules.
	AllOf *IntervalsAllOf `json:"all_of,omitempty"`
	// AnyOf Returns intervals produced by any of its sub-rules.
	AnyOf *IntervalsAnyOf `json:"any_of,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Fuzzy Matches terms that are similar to the provided term, within an edit distance
	// defined by `fuzziness`.
	Fuzzy *IntervalsFuzzy `json:"fuzzy,omitempty"`
	// Match Matches analyzed text.
	Match *IntervalsMatch `json:"match,omitempty"`
	// Prefix Matches terms that start with a specified set of characters.
	Prefix     *IntervalsPrefix `json:"prefix,omitempty"`
	QueryName_ *string          `json:"_name,omitempty"`
	Range      *IntervalsRange  `json:"range,omitempty"`
	Regexp     *IntervalsRegexp `json:"regexp,omitempty"`
	// Wildcard Matches terms using a wildcard pattern.
	Wildcard *IntervalsWildcard `json:"wildcard,omitempty"`
}

IntervalsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L283-L317

func NewIntervalsQuery added in v8.5.0 

func NewIntervalsQuery() *IntervalsQuery

NewIntervalsQuery returns a IntervalsQuery.

func (*IntervalsQuery) UnmarshalJSON added in v8.7.1 

func (s *IntervalsQuery) UnmarshalJSON(data []byte) error

type IntervalsRange added in v8.18.1 

type IntervalsRange struct {
	// Analyzer Analyzer used to analyze the `prefix`.
	Analyzer *string `json:"analyzer,omitempty"`
	// Gt Lower term, either gte or gt must be provided.
	Gt *string `json:"gt,omitempty"`
	// Gte Lower term, either gte or gt must be provided.
	Gte *string `json:"gte,omitempty"`
	// Lt Upper term, either lte or lt must be provided.
	Lt *string `json:"lt,omitempty"`
	// Lte Upper term, either lte or lt must be provided.
	Lte *string `json:"lte,omitempty"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `prefix` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsRange type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L237-L264

func NewIntervalsRange added in v8.18.1 

func NewIntervalsRange() *IntervalsRange

NewIntervalsRange returns a IntervalsRange.

func (*IntervalsRange) UnmarshalJSON added in v8.18.1 

func (s *IntervalsRange) UnmarshalJSON(data []byte) error

type IntervalsRegexp added in v8.18.1 

type IntervalsRegexp struct {
	// Analyzer Analyzer used to analyze the `prefix`.
	Analyzer *string `json:"analyzer,omitempty"`
	// Pattern Regex pattern.
	Pattern string `json:"pattern"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `prefix` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsRegexp type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L266-L281

func NewIntervalsRegexp added in v8.18.1 

func NewIntervalsRegexp() *IntervalsRegexp

NewIntervalsRegexp returns a IntervalsRegexp.

func (*IntervalsRegexp) UnmarshalJSON added in v8.18.1 

func (s *IntervalsRegexp) UnmarshalJSON(data []byte) error

type IntervalsWildcard 

type IntervalsWildcard struct {
	// Analyzer Analyzer used to analyze the `pattern`.
	// Defaults to the top-level field's analyzer.
	Analyzer *string `json:"analyzer,omitempty"`
	// Pattern Wildcard pattern used to find matching terms.
	Pattern string `json:"pattern"`
	// UseField If specified, match intervals from this field rather than the top-level
	// field.
	// The `pattern` is normalized using the search analyzer from this field, unless
	// `analyzer` is specified separately.
	UseField *string `json:"use_field,omitempty"`
}

IntervalsWildcard type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L319-L334

func NewIntervalsWildcard added in v8.5.0 

func NewIntervalsWildcard() *IntervalsWildcard

NewIntervalsWildcard returns a IntervalsWildcard.

func (*IntervalsWildcard) UnmarshalJSON added in v8.7.1 

func (s *IntervalsWildcard) UnmarshalJSON(data []byte) error

type InvertedIndex 

type InvertedIndex struct {
	Offsets         uint `json:"offsets"`
	Payloads        uint `json:"payloads"`
	Positions       uint `json:"positions"`
	Postings        uint `json:"postings"`
	Proximity       uint `json:"proximity"`
	TermFrequencies uint `json:"term_frequencies"`
	Terms           uint `json:"terms"`
}

InvertedIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L68-L76

func NewInvertedIndex added in v8.5.0 

func NewInvertedIndex() *InvertedIndex

NewInvertedIndex returns a InvertedIndex.

type Invocation 

type Invocation struct {
	SnapshotName string   `json:"snapshot_name"`
	Time         DateTime `json:"time"`
}

Invocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L148-L151

func NewInvocation added in v8.5.0 

func NewInvocation() *Invocation

NewInvocation returns a Invocation.

func (*Invocation) UnmarshalJSON added in v8.7.1 

func (s *Invocation) UnmarshalJSON(data []byte) error

type Invocations added in v8.7.0 

type Invocations struct {
	Total int64 `json:"total"`
}

Invocations type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L41-L43

func NewInvocations added in v8.7.0 

func NewInvocations() *Invocations

NewInvocations returns a Invocations.

func (*Invocations) UnmarshalJSON added in v8.7.1 

func (s *Invocations) UnmarshalJSON(data []byte) error

type IoStatDevice 

type IoStatDevice struct {
	// DeviceName The Linux device name.
	DeviceName *string `json:"device_name,omitempty"`
	// Operations The total number of read and write operations for the device completed since
	// starting Elasticsearch.
	Operations *int64 `json:"operations,omitempty"`
	// ReadKilobytes The total number of kilobytes read for the device since starting
	// Elasticsearch.
	ReadKilobytes *int64 `json:"read_kilobytes,omitempty"`
	// ReadOperations The total number of read operations for the device completed since starting
	// Elasticsearch.
	ReadOperations *int64 `json:"read_operations,omitempty"`
	// WriteKilobytes The total number of kilobytes written for the device since starting
	// Elasticsearch.
	WriteKilobytes *int64 `json:"write_kilobytes,omitempty"`
	// WriteOperations The total number of write operations for the device completed since starting
	// Elasticsearch.
	WriteOperations *int64 `json:"write_operations,omitempty"`
}

IoStatDevice type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L801-L826

func NewIoStatDevice added in v8.5.0 

func NewIoStatDevice() *IoStatDevice

NewIoStatDevice returns a IoStatDevice.

func (*IoStatDevice) UnmarshalJSON added in v8.7.1 

func (s *IoStatDevice) UnmarshalJSON(data []byte) error

type IoStats 

type IoStats struct {
	// Devices Array of disk metrics for each device that is backing an Elasticsearch data
	// path.
	// These disk metrics are probed periodically and averages between the last
	// probe and the current probe are computed.
	Devices []IoStatDevice `json:"devices,omitempty"`
	// Total The sum of the disk metrics for all devices that back an Elasticsearch data
	// path.
	Total *IoStatDevice `json:"total,omitempty"`
}

IoStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L789-L799

func NewIoStats added in v8.5.0 

func NewIoStats() *IoStats

NewIoStats returns a IoStats.

type IpFilter 

type IpFilter struct {
	Http      bool `json:"http"`
	Transport bool `json:"transport"`
}

IpFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L177-L180

func NewIpFilter added in v8.5.0 

func NewIpFilter() *IpFilter

NewIpFilter returns a IpFilter.

func (*IpFilter) UnmarshalJSON added in v8.7.1 

func (s *IpFilter) UnmarshalJSON(data []byte) error

type IpLocationDatabaseConfigurationMetadata added in v8.18.0 

type IpLocationDatabaseConfigurationMetadata struct {
	Database           DatabaseConfigurationFull `json:"database"`
	Id                 string                    `json:"id"`
	ModifiedDate       *int64                    `json:"modified_date,omitempty"`
	ModifiedDateMillis *int64                    `json:"modified_date_millis,omitempty"`
	Version            int64                     `json:"version"`
}

IpLocationDatabaseConfigurationMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/get_ip_location_database/GetIpLocationDatabaseResponse.ts#L28-L34

func NewIpLocationDatabaseConfigurationMetadata added in v8.18.0 

func NewIpLocationDatabaseConfigurationMetadata() *IpLocationDatabaseConfigurationMetadata

NewIpLocationDatabaseConfigurationMetadata returns a IpLocationDatabaseConfigurationMetadata.

func (*IpLocationDatabaseConfigurationMetadata) UnmarshalJSON added in v8.18.0 

func (s *IpLocationDatabaseConfigurationMetadata) UnmarshalJSON(data []byte) error

type IpLocationProcessor added in v8.17.0 

type IpLocationProcessor struct {
	// DatabaseFile The database filename referring to a database the module ships with
	// (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom
	// database in the ingest-geoip config directory.
	DatabaseFile *string `json:"database_file,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// DownloadDatabaseOnPipelineCreation If `true` (and if `ingest.geoip.downloader.eager.download` is `false`), the
	// missing database is downloaded when the pipeline is created.
	// Else, the download is triggered by when the pipeline is used as the
	// `default_pipeline` or `final_pipeline` in an index.
	DownloadDatabaseOnPipelineCreation *bool `json:"download_database_on_pipeline_creation,omitempty"`
	// Field The field to get the ip address from for the geographical lookup.
	Field string `json:"field"`
	// FirstOnly If `true`, only the first found IP location data will be returned, even if
	// the field contains an array.
	FirstOnly *bool `json:"first_only,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Properties Controls what properties are added to the `target_field` based on the IP
	// location lookup.
	Properties []string `json:"properties,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that will hold the geographical information looked up from the
	// MaxMind database.
	TargetField *string `json:"target_field,omitempty"`
}

IpLocationProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L478-L512

func NewIpLocationProcessor added in v8.17.0 

func NewIpLocationProcessor() *IpLocationProcessor

NewIpLocationProcessor returns a IpLocationProcessor.

func (*IpLocationProcessor) UnmarshalJSON added in v8.17.0 

func (s *IpLocationProcessor) UnmarshalJSON(data []byte) error

type IpPrefixAggregate added in v8.5.0 

type IpPrefixAggregate struct {
	Buckets BucketsIpPrefixBucket `json:"buckets"`
	Meta    Metadata              `json:"meta,omitempty"`
}

IpPrefixAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L709-L713

func NewIpPrefixAggregate added in v8.5.0 

func NewIpPrefixAggregate() *IpPrefixAggregate

NewIpPrefixAggregate returns a IpPrefixAggregate.

func (*IpPrefixAggregate) UnmarshalJSON added in v8.7.0 

func (s *IpPrefixAggregate) UnmarshalJSON(data []byte) error

type IpPrefixAggregation added in v8.5.0 

type IpPrefixAggregation struct {
	// AppendPrefixLength Defines whether the prefix length is appended to IP address keys in the
	// response.
	AppendPrefixLength *bool `json:"append_prefix_length,omitempty"`
	// Field The IP address field to aggregation on. The field mapping type must be `ip`.
	Field string `json:"field"`
	// IsIpv6 Defines whether the prefix applies to IPv6 addresses.
	IsIpv6 *bool `json:"is_ipv6,omitempty"`
	// Keyed Defines whether buckets are returned as a hash rather than an array in the
	// response.
	Keyed *bool `json:"keyed,omitempty"`
	// MinDocCount Minimum number of documents in a bucket for it to be included in the
	// response.
	MinDocCount *int64 `json:"min_doc_count,omitempty"`
	// PrefixLength Length of the network prefix. For IPv4 addresses the accepted range is [0,
	// 32].
	// For IPv6 addresses the accepted range is [0, 128].
	PrefixLength int `json:"prefix_length"`
}

IpPrefixAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1196-L1225

func NewIpPrefixAggregation added in v8.5.0 

func NewIpPrefixAggregation() *IpPrefixAggregation

NewIpPrefixAggregation returns a IpPrefixAggregation.

func (*IpPrefixAggregation) UnmarshalJSON added in v8.7.1 

func (s *IpPrefixAggregation) UnmarshalJSON(data []byte) error

type IpPrefixBucket added in v8.5.0 

type IpPrefixBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	IsIpv6       bool                 `json:"is_ipv6"`
	Key          string               `json:"key"`
	Netmask      *string              `json:"netmask,omitempty"`
	PrefixLength int                  `json:"prefix_length"`
}

IpPrefixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L715-L720

func NewIpPrefixBucket added in v8.5.0 

func NewIpPrefixBucket() *IpPrefixBucket

NewIpPrefixBucket returns a IpPrefixBucket.

func (IpPrefixBucket) MarshalJSON added in v8.5.0 

func (s IpPrefixBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*IpPrefixBucket) UnmarshalJSON added in v8.7.0 

func (s *IpPrefixBucket) UnmarshalJSON(data []byte) error

type IpProperty 

type IpProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *string                                          `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool  `json:"time_series_dimension,omitempty"`
	Type                string `json:"type,omitempty"`
}

IpProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L74-L88

func NewIpProperty added in v8.5.0 

func NewIpProperty() *IpProperty

NewIpProperty returns a IpProperty.

func (IpProperty) MarshalJSON added in v8.9.0 

func (s IpProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IpProperty) UnmarshalJSON added in v8.7.0 

func (s *IpProperty) UnmarshalJSON(data []byte) error

type IpRangeAggregate 

type IpRangeAggregate struct {
	Buckets BucketsIpRangeBucket `json:"buckets"`
	Meta    Metadata             `json:"meta,omitempty"`
}

IpRangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L624-L629

func NewIpRangeAggregate added in v8.5.0 

func NewIpRangeAggregate() *IpRangeAggregate

NewIpRangeAggregate returns a IpRangeAggregate.

func (*IpRangeAggregate) UnmarshalJSON added in v8.7.0 

func (s *IpRangeAggregate) UnmarshalJSON(data []byte) error

type IpRangeAggregation 

type IpRangeAggregation struct {
	// Field The date field whose values are used to build ranges.
	Field *string `json:"field,omitempty"`
	// Ranges Array of IP ranges.
	Ranges []IpRangeAggregationRange `json:"ranges,omitempty"`
}

IpRangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L567-L576

func NewIpRangeAggregation added in v8.5.0 

func NewIpRangeAggregation() *IpRangeAggregation

NewIpRangeAggregation returns a IpRangeAggregation.

func (*IpRangeAggregation) UnmarshalJSON added in v8.7.1 

func (s *IpRangeAggregation) UnmarshalJSON(data []byte) error

type IpRangeAggregationRange 

type IpRangeAggregationRange struct {
	// From Start of the range.
	From *string `json:"from,omitempty"`
	// Mask IP range defined as a CIDR mask.
	Mask *string `json:"mask,omitempty"`
	// To End of the range.
	To *string `json:"to,omitempty"`
}

IpRangeAggregationRange type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L578-L591

func NewIpRangeAggregationRange added in v8.5.0 

func NewIpRangeAggregationRange() *IpRangeAggregationRange

NewIpRangeAggregationRange returns a IpRangeAggregationRange.

func (*IpRangeAggregationRange) UnmarshalJSON added in v8.7.1 

func (s *IpRangeAggregationRange) UnmarshalJSON(data []byte) error

type IpRangeBucket 

type IpRangeBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	From         *string              `json:"from,omitempty"`
	Key          *string              `json:"key,omitempty"`
	To           *string              `json:"to,omitempty"`
}

IpRangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L631-L635

func NewIpRangeBucket added in v8.5.0 

func NewIpRangeBucket() *IpRangeBucket

NewIpRangeBucket returns a IpRangeBucket.

func (IpRangeBucket) MarshalJSON 

func (s IpRangeBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*IpRangeBucket) UnmarshalJSON added in v8.7.0 

func (s *IpRangeBucket) UnmarshalJSON(data []byte) error

type IpRangeProperty 

type IpRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

IpRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L46-L48

func NewIpRangeProperty added in v8.5.0 

func NewIpRangeProperty() *IpRangeProperty

NewIpRangeProperty returns a IpRangeProperty.

func (IpRangeProperty) MarshalJSON added in v8.9.0 

func (s IpRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IpRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *IpRangeProperty) UnmarshalJSON(data []byte) error

type Ipinfo added in v8.18.0 

type Ipinfo struct {
}

Ipinfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L59-L59

func NewIpinfo added in v8.18.0 

func NewIpinfo() *Ipinfo

NewIpinfo returns a Ipinfo.

type IrishAnalyzer added in v8.16.0 

type IrishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

IrishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L200-L205

func NewIrishAnalyzer added in v8.16.0 

func NewIrishAnalyzer() *IrishAnalyzer

NewIrishAnalyzer returns a IrishAnalyzer.

func (IrishAnalyzer) MarshalJSON added in v8.16.0 

func (s IrishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*IrishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *IrishAnalyzer) UnmarshalJSON(data []byte) error

type ItalianAnalyzer added in v8.16.0 

type ItalianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

ItalianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L207-L212

func NewItalianAnalyzer added in v8.16.0 

func NewItalianAnalyzer() *ItalianAnalyzer

NewItalianAnalyzer returns a ItalianAnalyzer.

func (ItalianAnalyzer) MarshalJSON added in v8.16.0 

func (s ItalianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ItalianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *ItalianAnalyzer) UnmarshalJSON(data []byte) error

type JaStopTokenFilter added in v8.18.1 

type JaStopTokenFilter struct {
	Stopwords StopWords `json:"stopwords,omitempty"`
	Type      string    `json:"type,omitempty"`
	Version   *string   `json:"version,omitempty"`
}

JaStopTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L32-L35

func NewJaStopTokenFilter added in v8.18.1 

func NewJaStopTokenFilter() *JaStopTokenFilter

NewJaStopTokenFilter returns a JaStopTokenFilter.

func (JaStopTokenFilter) MarshalJSON added in v8.18.1 

func (s JaStopTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*JaStopTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *JaStopTokenFilter) UnmarshalJSON(data []byte) error

type JinaAIServiceSettings added in v8.18.0 

type JinaAIServiceSettings struct {
	// ApiKey A valid API key of your JinaAI account.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// ModelId The name of the model to use for the inference task.
	// For a `rerank` task, it is required.
	// For a `text_embedding` task, it is optional.
	ModelId *string `json:"model_id,omitempty"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// JinaAI.
	// By default, the `jinaai` service sets the number of requests allowed per
	// minute to 2000 for all task types.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Similarity For a `text_embedding` task, the similarity measure. One of cosine,
	// dot_product, l2_norm.
	// The default values varies with the embedding type.
	// For example, a float embedding type uses a `dot_product` similarity measure
	// by default.
	Similarity *jinaaisimilaritytype.JinaAISimilarityType `json:"similarity,omitempty"`
}

JinaAIServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L973-L1002

func NewJinaAIServiceSettings added in v8.18.0 

func NewJinaAIServiceSettings() *JinaAIServiceSettings

NewJinaAIServiceSettings returns a JinaAIServiceSettings.

func (*JinaAIServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *JinaAIServiceSettings) UnmarshalJSON(data []byte) error

type JinaAITaskSettings added in v8.18.0 

type JinaAITaskSettings struct {
	// ReturnDocuments For a `rerank` task, return the doc text within the results.
	ReturnDocuments *bool `json:"return_documents,omitempty"`
	// Task For a `text_embedding` task, the task passed to the model.
	// Valid values are:
	//
	// * `classification`: Use it for embeddings passed through a text classifier.
	// * `clustering`: Use it for the embeddings run through a clustering algorithm.
	// * `ingest`: Use it for storing document embeddings in a vector database.
	// * `search`: Use it for storing embeddings of search queries run against a
	// vector database to find relevant documents.
	Task *jinaaitextembeddingtask.JinaAITextEmbeddingTask `json:"task,omitempty"`
	// TopN For a `rerank` task, the number of most relevant documents to return.
	// It defaults to the number of the documents.
	// If this inference endpoint is used in a `text_similarity_reranker` retriever
	// query and `top_n` is set, it must be greater than or equal to
	// `rank_window_size` in the query.
	TopN *int `json:"top_n,omitempty"`
}

JinaAITaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1004-L1025

func NewJinaAITaskSettings added in v8.18.0 

func NewJinaAITaskSettings() *JinaAITaskSettings

NewJinaAITaskSettings returns a JinaAITaskSettings.

func (*JinaAITaskSettings) UnmarshalJSON added in v8.18.0 

func (s *JinaAITaskSettings) UnmarshalJSON(data []byte) error

type Job 

type Job struct {
	// AllowLazyOpen Advanced configuration option.
	// Specifies whether this job can open when there is insufficient machine
	// learning node capacity for it to be immediately assigned to a node.
	AllowLazyOpen bool `json:"allow_lazy_open"`
	// AnalysisConfig The analysis configuration, which specifies how to analyze the data.
	// After you create a job, you cannot change the analysis configuration; all the
	// properties are informational.
	AnalysisConfig AnalysisConfig `json:"analysis_config"`
	// AnalysisLimits Limits can be applied for the resources required to hold the mathematical
	// models in memory.
	// These limits are approximate and can be set per job.
	// They do not control the memory used by other processes, for example the
	// Elasticsearch Java processes.
	AnalysisLimits *AnalysisLimits `json:"analysis_limits,omitempty"`
	// BackgroundPersistInterval Advanced configuration option.
	// The time between each periodic persistence of the model.
	// The default value is a randomized value between 3 to 4 hours, which avoids
	// all jobs persisting at exactly the same time.
	// The smallest allowed value is 1 hour.
	BackgroundPersistInterval Duration    `json:"background_persist_interval,omitempty"`
	Blocked                   *JobBlocked `json:"blocked,omitempty"`
	CreateTime                DateTime    `json:"create_time,omitempty"`
	// CustomSettings Advanced configuration option.
	// Contains custom metadata about the job.
	CustomSettings json.RawMessage `json:"custom_settings,omitempty"`
	// DailyModelSnapshotRetentionAfterDays Advanced configuration option, which affects the automatic removal of old
	// model snapshots for this job.
	// It specifies a period of time (in days) after which only the first snapshot
	// per day is retained.
	// This period is relative to the timestamp of the most recent snapshot for this
	// job.
	// Valid values range from 0 to `model_snapshot_retention_days`.
	DailyModelSnapshotRetentionAfterDays *int64 `json:"daily_model_snapshot_retention_after_days,omitempty"`
	// DataDescription The data description defines the format of the input data when you send data
	// to the job by using the post data API.
	// Note that when configuring a datafeed, these properties are automatically
	// set.
	// When data is received via the post data API, it is not stored in
	// Elasticsearch.
	// Only the results for anomaly detection are retained.
	DataDescription DataDescription `json:"data_description"`
	// DatafeedConfig The datafeed, which retrieves data from Elasticsearch for analysis by the
	// job.
	// You can associate only one datafeed with each anomaly detection job.
	DatafeedConfig *MLDatafeed `json:"datafeed_config,omitempty"`
	// Deleting Indicates that the process of deleting the job is in progress but not yet
	// completed.
	// It is only reported when `true`.
	Deleting *bool `json:"deleting,omitempty"`
	// Description A description of the job.
	Description *string `json:"description,omitempty"`
	// FinishedTime If the job closed or failed, this is the time the job finished, otherwise it
	// is `null`.
	// This property is informational; you cannot change its value.
	FinishedTime DateTime `json:"finished_time,omitempty"`
	// Groups A list of job groups.
	// A job can belong to no groups or many.
	Groups []string `json:"groups,omitempty"`
	// JobId Identifier for the anomaly detection job.
	// This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
	// hyphens, and underscores.
	// It must start and end with alphanumeric characters.
	JobId string `json:"job_id"`
	// JobType Reserved for future use, currently set to `anomaly_detector`.
	JobType *string `json:"job_type,omitempty"`
	// JobVersion The machine learning configuration version number at which the the job was
	// created.
	JobVersion *string `json:"job_version,omitempty"`
	// ModelPlotConfig This advanced configuration option stores model information along with the
	// results.
	// It provides a more detailed view into anomaly detection.
	// Model plot provides a simplified and indicative view of the model and its
	// bounds.
	ModelPlotConfig *ModelPlotConfig `json:"model_plot_config,omitempty"`
	ModelSnapshotId *string          `json:"model_snapshot_id,omitempty"`
	// ModelSnapshotRetentionDays Advanced configuration option, which affects the automatic removal of old
	// model snapshots for this job.
	// It specifies the maximum period of time (in days) that snapshots are
	// retained.
	// This period is relative to the timestamp of the most recent snapshot for this
	// job.
	// By default, snapshots ten days older than the newest snapshot are deleted.
	ModelSnapshotRetentionDays int64 `json:"model_snapshot_retention_days"`
	// RenormalizationWindowDays Advanced configuration option.
	// The period over which adjustments to the score are applied, as new data is
	// seen.
	// The default value is the longer of 30 days or 100 `bucket_spans`.
	RenormalizationWindowDays *int64 `json:"renormalization_window_days,omitempty"`
	// ResultsIndexName A text string that affects the name of the machine learning results index.
	// The default value is `shared`, which generates an index named
	// `.ml-anomalies-shared`.
	ResultsIndexName string `json:"results_index_name"`
	// ResultsRetentionDays Advanced configuration option.
	// The period of time (in days) that results are retained.
	// Age is calculated relative to the timestamp of the latest bucket result.
	// If this property has a non-null value, once per day at 00:30 (server time),
	// results that are the specified number of days older than the latest bucket
	// result are deleted from Elasticsearch.
	// The default value is null, which means all results are retained.
	// Annotations generated by the system also count as results for retention
	// purposes; they are deleted after the same number of days as results.
	// Annotations added by users are retained forever.
	ResultsRetentionDays *int64 `json:"results_retention_days,omitempty"`
}

Job type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L61-L180

func NewJob added in v8.5.0 

func NewJob() *Job

NewJob returns a Job.

func (*Job) UnmarshalJSON added in v8.7.1 

func (s *Job) UnmarshalJSON(data []byte) error

type JobBlocked 

type JobBlocked struct {
	Reason jobblockedreason.JobBlockedReason `json:"reason"`
	TaskId TaskId                            `json:"task_id,omitempty"`
}

JobBlocked type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L392-L395

func NewJobBlocked added in v8.5.0 

func NewJobBlocked() *JobBlocked

NewJobBlocked returns a JobBlocked.

func (*JobBlocked) UnmarshalJSON added in v8.7.1 

func (s *JobBlocked) UnmarshalJSON(data []byte) error

type JobConfig 

type JobConfig struct {
	// AllowLazyOpen Advanced configuration option. Specifies whether this job can open when there
	// is insufficient machine learning node capacity for it to be immediately
	// assigned to a node.
	AllowLazyOpen *bool `json:"allow_lazy_open,omitempty"`
	// AnalysisConfig The analysis configuration, which specifies how to analyze the data.
	// After you create a job, you cannot change the analysis configuration; all the
	// properties are informational.
	AnalysisConfig AnalysisConfig `json:"analysis_config"`
	// AnalysisLimits Limits can be applied for the resources required to hold the mathematical
	// models in memory.
	// These limits are approximate and can be set per job.
	// They do not control the memory used by other processes, for example the
	// Elasticsearch Java processes.
	AnalysisLimits *AnalysisLimits `json:"analysis_limits,omitempty"`
	// BackgroundPersistInterval Advanced configuration option.
	// The time between each periodic persistence of the model.
	// The default value is a randomized value between 3 to 4 hours, which avoids
	// all jobs persisting at exactly the same time.
	// The smallest allowed value is 1 hour.
	BackgroundPersistInterval Duration `json:"background_persist_interval,omitempty"`
	// CustomSettings Advanced configuration option.
	// Contains custom metadata about the job.
	CustomSettings json.RawMessage `json:"custom_settings,omitempty"`
	// DailyModelSnapshotRetentionAfterDays Advanced configuration option, which affects the automatic removal of old
	// model snapshots for this job.
	// It specifies a period of time (in days) after which only the first snapshot
	// per day is retained.
	// This period is relative to the timestamp of the most recent snapshot for this
	// job.
	DailyModelSnapshotRetentionAfterDays *int64 `json:"daily_model_snapshot_retention_after_days,omitempty"`
	// DataDescription The data description defines the format of the input data when you send data
	// to the job by using the post data API.
	// Note that when configure a datafeed, these properties are automatically set.
	DataDescription DataDescription `json:"data_description"`
	// DatafeedConfig The datafeed, which retrieves data from Elasticsearch for analysis by the
	// job.
	// You can associate only one datafeed with each anomaly detection job.
	DatafeedConfig *DatafeedConfig `json:"datafeed_config,omitempty"`
	// Description A description of the job.
	Description *string `json:"description,omitempty"`
	// Groups A list of job groups. A job can belong to no groups or many.
	Groups []string `json:"groups,omitempty"`
	// JobId Identifier for the anomaly detection job.
	// This identifier can contain lowercase alphanumeric characters (a-z and 0-9),
	// hyphens, and underscores.
	// It must start and end with alphanumeric characters.
	JobId *string `json:"job_id,omitempty"`
	// JobType Reserved for future use, currently set to `anomaly_detector`.
	JobType *string `json:"job_type,omitempty"`
	// ModelPlotConfig This advanced configuration option stores model information along with the
	// results.
	// It provides a more detailed view into anomaly detection.
	// Model plot provides a simplified and indicative view of the model and its
	// bounds.
	ModelPlotConfig *ModelPlotConfig `json:"model_plot_config,omitempty"`
	// ModelSnapshotRetentionDays Advanced configuration option, which affects the automatic removal of old
	// model snapshots for this job.
	// It specifies the maximum period of time (in days) that snapshots are
	// retained.
	// This period is relative to the timestamp of the most recent snapshot for this
	// job.
	// The default value is `10`, which means snapshots ten days older than the
	// newest snapshot are deleted.
	ModelSnapshotRetentionDays *int64 `json:"model_snapshot_retention_days,omitempty"`
	// RenormalizationWindowDays Advanced configuration option.
	// The period over which adjustments to the score are applied, as new data is
	// seen.
	// The default value is the longer of 30 days or 100 `bucket_spans`.
	RenormalizationWindowDays *int64 `json:"renormalization_window_days,omitempty"`
	// ResultsIndexName A text string that affects the name of the machine learning results index.
	// The default value is `shared`, which generates an index named
	// `.ml-anomalies-shared`.
	ResultsIndexName *string `json:"results_index_name,omitempty"`
	// ResultsRetentionDays Advanced configuration option.
	// The period of time (in days) that results are retained.
	// Age is calculated relative to the timestamp of the latest bucket result.
	// If this property has a non-null value, once per day at 00:30 (server time),
	// results that are the specified number of days older than the latest bucket
	// result are deleted from Elasticsearch.
	// The default value is null, which means all results are retained.
	// Annotations generated by the system also count as results for retention
	// purposes; they are deleted after the same number of days as results.
	// Annotations added by users are retained forever.
	ResultsRetentionDays *int64 `json:"results_retention_days,omitempty"`
}

JobConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L182-L283

func NewJobConfig added in v8.5.0 

func NewJobConfig() *JobConfig

NewJobConfig returns a JobConfig.

func (*JobConfig) UnmarshalJSON added in v8.7.1 

func (s *JobConfig) UnmarshalJSON(data []byte) error

type JobForecastStatistics 

type JobForecastStatistics struct {
	ForecastedJobs   int              `json:"forecasted_jobs"`
	MemoryBytes      *JobStatistics   `json:"memory_bytes,omitempty"`
	ProcessingTimeMs *JobStatistics   `json:"processing_time_ms,omitempty"`
	Records          *JobStatistics   `json:"records,omitempty"`
	Status           map[string]int64 `json:"status,omitempty"`
	Total            int64            `json:"total"`
}

JobForecastStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L343-L350

func NewJobForecastStatistics added in v8.5.0 

func NewJobForecastStatistics() *JobForecastStatistics

NewJobForecastStatistics returns a JobForecastStatistics.

func (*JobForecastStatistics) UnmarshalJSON added in v8.7.1 

func (s *JobForecastStatistics) UnmarshalJSON(data []byte) error

type JobStatistics 

type JobStatistics struct {
	Avg   Float64 `json:"avg"`
	Max   Float64 `json:"max"`
	Min   Float64 `json:"min"`
	Total Float64 `json:"total"`
}

JobStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L54-L59

func NewJobStatistics added in v8.5.0 

func NewJobStatistics() *JobStatistics

NewJobStatistics returns a JobStatistics.

func (*JobStatistics) UnmarshalJSON added in v8.7.1 

func (s *JobStatistics) UnmarshalJSON(data []byte) error

type JobStats 

type JobStats struct {
	// AssignmentExplanation For open anomaly detection jobs only, contains messages relating to the
	// selection of a node to run the job.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// DataCounts An object that describes the quantity of input to the job and any related
	// error counts.
	// The `data_count` values are cumulative for the lifetime of a job.
	// If a model snapshot is reverted or old results are deleted, the job counts
	// are not reset.
	DataCounts DataCounts `json:"data_counts"`
	// Deleting Indicates that the process of deleting the job is in progress but not yet
	// completed. It is only reported when `true`.
	Deleting *bool `json:"deleting,omitempty"`
	// ForecastsStats An object that provides statistical information about forecasts belonging to
	// this job.
	// Some statistics are omitted if no forecasts have been made.
	ForecastsStats JobForecastStatistics `json:"forecasts_stats"`
	// JobId Identifier for the anomaly detection job.
	JobId string `json:"job_id"`
	// ModelSizeStats An object that provides information about the size and contents of the model.
	ModelSizeStats ModelSizeStats `json:"model_size_stats"`
	// Node Contains properties for the node that runs the job.
	// This information is available only for open jobs.
	Node *DiscoveryNodeCompact `json:"node,omitempty"`
	// OpenTime For open jobs only, the elapsed time for which the job has been open.
	OpenTime DateTime `json:"open_time,omitempty"`
	// State The status of the anomaly detection job, which can be one of the following
	// values: `closed`, `closing`, `failed`, `opened`, `opening`.
	State jobstate.JobState `json:"state"`
	// TimingStats An object that provides statistical information about timing aspect of this
	// job.
	TimingStats JobTimingStats `json:"timing_stats"`
}

JobStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L284-L330

func NewJobStats added in v8.5.0 

func NewJobStats() *JobStats

NewJobStats returns a JobStats.

func (*JobStats) UnmarshalJSON added in v8.7.1 

func (s *JobStats) UnmarshalJSON(data []byte) error

type JobTimingStats 

type JobTimingStats struct {
	AverageBucketProcessingTimeMs                   Float64 `json:"average_bucket_processing_time_ms,omitempty"`
	BucketCount                                     int64   `json:"bucket_count"`
	ExponentialAverageBucketProcessingTimeMs        Float64 `json:"exponential_average_bucket_processing_time_ms,omitempty"`
	ExponentialAverageBucketProcessingTimePerHourMs Float64 `json:"exponential_average_bucket_processing_time_per_hour_ms"`
	JobId                                           string  `json:"job_id"`
	MaximumBucketProcessingTimeMs                   Float64 `json:"maximum_bucket_processing_time_ms,omitempty"`
	MinimumBucketProcessingTimeMs                   Float64 `json:"minimum_bucket_processing_time_ms,omitempty"`
	TotalBucketProcessingTimeMs                     Float64 `json:"total_bucket_processing_time_ms"`
}

JobTimingStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Job.ts#L332-L341

func NewJobTimingStats added in v8.5.0 

func NewJobTimingStats() *JobTimingStats

NewJobTimingStats returns a JobTimingStats.

func (*JobTimingStats) UnmarshalJSON added in v8.7.1 

func (s *JobTimingStats) UnmarshalJSON(data []byte) error

type JobUsage added in v8.5.0 

type JobUsage struct {
	Count     int              `json:"count"`
	CreatedBy map[string]int64 `json:"created_by"`
	Detectors JobStatistics    `json:"detectors"`
	Forecasts MlJobForecasts   `json:"forecasts"`
	ModelSize JobStatistics    `json:"model_size"`
}

JobUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L374-L380

func NewJobUsage added in v8.5.0 

func NewJobUsage() *JobUsage

NewJobUsage returns a JobUsage.

func (*JobUsage) UnmarshalJSON added in v8.7.1 

func (s *JobUsage) UnmarshalJSON(data []byte) error

type JobsRecord 

type JobsRecord struct {
	// AssignmentExplanation For open anomaly detection jobs only, contains messages relating to the
	// selection of a node to run the job.
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// BucketsCount The number of bucket results produced by the job.
	BucketsCount *string `json:"buckets.count,omitempty"`
	// BucketsTimeExpAvg The exponential moving average of all bucket processing times, in
	// milliseconds.
	BucketsTimeExpAvg *string `json:"buckets.time.exp_avg,omitempty"`
	// BucketsTimeExpAvgHour The exponential moving average of bucket processing times calculated in a one
	// hour time window, in milliseconds.
	BucketsTimeExpAvgHour *string `json:"buckets.time.exp_avg_hour,omitempty"`
	// BucketsTimeMax The maximum of all bucket processing times, in milliseconds.
	BucketsTimeMax *string `json:"buckets.time.max,omitempty"`
	// BucketsTimeMin The minimum of all bucket processing times, in milliseconds.
	BucketsTimeMin *string `json:"buckets.time.min,omitempty"`
	// BucketsTimeTotal The sum of all bucket processing times, in milliseconds.
	BucketsTimeTotal *string `json:"buckets.time.total,omitempty"`
	// DataBuckets The total number of buckets processed.
	DataBuckets *string `json:"data.buckets,omitempty"`
	// DataEarliestRecord The timestamp of the earliest chronologically input document.
	DataEarliestRecord *string `json:"data.earliest_record,omitempty"`
	// DataEmptyBuckets The number of buckets which did not contain any data.
	// If your data contains many empty buckets, consider increasing your
	// `bucket_span` or using functions that are tolerant to gaps in data such as
	// mean, `non_null_sum` or `non_zero_count`.
	DataEmptyBuckets *string `json:"data.empty_buckets,omitempty"`
	// DataInputBytes The number of bytes of input data posted to the anomaly detection job.
	DataInputBytes ByteSize `json:"data.input_bytes,omitempty"`
	// DataInputFields The total number of fields in input documents posted to the anomaly detection
	// job.
	// This count includes fields that are not used in the analysis.
	// However, be aware that if you are using a datafeed, it extracts only the
	// required fields from the documents it retrieves before posting them to the
	// job.
	DataInputFields *string `json:"data.input_fields,omitempty"`
	// DataInputRecords The number of input documents posted to the anomaly detection job.
	DataInputRecords *string `json:"data.input_records,omitempty"`
	// DataInvalidDates The number of input documents with either a missing date field or a date that
	// could not be parsed.
	DataInvalidDates *string `json:"data.invalid_dates,omitempty"`
	// DataLast The timestamp at which data was last analyzed, according to server time.
	DataLast *string `json:"data.last,omitempty"`
	// DataLastEmptyBucket The timestamp of the last bucket that did not contain any data.
	DataLastEmptyBucket *string `json:"data.last_empty_bucket,omitempty"`
	// DataLastSparseBucket The timestamp of the last bucket that was considered sparse.
	DataLastSparseBucket *string `json:"data.last_sparse_bucket,omitempty"`
	// DataLatestRecord The timestamp of the latest chronologically input document.
	DataLatestRecord *string `json:"data.latest_record,omitempty"`
	// DataMissingFields The number of input documents that are missing a field that the anomaly
	// detection job is configured to analyze.
	// Input documents with missing fields are still processed because it is
	// possible that not all fields are missing.
	// If you are using datafeeds or posting data to the job in JSON format, a high
	// `missing_field_count` is often not an indication of data issues.
	// It is not necessarily a cause for concern.
	DataMissingFields *string `json:"data.missing_fields,omitempty"`
	// DataOutOfOrderTimestamps The number of input documents that have a timestamp chronologically preceding
	// the start of the current anomaly detection bucket offset by the latency
	// window.
	// This information is applicable only when you provide data to the anomaly
	// detection job by using the post data API.
	// These out of order documents are discarded, since jobs require time series
	// data to be in ascending chronological order.
	DataOutOfOrderTimestamps *string `json:"data.out_of_order_timestamps,omitempty"`
	// DataProcessedFields The total number of fields in all the documents that have been processed by
	// the anomaly detection job.
	// Only fields that are specified in the detector configuration object
	// contribute to this count.
	// The timestamp is not included in this count.
	DataProcessedFields *string `json:"data.processed_fields,omitempty"`
	// DataProcessedRecords The number of input documents that have been processed by the anomaly
	// detection job.
	// This value includes documents with missing fields, since they are nonetheless
	// analyzed.
	// If you use datafeeds and have aggregations in your search query, the
	// `processed_record_count` is the number of aggregation results processed, not
	// the number of Elasticsearch documents.
	DataProcessedRecords *string `json:"data.processed_records,omitempty"`
	// DataSparseBuckets The number of buckets that contained few data points compared to the expected
	// number of data points.
	// If your data contains many sparse buckets, consider using a longer
	// `bucket_span`.
	DataSparseBuckets *string `json:"data.sparse_buckets,omitempty"`
	// ForecastsMemoryAvg The average memory usage in bytes for forecasts related to the anomaly
	// detection job.
	ForecastsMemoryAvg *string `json:"forecasts.memory.avg,omitempty"`
	// ForecastsMemoryMax The maximum memory usage in bytes for forecasts related to the anomaly
	// detection job.
	ForecastsMemoryMax *string `json:"forecasts.memory.max,omitempty"`
	// ForecastsMemoryMin The minimum memory usage in bytes for forecasts related to the anomaly
	// detection job.
	ForecastsMemoryMin *string `json:"forecasts.memory.min,omitempty"`
	// ForecastsMemoryTotal The total memory usage in bytes for forecasts related to the anomaly
	// detection job.
	ForecastsMemoryTotal *string `json:"forecasts.memory.total,omitempty"`
	// ForecastsRecordsAvg The average number of `model_forecast` documents written for forecasts
	// related to the anomaly detection job.
	ForecastsRecordsAvg *string `json:"forecasts.records.avg,omitempty"`
	// ForecastsRecordsMax The maximum number of `model_forecast` documents written for forecasts
	// related to the anomaly detection job.
	ForecastsRecordsMax *string `json:"forecasts.records.max,omitempty"`
	// ForecastsRecordsMin The minimum number of `model_forecast` documents written for forecasts
	// related to the anomaly detection job.
	ForecastsRecordsMin *string `json:"forecasts.records.min,omitempty"`
	// ForecastsRecordsTotal The total number of `model_forecast` documents written for forecasts related
	// to the anomaly detection job.
	ForecastsRecordsTotal *string `json:"forecasts.records.total,omitempty"`
	// ForecastsTimeAvg The average runtime in milliseconds for forecasts related to the anomaly
	// detection job.
	ForecastsTimeAvg *string `json:"forecasts.time.avg,omitempty"`
	// ForecastsTimeMax The maximum runtime in milliseconds for forecasts related to the anomaly
	// detection job.
	ForecastsTimeMax *string `json:"forecasts.time.max,omitempty"`
	// ForecastsTimeMin The minimum runtime in milliseconds for forecasts related to the anomaly
	// detection job.
	ForecastsTimeMin *string `json:"forecasts.time.min,omitempty"`
	// ForecastsTimeTotal The total runtime in milliseconds for forecasts related to the anomaly
	// detection job.
	ForecastsTimeTotal *string `json:"forecasts.time.total,omitempty"`
	// ForecastsTotal The number of individual forecasts currently available for the job.
	// A value of one or more indicates that forecasts exist.
	ForecastsTotal *string `json:"forecasts.total,omitempty"`
	// Id The anomaly detection job identifier.
	Id *string `json:"id,omitempty"`
	// ModelBucketAllocationFailures The number of buckets for which new entities in incoming data were not
	// processed due to insufficient model memory.
	// This situation is also signified by a `hard_limit: memory_status` property
	// value.
	ModelBucketAllocationFailures *string `json:"model.bucket_allocation_failures,omitempty"`
	// ModelByFields The number of `by` field values that were analyzed by the models.
	// This value is cumulative for all detectors in the job.
	ModelByFields *string `json:"model.by_fields,omitempty"`
	// ModelBytes The number of bytes of memory used by the models.
	// This is the maximum value since the last time the model was persisted.
	// If the job is closed, this value indicates the latest size.
	ModelBytes ByteSize `json:"model.bytes,omitempty"`
	// ModelBytesExceeded The number of bytes over the high limit for memory usage at the last
	// allocation failure.
	ModelBytesExceeded ByteSize `json:"model.bytes_exceeded,omitempty"`
	// ModelCategorizationStatus The status of categorization for the job.
	ModelCategorizationStatus *categorizationstatus.CategorizationStatus `json:"model.categorization_status,omitempty"`
	// ModelCategorizedDocCount The number of documents that have had a field categorized.
	ModelCategorizedDocCount *string `json:"model.categorized_doc_count,omitempty"`
	// ModelDeadCategoryCount The number of categories created by categorization that will never be
	// assigned again because another category’s definition makes it a superset of
	// the dead category.
	// Dead categories are a side effect of the way categorization has no prior
	// training.
	ModelDeadCategoryCount *string `json:"model.dead_category_count,omitempty"`
	// ModelFailedCategoryCount The number of times that categorization wanted to create a new category but
	// couldn’t because the job had hit its `model_memory_limit`.
	// This count does not track which specific categories failed to be created.
	// Therefore you cannot use this value to determine the number of unique
	// categories that were missed.
	ModelFailedCategoryCount *string `json:"model.failed_category_count,omitempty"`
	// ModelFrequentCategoryCount The number of categories that match more than 1% of categorized documents.
	ModelFrequentCategoryCount *string `json:"model.frequent_category_count,omitempty"`
	// ModelLogTime The timestamp when the model stats were gathered, according to server time.
	ModelLogTime *string `json:"model.log_time,omitempty"`
	// ModelMemoryLimit The upper limit for model memory usage, checked on increasing values.
	ModelMemoryLimit *string `json:"model.memory_limit,omitempty"`
	// ModelMemoryStatus The status of the mathematical models.
	ModelMemoryStatus *memorystatus.MemoryStatus `json:"model.memory_status,omitempty"`
	// ModelOverFields The number of `over` field values that were analyzed by the models.
	// This value is cumulative for all detectors in the job.
	ModelOverFields *string `json:"model.over_fields,omitempty"`
	// ModelPartitionFields The number of `partition` field values that were analyzed by the models.
	// This value is cumulative for all detectors in the job.
	ModelPartitionFields *string `json:"model.partition_fields,omitempty"`
	// ModelRareCategoryCount The number of categories that match just one categorized document.
	ModelRareCategoryCount *string `json:"model.rare_category_count,omitempty"`
	// ModelTimestamp The timestamp of the last record when the model stats were gathered.
	ModelTimestamp *string `json:"model.timestamp,omitempty"`
	// ModelTotalCategoryCount The number of categories created by categorization.
	ModelTotalCategoryCount *string `json:"model.total_category_count,omitempty"`
	// NodeAddress The network address of the assigned node.
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId The ephemeral identifier of the assigned node.
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId The uniqe identifier of the assigned node.
	NodeId *string `json:"node.id,omitempty"`
	// NodeName The name of the assigned node.
	NodeName *string `json:"node.name,omitempty"`
	// OpenedTime For open jobs only, the amount of time the job has been opened.
	OpenedTime *string `json:"opened_time,omitempty"`
	// State The status of the anomaly detection job.
	State *jobstate.JobState `json:"state,omitempty"`
}

JobsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/ml_jobs/types.ts#L24-L347

func NewJobsRecord added in v8.5.0 

func NewJobsRecord() *JobsRecord

NewJobsRecord returns a JobsRecord.

func (*JobsRecord) UnmarshalJSON added in v8.7.1 

func (s *JobsRecord) UnmarshalJSON(data []byte) error

type JoinProcessor 

type JoinProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field Field containing array values to join.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Separator The separator character.
	Separator string `json:"separator"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the joined value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

JoinProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1121-L1136

func NewJoinProcessor added in v8.5.0 

func NewJoinProcessor() *JoinProcessor

NewJoinProcessor returns a JoinProcessor.

func (*JoinProcessor) UnmarshalJSON added in v8.7.1 

func (s *JoinProcessor) UnmarshalJSON(data []byte) error

type JoinProperty 

type JoinProperty struct {
	Dynamic             *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EagerGlobalOrdinals *bool                          `json:"eager_global_ordinals,omitempty"`
	Fields              map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove         *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Relations           map[string][]string                              `json:"relations,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

JoinProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L101-L105

func NewJoinProperty added in v8.5.0 

func NewJoinProperty() *JoinProperty

NewJoinProperty returns a JoinProperty.

func (JoinProperty) MarshalJSON added in v8.9.0 

func (s JoinProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*JoinProperty) UnmarshalJSON added in v8.7.0 

func (s *JoinProperty) UnmarshalJSON(data []byte) error

type JsonProcessor 

type JsonProcessor struct {
	// AddToRoot Flag that forces the parsed JSON to be added at the top level of the
	// document.
	// `target_field` must not be set when this option is chosen.
	AddToRoot *bool `json:"add_to_root,omitempty"`
	// AddToRootConflictStrategy When set to `replace`, root fields that conflict with fields from the parsed
	// JSON will be overridden.
	// When set to `merge`, conflicting fields will be merged.
	// Only applicable `if add_to_root` is set to true.
	AddToRootConflictStrategy *jsonprocessorconflictstrategy.JsonProcessorConflictStrategy `json:"add_to_root_conflict_strategy,omitempty"`
	// AllowDuplicateKeys When set to `true`, the JSON parser will not fail if the JSON contains
	// duplicate keys.
	// Instead, the last encountered value for any duplicate key wins.
	AllowDuplicateKeys *bool `json:"allow_duplicate_keys,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to be parsed.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that the converted structured object will be written into.
	// Any existing content in this field will be overwritten.
	TargetField *string `json:"target_field,omitempty"`
}

JsonProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1138-L1167

func NewJsonProcessor added in v8.5.0 

func NewJsonProcessor() *JsonProcessor

NewJsonProcessor returns a JsonProcessor.

func (*JsonProcessor) UnmarshalJSON added in v8.7.1 

func (s *JsonProcessor) UnmarshalJSON(data []byte) error

type Jvm 

type Jvm struct {
	// BufferPools Contains statistics about JVM buffer pools for the node.
	BufferPools map[string]NodeBufferPool `json:"buffer_pools,omitempty"`
	// Classes Contains statistics about classes loaded by JVM for the node.
	Classes *JvmClasses `json:"classes,omitempty"`
	// Gc Contains statistics about JVM garbage collectors for the node.
	Gc *GarbageCollector `json:"gc,omitempty"`
	// Mem Contains JVM memory usage statistics for the node.
	Mem *JvmMemoryStats `json:"mem,omitempty"`
	// Threads Contains statistics about JVM thread usage for the node.
	Threads *JvmThreads `json:"threads,omitempty"`
	// Timestamp Last time JVM statistics were refreshed.
	Timestamp *int64 `json:"timestamp,omitempty"`
	// Uptime Human-readable JVM uptime.
	// Only returned if the `human` query parameter is `true`.
	Uptime *string `json:"uptime,omitempty"`
	// UptimeInMillis JVM uptime in milliseconds.
	UptimeInMillis *int64 `json:"uptime_in_millis,omitempty"`
}

Jvm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L882-L916

func NewJvm added in v8.5.0 

func NewJvm() *Jvm

NewJvm returns a Jvm.

func (*Jvm) UnmarshalJSON added in v8.7.1 

func (s *Jvm) UnmarshalJSON(data []byte) error

type JvmClasses 

type JvmClasses struct {
	// CurrentLoadedCount Number of classes currently loaded by JVM.
	CurrentLoadedCount *int64 `json:"current_loaded_count,omitempty"`
	// TotalLoadedCount Total number of classes loaded since the JVM started.
	TotalLoadedCount *int64 `json:"total_loaded_count,omitempty"`
	// TotalUnloadedCount Total number of classes unloaded since the JVM started.
	TotalUnloadedCount *int64 `json:"total_unloaded_count,omitempty"`
}

JvmClasses type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L979-L992

func NewJvmClasses added in v8.5.0 

func NewJvmClasses() *JvmClasses

NewJvmClasses returns a JvmClasses.

func (*JvmClasses) UnmarshalJSON added in v8.7.1 

func (s *JvmClasses) UnmarshalJSON(data []byte) error

type JvmMemoryStats 

type JvmMemoryStats struct {
	// HeapCommittedInBytes Amount of memory, in bytes, available for use by the heap.
	HeapCommittedInBytes *int64 `json:"heap_committed_in_bytes,omitempty"`
	// HeapMaxInBytes Maximum amount of memory, in bytes, available for use by the heap.
	HeapMaxInBytes *int64 `json:"heap_max_in_bytes,omitempty"`
	// HeapUsedInBytes Memory, in bytes, currently in use by the heap.
	HeapUsedInBytes *int64 `json:"heap_used_in_bytes,omitempty"`
	// HeapUsedPercent Percentage of memory currently in use by the heap.
	HeapUsedPercent *int64 `json:"heap_used_percent,omitempty"`
	// NonHeapCommittedInBytes Amount of non-heap memory available, in bytes.
	NonHeapCommittedInBytes *int64 `json:"non_heap_committed_in_bytes,omitempty"`
	// NonHeapUsedInBytes Non-heap memory used, in bytes.
	NonHeapUsedInBytes *int64 `json:"non_heap_used_in_bytes,omitempty"`
	// Pools Contains statistics about heap memory usage for the node.
	Pools map[string]Pool `json:"pools,omitempty"`
}

JvmMemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L918-L947

func NewJvmMemoryStats added in v8.5.0 

func NewJvmMemoryStats() *JvmMemoryStats

NewJvmMemoryStats returns a JvmMemoryStats.

func (*JvmMemoryStats) UnmarshalJSON added in v8.7.1 

func (s *JvmMemoryStats) UnmarshalJSON(data []byte) error

type JvmStats 

type JvmStats struct {
	// HeapMax Maximum amount of memory available for use by the heap.
	HeapMax ByteSize `json:"heap_max,omitempty"`
	// HeapMaxInBytes Maximum amount of memory, in bytes, available for use by the heap.
	HeapMaxInBytes int `json:"heap_max_in_bytes"`
	// JavaInference Amount of Java heap currently being used for caching inference models.
	JavaInference ByteSize `json:"java_inference,omitempty"`
	// JavaInferenceInBytes Amount of Java heap, in bytes, currently being used for caching inference
	// models.
	JavaInferenceInBytes int `json:"java_inference_in_bytes"`
	// JavaInferenceMax Maximum amount of Java heap to be used for caching inference models.
	JavaInferenceMax ByteSize `json:"java_inference_max,omitempty"`
	// JavaInferenceMaxInBytes Maximum amount of Java heap, in bytes, to be used for caching inference
	// models.
	JavaInferenceMaxInBytes int `json:"java_inference_max_in_bytes"`
}

JvmStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/get_memory_stats/types.ts#L50-L63

func NewJvmStats added in v8.5.0 

func NewJvmStats() *JvmStats

NewJvmStats returns a JvmStats.

func (*JvmStats) UnmarshalJSON added in v8.7.1 

func (s *JvmStats) UnmarshalJSON(data []byte) error

type JvmThreads 

type JvmThreads struct {
	// Count Number of active threads in use by JVM.
	Count *int64 `json:"count,omitempty"`
	// PeakCount Highest number of threads used by JVM.
	PeakCount *int64 `json:"peak_count,omitempty"`
}

JvmThreads type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L968-L977

func NewJvmThreads added in v8.5.0 

func NewJvmThreads() *JvmThreads

NewJvmThreads returns a JvmThreads.

func (*JvmThreads) UnmarshalJSON added in v8.7.1 

func (s *JvmThreads) UnmarshalJSON(data []byte) error

type KStemTokenFilter 

type KStemTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

KStemTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L324-L326

func NewKStemTokenFilter added in v8.5.0 

func NewKStemTokenFilter() *KStemTokenFilter

NewKStemTokenFilter returns a KStemTokenFilter.

func (KStemTokenFilter) MarshalJSON added in v8.9.0 

func (s KStemTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KStemTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KStemTokenFilter) UnmarshalJSON(data []byte) error

type KeepTypesTokenFilter 

type KeepTypesTokenFilter struct {
	// Mode Indicates whether to keep or remove the specified token types.
	Mode *keeptypesmode.KeepTypesMode `json:"mode,omitempty"`
	Type string                       `json:"type,omitempty"`
	// Types List of token types to keep or remove.
	Types   []string `json:"types"`
	Version *string  `json:"version,omitempty"`
}

KeepTypesTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L287-L293

func NewKeepTypesTokenFilter added in v8.5.0 

func NewKeepTypesTokenFilter() *KeepTypesTokenFilter

NewKeepTypesTokenFilter returns a KeepTypesTokenFilter.

func (KeepTypesTokenFilter) MarshalJSON added in v8.9.0 

func (s KeepTypesTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeepTypesTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KeepTypesTokenFilter) UnmarshalJSON(data []byte) error

type KeepWordsTokenFilter 

type KeepWordsTokenFilter struct {
	// KeepWords List of words to keep. Only tokens that match words in this list are included
	// in the output.
	// Either this parameter or `keep_words_path` must be specified.
	KeepWords []string `json:"keep_words,omitempty"`
	// KeepWordsCase If `true`, lowercase all keep words. Defaults to `false`.
	KeepWordsCase *bool `json:"keep_words_case,omitempty"`
	// KeepWordsPath Path to a file that contains a list of words to keep. Only tokens that match
	// words in this list are included in the output.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each word in the file must be separated by a line
	// break.
	// Either this parameter or `keep_words` must be specified.
	KeepWordsPath *string `json:"keep_words_path,omitempty"`
	Type          string  `json:"type,omitempty"`
	Version       *string `json:"version,omitempty"`
}

KeepWordsTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L295-L306

func NewKeepWordsTokenFilter added in v8.5.0 

func NewKeepWordsTokenFilter() *KeepWordsTokenFilter

NewKeepWordsTokenFilter returns a KeepWordsTokenFilter.

func (KeepWordsTokenFilter) MarshalJSON added in v8.9.0 

func (s KeepWordsTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeepWordsTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KeepWordsTokenFilter) UnmarshalJSON(data []byte) error

type KeyValueProcessor 

type KeyValueProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// ExcludeKeys List of keys to exclude from document.
	ExcludeKeys []string `json:"exclude_keys,omitempty"`
	// Field The field to be parsed.
	// Supports template snippets.
	Field string `json:"field"`
	// FieldSplit Regex pattern to use for splitting key-value pairs.
	FieldSplit string `json:"field_split"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// IncludeKeys List of keys to filter and insert into document.
	// Defaults to including all keys.
	IncludeKeys []string `json:"include_keys,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Prefix Prefix to be added to extracted keys.
	Prefix *string `json:"prefix,omitempty"`
	// StripBrackets If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from
	// extracted values.
	StripBrackets *bool `json:"strip_brackets,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to insert the extracted keys into.
	// Defaults to the root of the document.
	// Supports template snippets.
	TargetField *string `json:"target_field,omitempty"`
	// TrimKey String of characters to trim from extracted keys.
	TrimKey *string `json:"trim_key,omitempty"`
	// TrimValue String of characters to trim from extracted values.
	TrimValue *string `json:"trim_value,omitempty"`
	// ValueSplit Regex pattern to use for splitting the key from the value within a key-value
	// pair.
	ValueSplit string `json:"value_split"`
}

KeyValueProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1176-L1228

func NewKeyValueProcessor added in v8.5.0 

func NewKeyValueProcessor() *KeyValueProcessor

NewKeyValueProcessor returns a KeyValueProcessor.

func (*KeyValueProcessor) UnmarshalJSON added in v8.7.1 

func (s *KeyValueProcessor) UnmarshalJSON(data []byte) error

type KeyedPercentiles 

type KeyedPercentiles map[string]string

KeyedPercentiles type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L160-L160

func (KeyedPercentiles) UnmarshalJSON added in v8.7.1 

func (s KeyedPercentiles) UnmarshalJSON(data []byte) error

type KeyedProcessor 

type KeyedProcessor struct {
	Stats *Processor `json:"stats,omitempty"`
	Type  *string    `json:"type,omitempty"`
}

KeyedProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L415-L418

func NewKeyedProcessor added in v8.5.0 

func NewKeyedProcessor() *KeyedProcessor

NewKeyedProcessor returns a KeyedProcessor.

func (*KeyedProcessor) UnmarshalJSON added in v8.9.0 

func (s *KeyedProcessor) UnmarshalJSON(data []byte) error

type KeywordAnalyzer 

type KeywordAnalyzer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

KeywordAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L47-L50

func NewKeywordAnalyzer added in v8.5.0 

func NewKeywordAnalyzer() *KeywordAnalyzer

NewKeywordAnalyzer returns a KeywordAnalyzer.

func (KeywordAnalyzer) MarshalJSON added in v8.9.0 

func (s KeywordAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeywordAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *KeywordAnalyzer) UnmarshalJSON(data []byte) error

type KeywordMarkerTokenFilter 

type KeywordMarkerTokenFilter struct {
	// IgnoreCase If `true`, matching for the `keywords` and `keywords_path` parameters ignores
	// letter case. Defaults to `false`.
	IgnoreCase *bool `json:"ignore_case,omitempty"`
	// Keywords Array of keywords. Tokens that match these keywords are not stemmed.
	// This parameter, `keywords_path`, or `keywords_pattern` must be specified. You
	// cannot specify this parameter and `keywords_pattern`.
	Keywords []string `json:"keywords,omitempty"`
	// KeywordsPath Path to a file that contains a list of keywords. Tokens that match these
	// keywords are not stemmed.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each word in the file must be separated by a line
	// break.
	// This parameter, `keywords`, or `keywords_pattern` must be specified. You
	// cannot specify this parameter and `keywords_pattern`.
	KeywordsPath *string `json:"keywords_path,omitempty"`
	// KeywordsPattern Java regular expression used to match tokens. Tokens that match this
	// expression are marked as keywords and not stemmed.
	// This parameter, `keywords`, or `keywords_path` must be specified. You cannot
	// specify this parameter and `keywords` or `keywords_pattern`.
	KeywordsPattern *string `json:"keywords_pattern,omitempty"`
	Type            string  `json:"type,omitempty"`
	Version         *string `json:"version,omitempty"`
}

KeywordMarkerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L308-L322

func NewKeywordMarkerTokenFilter added in v8.5.0 

func NewKeywordMarkerTokenFilter() *KeywordMarkerTokenFilter

NewKeywordMarkerTokenFilter returns a KeywordMarkerTokenFilter.

func (KeywordMarkerTokenFilter) MarshalJSON added in v8.9.0 

func (s KeywordMarkerTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeywordMarkerTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KeywordMarkerTokenFilter) UnmarshalJSON(data []byte) error

type KeywordProperty 

type KeywordProperty struct {
	Boost               *Float64                       `json:"boost,omitempty"`
	CopyTo              []string                       `json:"copy_to,omitempty"`
	DocValues           *bool                          `json:"doc_values,omitempty"`
	Dynamic             *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EagerGlobalOrdinals *bool                          `json:"eager_global_ordinals,omitempty"`
	Fields              map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove         *int                           `json:"ignore_above,omitempty"`
	Index               *bool                          `json:"index,omitempty"`
	IndexOptions        *indexoptions.IndexOptions     `json:"index_options,omitempty"`
	// Meta Metadata about the field.
	Meta                     map[string]string                                `json:"meta,omitempty"`
	Normalizer               *string                                          `json:"normalizer,omitempty"`
	Norms                    *bool                                            `json:"norms,omitempty"`
	NullValue                *string                                          `json:"null_value,omitempty"`
	OnScriptError            *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties               map[string]Property                              `json:"properties,omitempty"`
	Script                   *Script                                          `json:"script,omitempty"`
	Similarity               *string                                          `json:"similarity,omitempty"`
	SplitQueriesOnWhitespace *bool                                            `json:"split_queries_on_whitespace,omitempty"`
	Store                    *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep      *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool  `json:"time_series_dimension,omitempty"`
	Type                string `json:"type,omitempty"`
}

KeywordProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L107-L126

func NewKeywordProperty added in v8.5.0 

func NewKeywordProperty() *KeywordProperty

NewKeywordProperty returns a KeywordProperty.

func (KeywordProperty) MarshalJSON added in v8.9.0 

func (s KeywordProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeywordProperty) UnmarshalJSON added in v8.7.0 

func (s *KeywordProperty) UnmarshalJSON(data []byte) error

type KeywordRepeatTokenFilter added in v8.18.1 

type KeywordRepeatTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

KeywordRepeatTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L501-L503

func NewKeywordRepeatTokenFilter added in v8.18.1 

func NewKeywordRepeatTokenFilter() *KeywordRepeatTokenFilter

NewKeywordRepeatTokenFilter returns a KeywordRepeatTokenFilter.

func (KeywordRepeatTokenFilter) MarshalJSON added in v8.18.1 

func (s KeywordRepeatTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeywordRepeatTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *KeywordRepeatTokenFilter) UnmarshalJSON(data []byte) error

type KeywordTokenizer 

type KeywordTokenizer struct {
	BufferSize *int    `json:"buffer_size,omitempty"`
	Type       string  `json:"type,omitempty"`
	Version    *string `json:"version,omitempty"`
}

KeywordTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L68-L74

func NewKeywordTokenizer added in v8.5.0 

func NewKeywordTokenizer() *KeywordTokenizer

NewKeywordTokenizer returns a KeywordTokenizer.

func (KeywordTokenizer) MarshalJSON added in v8.9.0 

func (s KeywordTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KeywordTokenizer) UnmarshalJSON added in v8.7.1 

func (s *KeywordTokenizer) UnmarshalJSON(data []byte) error

type KibanaToken added in v8.5.0 

type KibanaToken struct {
	// Name The name of the bearer token for the `elastic/kibana` service account.
	Name string `json:"name"`
	// Value The value of the bearer token for the `elastic/kibana` service account.
	// Use this value to authenticate the service account with Elasticsearch.
	Value string `json:"value"`
}

KibanaToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/enroll_kibana/Response.ts#L31-L41

func NewKibanaToken added in v8.5.0 

func NewKibanaToken() *KibanaToken

NewKibanaToken returns a KibanaToken.

func (*KibanaToken) UnmarshalJSON added in v8.9.0 

func (s *KibanaToken) UnmarshalJSON(data []byte) error

type KnnCollectorResult added in v8.16.0 

type KnnCollectorResult struct {
	Children    []KnnCollectorResult `json:"children,omitempty"`
	Name        string               `json:"name"`
	Reason      string               `json:"reason"`
	Time        Duration             `json:"time,omitempty"`
	TimeInNanos int64                `json:"time_in_nanos"`
}

KnnCollectorResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L222-L228

func NewKnnCollectorResult added in v8.16.0 

func NewKnnCollectorResult() *KnnCollectorResult

NewKnnCollectorResult returns a KnnCollectorResult.

func (*KnnCollectorResult) UnmarshalJSON added in v8.16.0 

func (s *KnnCollectorResult) UnmarshalJSON(data []byte) error

type KnnQuery 

type KnnQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field The name of the vector field to search against
	Field string `json:"field"`
	// Filter Filters for the kNN search query
	Filter []Query `json:"filter,omitempty"`
	// K The final number of nearest neighbors to return as top hits
	K *int `json:"k,omitempty"`
	// NumCandidates The number of nearest neighbor candidates to consider per shard
	NumCandidates *int    `json:"num_candidates,omitempty"`
	QueryName_    *string `json:"_name,omitempty"`
	// QueryVector The query vector
	QueryVector []float32 `json:"query_vector,omitempty"`
	// QueryVectorBuilder The query vector builder. You must provide a query_vector_builder or
	// query_vector, but not both.
	QueryVectorBuilder *QueryVectorBuilder `json:"query_vector_builder,omitempty"`
	// RescoreVector Apply oversampling and rescoring to quantized vectors *
	RescoreVector *RescoreVector `json:"rescore_vector,omitempty"`
	// Similarity The minimum similarity for a vector to be considered a match
	Similarity *float32 `json:"similarity,omitempty"`
}

KnnQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Knn.ts#L64-L87

func NewKnnQuery added in v8.5.0 

func NewKnnQuery() *KnnQuery

NewKnnQuery returns a KnnQuery.

func (*KnnQuery) UnmarshalJSON added in v8.7.1 

func (s *KnnQuery) UnmarshalJSON(data []byte) error

type KnnQueryProfileBreakdown added in v8.16.0 

type KnnQueryProfileBreakdown struct {
	Advance                     int64 `json:"advance"`
	AdvanceCount                int64 `json:"advance_count"`
	BuildScorer                 int64 `json:"build_scorer"`
	BuildScorerCount            int64 `json:"build_scorer_count"`
	ComputeMaxScore             int64 `json:"compute_max_score"`
	ComputeMaxScoreCount        int64 `json:"compute_max_score_count"`
	CountWeight                 int64 `json:"count_weight"`
	CountWeightCount            int64 `json:"count_weight_count"`
	CreateWeight                int64 `json:"create_weight"`
	CreateWeightCount           int64 `json:"create_weight_count"`
	Match                       int64 `json:"match"`
	MatchCount                  int64 `json:"match_count"`
	NextDoc                     int64 `json:"next_doc"`
	NextDocCount                int64 `json:"next_doc_count"`
	Score                       int64 `json:"score"`
	ScoreCount                  int64 `json:"score_count"`
	SetMinCompetitiveScore      int64 `json:"set_min_competitive_score"`
	SetMinCompetitiveScoreCount int64 `json:"set_min_competitive_score_count"`
	ShallowAdvance              int64 `json:"shallow_advance"`
	ShallowAdvanceCount         int64 `json:"shallow_advance_count"`
}

KnnQueryProfileBreakdown type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L199-L220

func NewKnnQueryProfileBreakdown added in v8.16.0 

func NewKnnQueryProfileBreakdown() *KnnQueryProfileBreakdown

NewKnnQueryProfileBreakdown returns a KnnQueryProfileBreakdown.

func (*KnnQueryProfileBreakdown) UnmarshalJSON added in v8.16.0 

func (s *KnnQueryProfileBreakdown) UnmarshalJSON(data []byte) error

type KnnQueryProfileResult added in v8.16.0 

type KnnQueryProfileResult struct {
	Breakdown   KnnQueryProfileBreakdown   `json:"breakdown"`
	Children    []KnnQueryProfileResult    `json:"children,omitempty"`
	Debug       map[string]json.RawMessage `json:"debug,omitempty"`
	Description string                     `json:"description"`
	Time        Duration                   `json:"time,omitempty"`
	TimeInNanos int64                      `json:"time_in_nanos"`
	Type        string                     `json:"type"`
}

KnnQueryProfileResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L188-L196

func NewKnnQueryProfileResult added in v8.16.0 

func NewKnnQueryProfileResult() *KnnQueryProfileResult

NewKnnQueryProfileResult returns a KnnQueryProfileResult.

func (*KnnQueryProfileResult) UnmarshalJSON added in v8.16.0 

func (s *KnnQueryProfileResult) UnmarshalJSON(data []byte) error

type KnnRetriever added in v8.14.0 

type KnnRetriever struct {
	// Field The name of the vector field to search against.
	Field string `json:"field"`
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// K Number of nearest neighbors to return as top hits.
	K int `json:"k"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_ *string `json:"_name,omitempty"`
	// NumCandidates Number of nearest neighbor candidates to consider per shard.
	NumCandidates int `json:"num_candidates"`
	// QueryVector Query vector. Must have the same number of dimensions as the vector field you
	// are searching against. You must provide a query_vector_builder or
	// query_vector, but not both.
	QueryVector []float32 `json:"query_vector,omitempty"`
	// QueryVectorBuilder Defines a model to build a query vector.
	QueryVectorBuilder *QueryVectorBuilder `json:"query_vector_builder,omitempty"`
	// RescoreVector Apply oversampling and rescoring to quantized vectors *
	RescoreVector *RescoreVector `json:"rescore_vector,omitempty"`
	// Similarity The minimum similarity required for a document to be considered a match.
	Similarity *float32 `json:"similarity,omitempty"`
}

KnnRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L111-L129

func NewKnnRetriever added in v8.14.0 

func NewKnnRetriever() *KnnRetriever

NewKnnRetriever returns a KnnRetriever.

func (*KnnRetriever) UnmarshalJSON added in v8.14.0 

func (s *KnnRetriever) UnmarshalJSON(data []byte) error

type KnnSearch added in v8.14.0 

type KnnSearch struct {
	// Boost Boost value to apply to kNN scores
	Boost *float32 `json:"boost,omitempty"`
	// Field The name of the vector field to search against
	Field string `json:"field"`
	// Filter Filters for the kNN search query
	Filter []Query `json:"filter,omitempty"`
	// InnerHits If defined, each search hit will contain inner hits.
	InnerHits *InnerHits `json:"inner_hits,omitempty"`
	// K The final number of nearest neighbors to return as top hits
	K *int `json:"k,omitempty"`
	// NumCandidates The number of nearest neighbor candidates to consider per shard
	NumCandidates *int `json:"num_candidates,omitempty"`
	// QueryVector The query vector
	QueryVector []float32 `json:"query_vector,omitempty"`
	// QueryVectorBuilder The query vector builder. You must provide a query_vector_builder or
	// query_vector, but not both.
	QueryVectorBuilder *QueryVectorBuilder `json:"query_vector_builder,omitempty"`
	// RescoreVector Apply oversampling and rescoring to quantized vectors *
	RescoreVector *RescoreVector `json:"rescore_vector,omitempty"`
	// Similarity The minimum similarity for a vector to be considered a match
	Similarity *float32 `json:"similarity,omitempty"`
}

KnnSearch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Knn.ts#L35-L62

func NewKnnSearch added in v8.14.0 

func NewKnnSearch() *KnnSearch

NewKnnSearch returns a KnnSearch.

func (*KnnSearch) UnmarshalJSON added in v8.14.0 

func (s *KnnSearch) UnmarshalJSON(data []byte) error

type KuromojiAnalyzer 

type KuromojiAnalyzer struct {
	Mode           kuromojitokenizationmode.KuromojiTokenizationMode `json:"mode"`
	Type           string                                            `json:"type,omitempty"`
	UserDictionary *string                                           `json:"user_dictionary,omitempty"`
}

KuromojiAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L26-L30

func NewKuromojiAnalyzer added in v8.5.0 

func NewKuromojiAnalyzer() *KuromojiAnalyzer

NewKuromojiAnalyzer returns a KuromojiAnalyzer.

func (KuromojiAnalyzer) MarshalJSON added in v8.9.0 

func (s KuromojiAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiAnalyzer) UnmarshalJSON added in v8.9.0 

func (s *KuromojiAnalyzer) UnmarshalJSON(data []byte) error

type KuromojiIterationMarkCharFilter 

type KuromojiIterationMarkCharFilter struct {
	NormalizeKana  bool    `json:"normalize_kana"`
	NormalizeKanji bool    `json:"normalize_kanji"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

KuromojiIterationMarkCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L37-L41

func NewKuromojiIterationMarkCharFilter added in v8.5.0 

func NewKuromojiIterationMarkCharFilter() *KuromojiIterationMarkCharFilter

NewKuromojiIterationMarkCharFilter returns a KuromojiIterationMarkCharFilter.

func (KuromojiIterationMarkCharFilter) MarshalJSON added in v8.9.0 

func (s KuromojiIterationMarkCharFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiIterationMarkCharFilter) UnmarshalJSON added in v8.7.1 

func (s *KuromojiIterationMarkCharFilter) UnmarshalJSON(data []byte) error

type KuromojiPartOfSpeechTokenFilter 

type KuromojiPartOfSpeechTokenFilter struct {
	Stoptags []string `json:"stoptags"`
	Type     string   `json:"type,omitempty"`
	Version  *string  `json:"version,omitempty"`
}

KuromojiPartOfSpeechTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L43-L46

func NewKuromojiPartOfSpeechTokenFilter added in v8.5.0 

func NewKuromojiPartOfSpeechTokenFilter() *KuromojiPartOfSpeechTokenFilter

NewKuromojiPartOfSpeechTokenFilter returns a KuromojiPartOfSpeechTokenFilter.

func (KuromojiPartOfSpeechTokenFilter) MarshalJSON added in v8.9.0 

func (s KuromojiPartOfSpeechTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiPartOfSpeechTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KuromojiPartOfSpeechTokenFilter) UnmarshalJSON(data []byte) error

type KuromojiReadingFormTokenFilter 

type KuromojiReadingFormTokenFilter struct {
	Type      string  `json:"type,omitempty"`
	UseRomaji bool    `json:"use_romaji"`
	Version   *string `json:"version,omitempty"`
}

KuromojiReadingFormTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L48-L51

func NewKuromojiReadingFormTokenFilter added in v8.5.0 

func NewKuromojiReadingFormTokenFilter() *KuromojiReadingFormTokenFilter

NewKuromojiReadingFormTokenFilter returns a KuromojiReadingFormTokenFilter.

func (KuromojiReadingFormTokenFilter) MarshalJSON added in v8.9.0 

func (s KuromojiReadingFormTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiReadingFormTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KuromojiReadingFormTokenFilter) UnmarshalJSON(data []byte) error

type KuromojiStemmerTokenFilter 

type KuromojiStemmerTokenFilter struct {
	MinimumLength int     `json:"minimum_length"`
	Type          string  `json:"type,omitempty"`
	Version       *string `json:"version,omitempty"`
}

KuromojiStemmerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L53-L56

func NewKuromojiStemmerTokenFilter added in v8.5.0 

func NewKuromojiStemmerTokenFilter() *KuromojiStemmerTokenFilter

NewKuromojiStemmerTokenFilter returns a KuromojiStemmerTokenFilter.

func (KuromojiStemmerTokenFilter) MarshalJSON added in v8.9.0 

func (s KuromojiStemmerTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiStemmerTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *KuromojiStemmerTokenFilter) UnmarshalJSON(data []byte) error

type KuromojiTokenizer 

type KuromojiTokenizer struct {
	DiscardCompoundToken *bool                                             `json:"discard_compound_token,omitempty"`
	DiscardPunctuation   *bool                                             `json:"discard_punctuation,omitempty"`
	Mode                 kuromojitokenizationmode.KuromojiTokenizationMode `json:"mode"`
	NbestCost            *int                                              `json:"nbest_cost,omitempty"`
	NbestExamples        *string                                           `json:"nbest_examples,omitempty"`
	Type                 string                                            `json:"type,omitempty"`
	UserDictionary       *string                                           `json:"user_dictionary,omitempty"`
	UserDictionaryRules  []string                                          `json:"user_dictionary_rules,omitempty"`
	Version              *string                                           `json:"version,omitempty"`
}

KuromojiTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/kuromoji-plugin.ts#L64-L73

func NewKuromojiTokenizer added in v8.5.0 

func NewKuromojiTokenizer() *KuromojiTokenizer

NewKuromojiTokenizer returns a KuromojiTokenizer.

func (KuromojiTokenizer) MarshalJSON added in v8.9.0 

func (s KuromojiTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*KuromojiTokenizer) UnmarshalJSON added in v8.7.1 

func (s *KuromojiTokenizer) UnmarshalJSON(data []byte) error

type LanguageContext 

type LanguageContext struct {
	Contexts []string                      `json:"contexts"`
	Language scriptlanguage.ScriptLanguage `json:"language"`
}

LanguageContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/get_script_languages/types.ts#L22-L25

func NewLanguageContext added in v8.5.0 

func NewLanguageContext() *LanguageContext

NewLanguageContext returns a LanguageContext.

type LaplaceSmoothingModel 

type LaplaceSmoothingModel struct {
	// Alpha A constant that is added to all counts to balance weights.
	Alpha Float64 `json:"alpha"`
}

LaplaceSmoothingModel type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L430-L435

func NewLaplaceSmoothingModel added in v8.5.0 

func NewLaplaceSmoothingModel() *LaplaceSmoothingModel

NewLaplaceSmoothingModel returns a LaplaceSmoothingModel.

func (*LaplaceSmoothingModel) UnmarshalJSON added in v8.7.1 

func (s *LaplaceSmoothingModel) UnmarshalJSON(data []byte) error

type LatLonGeoLocation 

type LatLonGeoLocation struct {
	// Lat Latitude
	Lat Float64 `json:"lat"`
	// Lon Longitude
	Lon Float64 `json:"lon"`
}

LatLonGeoLocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L120-L129

func NewLatLonGeoLocation added in v8.5.0 

func NewLatLonGeoLocation() *LatLonGeoLocation

NewLatLonGeoLocation returns a LatLonGeoLocation.

func (*LatLonGeoLocation) UnmarshalJSON added in v8.7.1 

func (s *LatLonGeoLocation) UnmarshalJSON(data []byte) error

type Latest 

type Latest struct {
	// Sort Specifies the date field that is used to identify the latest documents.
	Sort string `json:"sort"`
	// UniqueKey Specifies an array of one or more fields that are used to group the data.
	UniqueKey []string `json:"unique_key"`
}

Latest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L47-L52

func NewLatest added in v8.5.0 

func NewLatest() *Latest

NewLatest returns a Latest.

func (*Latest) UnmarshalJSON added in v8.7.1 

func (s *Latest) UnmarshalJSON(data []byte) error

type LatvianAnalyzer added in v8.16.0 

type LatvianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

LatvianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L214-L219

func NewLatvianAnalyzer added in v8.16.0 

func NewLatvianAnalyzer() *LatvianAnalyzer

NewLatvianAnalyzer returns a LatvianAnalyzer.

func (LatvianAnalyzer) MarshalJSON added in v8.16.0 

func (s LatvianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LatvianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *LatvianAnalyzer) UnmarshalJSON(data []byte) error

type LearningToRank added in v8.14.0 

type LearningToRank struct {
	// ModelId The unique identifier of the trained model uploaded to Elasticsearch
	ModelId string `json:"model_id"`
	// Params Named parameters to be passed to the query templates used for feature
	Params map[string]json.RawMessage `json:"params,omitempty"`
}

LearningToRank type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/rescoring.ts#L88-L97

func NewLearningToRank added in v8.14.0 

func NewLearningToRank() *LearningToRank

NewLearningToRank returns a LearningToRank.

func (*LearningToRank) UnmarshalJSON added in v8.14.0 

func (s *LearningToRank) UnmarshalJSON(data []byte) error

type LearningToRankConfig added in v8.18.0 

type LearningToRankConfig struct {
	DefaultParams                 map[string]json.RawMessage         `json:"default_params,omitempty"`
	FeatureExtractors             []map[string]QueryFeatureExtractor `json:"feature_extractors,omitempty"`
	NumTopFeatureImportanceValues int                                `json:"num_top_feature_importance_values"`
}

LearningToRankConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L87-L91

func NewLearningToRankConfig added in v8.18.0 

func NewLearningToRankConfig() *LearningToRankConfig

NewLearningToRankConfig returns a LearningToRankConfig.

func (*LearningToRankConfig) UnmarshalJSON added in v8.18.0 

func (s *LearningToRankConfig) UnmarshalJSON(data []byte) error

type LengthTokenFilter 

type LengthTokenFilter struct {
	// Max Maximum character length of a token. Longer tokens are excluded from the
	// output. Defaults to `Integer.MAX_VALUE`, which is `2^31-1` or `2147483647`.
	Max *int `json:"max,omitempty"`
	// Min Minimum character length of a token. Shorter tokens are excluded from the
	// output. Defaults to `0`.
	Min     *int    `json:"min,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

LengthTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L328-L334

func NewLengthTokenFilter added in v8.5.0 

func NewLengthTokenFilter() *LengthTokenFilter

NewLengthTokenFilter returns a LengthTokenFilter.

func (LengthTokenFilter) MarshalJSON added in v8.9.0 

func (s LengthTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LengthTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *LengthTokenFilter) UnmarshalJSON(data []byte) error

type LessThanValidation added in v8.15.0 

type LessThanValidation struct {
	Constraint Float64 `json:"constraint"`
	Type       string  `json:"type,omitempty"`
}

LessThanValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L58-L61

func NewLessThanValidation added in v8.15.0 

func NewLessThanValidation() *LessThanValidation

NewLessThanValidation returns a LessThanValidation.

func (LessThanValidation) MarshalJSON added in v8.15.0 

func (s LessThanValidation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LessThanValidation) UnmarshalJSON added in v8.15.0 

func (s *LessThanValidation) UnmarshalJSON(data []byte) error

type LetterTokenizer 

type LetterTokenizer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

LetterTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L76-L78

func NewLetterTokenizer added in v8.5.0 

func NewLetterTokenizer() *LetterTokenizer

NewLetterTokenizer returns a LetterTokenizer.

func (LetterTokenizer) MarshalJSON added in v8.9.0 

func (s LetterTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LetterTokenizer) UnmarshalJSON added in v8.7.1 

func (s *LetterTokenizer) UnmarshalJSON(data []byte) error

type License 

type License struct {
	ExpiryDateInMillis int64                   `json:"expiry_date_in_millis"`
	IssueDateInMillis  int64                   `json:"issue_date_in_millis"`
	IssuedTo           string                  `json:"issued_to"`
	Issuer             string                  `json:"issuer"`
	MaxNodes           *int64                  `json:"max_nodes,omitempty"`
	MaxResourceUnits   *int64                  `json:"max_resource_units,omitempty"`
	Signature          string                  `json:"signature"`
	StartDateInMillis  *int64                  `json:"start_date_in_millis,omitempty"`
	Type               licensetype.LicenseType `json:"type"`
	Uid                string                  `json:"uid"`
}

License type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/license/_types/License.ts#L42-L53

func NewLicense added in v8.5.0 

func NewLicense() *License

NewLicense returns a License.

func (*License) UnmarshalJSON added in v8.7.1 

func (s *License) UnmarshalJSON(data []byte) error

type LicenseInformation 

type LicenseInformation struct {
	ExpiryDate         DateTime                    `json:"expiry_date,omitempty"`
	ExpiryDateInMillis *int64                      `json:"expiry_date_in_millis,omitempty"`
	IssueDate          DateTime                    `json:"issue_date"`
	IssueDateInMillis  int64                       `json:"issue_date_in_millis"`
	IssuedTo           string                      `json:"issued_to"`
	Issuer             string                      `json:"issuer"`
	MaxNodes           *int64                      `json:"max_nodes,omitempty"`
	MaxResourceUnits   *int                        `json:"max_resource_units,omitempty"`
	StartDateInMillis  int64                       `json:"start_date_in_millis"`
	Status             licensestatus.LicenseStatus `json:"status"`
	Type               licensetype.LicenseType     `json:"type"`
	Uid                string                      `json:"uid"`
}

LicenseInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/license/get/types.ts#L25-L38

func NewLicenseInformation added in v8.5.0 

func NewLicenseInformation() *LicenseInformation

NewLicenseInformation returns a LicenseInformation.

func (*LicenseInformation) UnmarshalJSON added in v8.7.1 

func (s *LicenseInformation) UnmarshalJSON(data []byte) error

type Lifecycle 

type Lifecycle struct {
	ModifiedDate DateTime  `json:"modified_date"`
	Policy       IlmPolicy `json:"policy"`
	Version      int64     `json:"version"`
}

Lifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/get_lifecycle/types.ts#L24-L28

func NewLifecycle added in v8.5.0 

func NewLifecycle() *Lifecycle

NewLifecycle returns a Lifecycle.

func (*Lifecycle) UnmarshalJSON added in v8.7.1 

func (s *Lifecycle) UnmarshalJSON(data []byte) error

type LifecycleExplain 

type LifecycleExplain any

LifecycleExplain holds the union for the following types: 

LifecycleExplainManaged
LifecycleExplainUnmanaged

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/explain_lifecycle/types.ts#L64-L67

type LifecycleExplainManaged 

type LifecycleExplainManaged struct {
	Action                  *string                         `json:"action,omitempty"`
	ActionTime              DateTime                        `json:"action_time,omitempty"`
	ActionTimeMillis        *int64                          `json:"action_time_millis,omitempty"`
	Age                     Duration                        `json:"age,omitempty"`
	FailedStep              *string                         `json:"failed_step,omitempty"`
	FailedStepRetryCount    *int                            `json:"failed_step_retry_count,omitempty"`
	Index                   string                          `json:"index"`
	IndexCreationDate       DateTime                        `json:"index_creation_date,omitempty"`
	IndexCreationDateMillis *int64                          `json:"index_creation_date_millis,omitempty"`
	IsAutoRetryableError    *bool                           `json:"is_auto_retryable_error,omitempty"`
	LifecycleDate           DateTime                        `json:"lifecycle_date,omitempty"`
	LifecycleDateMillis     *int64                          `json:"lifecycle_date_millis,omitempty"`
	Managed                 bool                            `json:"managed,omitempty"`
	Phase                   *string                         `json:"phase,omitempty"`
	PhaseExecution          *LifecycleExplainPhaseExecution `json:"phase_execution,omitempty"`
	PhaseTime               DateTime                        `json:"phase_time,omitempty"`
	PhaseTimeMillis         *int64                          `json:"phase_time_millis,omitempty"`
	Policy                  *string                         `json:"policy,omitempty"`
	PreviousStepInfo        map[string]json.RawMessage      `json:"previous_step_info,omitempty"`
	RepositoryName          *string                         `json:"repository_name,omitempty"`
	ShrinkIndexName         *string                         `json:"shrink_index_name,omitempty"`
	SnapshotName            *string                         `json:"snapshot_name,omitempty"`
	Step                    *string                         `json:"step,omitempty"`
	StepInfo                map[string]json.RawMessage      `json:"step_info,omitempty"`
	StepTime                DateTime                        `json:"step_time,omitempty"`
	StepTimeMillis          *int64                          `json:"step_time_millis,omitempty"`
	TimeSinceIndexCreation  Duration                        `json:"time_since_index_creation,omitempty"`
}

LifecycleExplainManaged type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/explain_lifecycle/types.ts#L27-L57

func NewLifecycleExplainManaged added in v8.5.0 

func NewLifecycleExplainManaged() *LifecycleExplainManaged

NewLifecycleExplainManaged returns a LifecycleExplainManaged.

func (LifecycleExplainManaged) MarshalJSON added in v8.9.0 

func (s LifecycleExplainManaged) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LifecycleExplainManaged) UnmarshalJSON added in v8.7.1 

func (s *LifecycleExplainManaged) UnmarshalJSON(data []byte) error

type LifecycleExplainPhaseExecution 

type LifecycleExplainPhaseExecution struct {
	ModifiedDateInMillis int64  `json:"modified_date_in_millis"`
	PhaseDefinition      *Phase `json:"phase_definition,omitempty"`
	Policy               string `json:"policy"`
	Version              int64  `json:"version"`
}

LifecycleExplainPhaseExecution type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/explain_lifecycle/types.ts#L69-L74

func NewLifecycleExplainPhaseExecution added in v8.5.0 

func NewLifecycleExplainPhaseExecution() *LifecycleExplainPhaseExecution

NewLifecycleExplainPhaseExecution returns a LifecycleExplainPhaseExecution.

func (*LifecycleExplainPhaseExecution) UnmarshalJSON added in v8.7.1 

func (s *LifecycleExplainPhaseExecution) UnmarshalJSON(data []byte) error

type LifecycleExplainUnmanaged 

type LifecycleExplainUnmanaged struct {
	Index   string `json:"index"`
	Managed bool   `json:"managed,omitempty"`
}

LifecycleExplainUnmanaged type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/explain_lifecycle/types.ts#L59-L62

func NewLifecycleExplainUnmanaged added in v8.5.0 

func NewLifecycleExplainUnmanaged() *LifecycleExplainUnmanaged

NewLifecycleExplainUnmanaged returns a LifecycleExplainUnmanaged.

func (LifecycleExplainUnmanaged) MarshalJSON added in v8.9.0 

func (s LifecycleExplainUnmanaged) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LifecycleExplainUnmanaged) UnmarshalJSON added in v8.7.1 

func (s *LifecycleExplainUnmanaged) UnmarshalJSON(data []byte) error

type Like 

type Like any

Like holds the union for the following types: 

string
LikeDocument

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L198-L203

type LikeDocument 

type LikeDocument struct {
	// Doc A document not present in the index.
	Doc    json.RawMessage `json:"doc,omitempty"`
	Fields []string        `json:"fields,omitempty"`
	// Id_ ID of a document.
	Id_ *string `json:"_id,omitempty"`
	// Index_ Index of a document.
	Index_ *string `json:"_index,omitempty"`
	// PerFieldAnalyzer Overrides the default analyzer.
	PerFieldAnalyzer map[string]string        `json:"per_field_analyzer,omitempty"`
	Routing          *string                  `json:"routing,omitempty"`
	Version          *int64                   `json:"version,omitempty"`
	VersionType      *versiontype.VersionType `json:"version_type,omitempty"`
}

LikeDocument type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L174-L196

func NewLikeDocument added in v8.5.0 

func NewLikeDocument() *LikeDocument

NewLikeDocument returns a LikeDocument.

func (*LikeDocument) UnmarshalJSON added in v8.7.1 

func (s *LikeDocument) UnmarshalJSON(data []byte) error

type LimitTokenCountTokenFilter 

type LimitTokenCountTokenFilter struct {
	// ConsumeAllTokens If `true`, the limit filter exhausts the token stream, even if the
	// `max_token_count` has already been reached. Defaults to `false`.
	ConsumeAllTokens *bool `json:"consume_all_tokens,omitempty"`
	// MaxTokenCount Maximum number of tokens to keep. Once this limit is reached, any remaining
	// tokens are excluded from the output. Defaults to `1`.
	MaxTokenCount Stringifiedinteger `json:"max_token_count,omitempty"`
	Type          string             `json:"type,omitempty"`
	Version       *string            `json:"version,omitempty"`
}

LimitTokenCountTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L336-L342

func NewLimitTokenCountTokenFilter added in v8.5.0 

func NewLimitTokenCountTokenFilter() *LimitTokenCountTokenFilter

NewLimitTokenCountTokenFilter returns a LimitTokenCountTokenFilter.

func (LimitTokenCountTokenFilter) MarshalJSON added in v8.9.0 

func (s LimitTokenCountTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LimitTokenCountTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *LimitTokenCountTokenFilter) UnmarshalJSON(data []byte) error

type Limits 

type Limits struct {
	EffectiveMaxModelMemoryLimit ByteSize `json:"effective_max_model_memory_limit,omitempty"`
	MaxModelMemoryLimit          ByteSize `json:"max_model_memory_limit,omitempty"`
	MaxSingleMlNodeProcessors    *int     `json:"max_single_ml_node_processors,omitempty"`
	TotalMlMemory                ByteSize `json:"total_ml_memory"`
	TotalMlProcessors            *int     `json:"total_ml_processors,omitempty"`
}

Limits type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/info/types.ts#L34-L40

func NewLimits added in v8.5.0 

func NewLimits() *Limits

NewLimits returns a Limits.

func (*Limits) UnmarshalJSON added in v8.9.0 

func (s *Limits) UnmarshalJSON(data []byte) error

type LinearInterpolationSmoothingModel 

type LinearInterpolationSmoothingModel struct {
	BigramLambda  Float64 `json:"bigram_lambda"`
	TrigramLambda Float64 `json:"trigram_lambda"`
	UnigramLambda Float64 `json:"unigram_lambda"`
}

LinearInterpolationSmoothingModel type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L437-L441

func NewLinearInterpolationSmoothingModel added in v8.5.0 

func NewLinearInterpolationSmoothingModel() *LinearInterpolationSmoothingModel

NewLinearInterpolationSmoothingModel returns a LinearInterpolationSmoothingModel.

func (*LinearInterpolationSmoothingModel) UnmarshalJSON added in v8.7.1 

func (s *LinearInterpolationSmoothingModel) UnmarshalJSON(data []byte) error

type LinearMovingAverageAggregation 

type LinearMovingAverageAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	Minimize  *bool                `json:"minimize,omitempty"`
	Model     string               `json:"model,omitempty"`
	Predict   *int                 `json:"predict,omitempty"`
	Settings  EmptyObject          `json:"settings"`
	Window    *int                 `json:"window,omitempty"`
}

LinearMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L268-L271

func NewLinearMovingAverageAggregation added in v8.5.0 

func NewLinearMovingAverageAggregation() *LinearMovingAverageAggregation

NewLinearMovingAverageAggregation returns a LinearMovingAverageAggregation.

func (LinearMovingAverageAggregation) MarshalJSON added in v8.9.0 

func (s LinearMovingAverageAggregation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LinearMovingAverageAggregation) UnmarshalJSON added in v8.7.0 

func (s *LinearMovingAverageAggregation) UnmarshalJSON(data []byte) error

type LinearRetriever added in v8.18.1 

type LinearRetriever struct {
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_          *string `json:"_name,omitempty"`
	RankWindowSize int     `json:"rank_window_size"`
	// Retrievers Inner retrievers.
	Retrievers []InnerRetriever `json:"retrievers,omitempty"`
}

LinearRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L68-L72

func NewLinearRetriever added in v8.18.1 

func NewLinearRetriever() *LinearRetriever

NewLinearRetriever returns a LinearRetriever.

func (*LinearRetriever) UnmarshalJSON added in v8.18.1 

func (s *LinearRetriever) UnmarshalJSON(data []byte) error

type ListTypeValidation added in v8.15.0 

type ListTypeValidation struct {
	Constraint string `json:"constraint"`
	Type       string `json:"type,omitempty"`
}

ListTypeValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L68-L71

func NewListTypeValidation added in v8.15.0 

func NewListTypeValidation() *ListTypeValidation

NewListTypeValidation returns a ListTypeValidation.

func (ListTypeValidation) MarshalJSON added in v8.15.0 

func (s ListTypeValidation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ListTypeValidation) UnmarshalJSON added in v8.15.0 

func (s *ListTypeValidation) UnmarshalJSON(data []byte) error

type LithuanianAnalyzer added in v8.16.0 

type LithuanianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

LithuanianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L221-L226

func NewLithuanianAnalyzer added in v8.16.0 

func NewLithuanianAnalyzer() *LithuanianAnalyzer

NewLithuanianAnalyzer returns a LithuanianAnalyzer.

func (LithuanianAnalyzer) MarshalJSON added in v8.16.0 

func (s LithuanianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LithuanianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *LithuanianAnalyzer) UnmarshalJSON(data []byte) error

type Local added in v8.18.0 

type Local struct {
	Type string `json:"type"`
}

Local type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L63-L65

func NewLocal added in v8.18.0 

func NewLocal() *Local

NewLocal returns a Local.

func (*Local) UnmarshalJSON added in v8.18.0 

func (s *Local) UnmarshalJSON(data []byte) error

type LoggingAction 

type LoggingAction struct {
	Category *string `json:"category,omitempty"`
	Level    *string `json:"level,omitempty"`
	Text     string  `json:"text"`
}

LoggingAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L281-L285

func NewLoggingAction added in v8.5.0 

func NewLoggingAction() *LoggingAction

NewLoggingAction returns a LoggingAction.

func (*LoggingAction) UnmarshalJSON added in v8.9.0 

func (s *LoggingAction) UnmarshalJSON(data []byte) error

type LoggingResult 

type LoggingResult struct {
	LoggedText string `json:"logged_text"`
}

LoggingResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L287-L289

func NewLoggingResult added in v8.5.0 

func NewLoggingResult() *LoggingResult

NewLoggingResult returns a LoggingResult.

func (*LoggingResult) UnmarshalJSON added in v8.9.0 

func (s *LoggingResult) UnmarshalJSON(data []byte) error

type LogstashPipeline added in v8.5.0 

type LogstashPipeline struct {
	// Description A description of the pipeline.
	// This description is not used by Elasticsearch or Logstash.
	Description string `json:"description"`
	// LastModified The date the pipeline was last updated.
	// It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format.
	LastModified DateTime `json:"last_modified"`
	// Pipeline The configuration for the pipeline.
	Pipeline string `json:"pipeline"`
	// PipelineMetadata Optional metadata about the pipeline, which can have any contents.
	// This metadata is not generated or used by Elasticsearch or Logstash.
	PipelineMetadata PipelineMetadata `json:"pipeline_metadata"`
	// PipelineSettings Settings for the pipeline.
	// It supports only flat keys in dot notation.
	PipelineSettings PipelineSettings `json:"pipeline_settings"`
	// Username The user who last updated the pipeline.
	Username string `json:"username"`
}

LogstashPipeline type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/logstash/_types/Pipeline.ts#L60-L91

func NewLogstashPipeline added in v8.5.0 

func NewLogstashPipeline() *LogstashPipeline

NewLogstashPipeline returns a LogstashPipeline.

func (*LogstashPipeline) UnmarshalJSON added in v8.7.1 

func (s *LogstashPipeline) UnmarshalJSON(data []byte) error

type LongNumberProperty 

type LongNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *int64                                           `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

LongNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L175-L178

func NewLongNumberProperty added in v8.5.0 

func NewLongNumberProperty() *LongNumberProperty

NewLongNumberProperty returns a LongNumberProperty.

func (LongNumberProperty) MarshalJSON added in v8.9.0 

func (s LongNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LongNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *LongNumberProperty) UnmarshalJSON(data []byte) error

type LongRangeProperty 

type LongRangeProperty struct {
	Boost       *Float64                       `json:"boost,omitempty"`
	Coerce      *bool                          `json:"coerce,omitempty"`
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

LongRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/range.ts#L50-L52

func NewLongRangeProperty added in v8.5.0 

func NewLongRangeProperty() *LongRangeProperty

NewLongRangeProperty returns a LongRangeProperty.

func (LongRangeProperty) MarshalJSON added in v8.9.0 

func (s LongRangeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LongRangeProperty) UnmarshalJSON added in v8.7.0 

func (s *LongRangeProperty) UnmarshalJSON(data []byte) error

type LongRareTermsAggregate 

type LongRareTermsAggregate struct {
	Buckets BucketsLongRareTermsBucket `json:"buckets"`
	Meta    Metadata                   `json:"meta,omitempty"`
}

LongRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L471-L476

func NewLongRareTermsAggregate added in v8.5.0 

func NewLongRareTermsAggregate() *LongRareTermsAggregate

NewLongRareTermsAggregate returns a LongRareTermsAggregate.

func (*LongRareTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *LongRareTermsAggregate) UnmarshalJSON(data []byte) error

type LongRareTermsBucket 

type LongRareTermsBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          int64                `json:"key"`
	KeyAsString  *string              `json:"key_as_string,omitempty"`
}

LongRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L478-L481

func NewLongRareTermsBucket added in v8.5.0 

func NewLongRareTermsBucket() *LongRareTermsBucket

NewLongRareTermsBucket returns a LongRareTermsBucket.

func (LongRareTermsBucket) MarshalJSON 

func (s LongRareTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*LongRareTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *LongRareTermsBucket) UnmarshalJSON(data []byte) error

type LongTermsAggregate 

type LongTermsAggregate struct {
	Buckets                 BucketsLongTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata               `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

LongTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L439-L444

func NewLongTermsAggregate added in v8.5.0 

func NewLongTermsAggregate() *LongTermsAggregate

NewLongTermsAggregate returns a LongTermsAggregate.

func (*LongTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *LongTermsAggregate) UnmarshalJSON(data []byte) error

type LongTermsBucket 

type LongTermsBucket struct {
	Aggregations            map[string]Aggregate `json:"-"`
	DocCount                int64                `json:"doc_count"`
	DocCountErrorUpperBound *int64               `json:"doc_count_error_upper_bound,omitempty"`
	Key                     int64                `json:"key"`
	KeyAsString             *string              `json:"key_as_string,omitempty"`
}

LongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L446-L449

func NewLongTermsBucket added in v8.5.0 

func NewLongTermsBucket() *LongTermsBucket

NewLongTermsBucket returns a LongTermsBucket.

func (LongTermsBucket) MarshalJSON 

func (s LongTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*LongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *LongTermsBucket) UnmarshalJSON(data []byte) error

type LowercaseNormalizer 

type LowercaseNormalizer struct {
	Type string `json:"type,omitempty"`
}

LowercaseNormalizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/normalizers.ts#L26-L28

func NewLowercaseNormalizer added in v8.5.0 

func NewLowercaseNormalizer() *LowercaseNormalizer

NewLowercaseNormalizer returns a LowercaseNormalizer.

func (LowercaseNormalizer) MarshalJSON added in v8.9.0 

func (s LowercaseNormalizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type LowercaseProcessor 

type LowercaseProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to make lowercase.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

LowercaseProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1230-L1246

func NewLowercaseProcessor added in v8.5.0 

func NewLowercaseProcessor() *LowercaseProcessor

NewLowercaseProcessor returns a LowercaseProcessor.

func (*LowercaseProcessor) UnmarshalJSON added in v8.7.1 

func (s *LowercaseProcessor) UnmarshalJSON(data []byte) error

type LowercaseTokenFilter 

type LowercaseTokenFilter struct {
	// Language Language-specific lowercase token filter to use.
	Language *lowercasetokenfilterlanguages.LowercaseTokenFilterLanguages `json:"language,omitempty"`
	Type     string                                                       `json:"type,omitempty"`
	Version  *string                                                      `json:"version,omitempty"`
}

LowercaseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L350-L354

func NewLowercaseTokenFilter added in v8.5.0 

func NewLowercaseTokenFilter() *LowercaseTokenFilter

NewLowercaseTokenFilter returns a LowercaseTokenFilter.

func (LowercaseTokenFilter) MarshalJSON added in v8.9.0 

func (s LowercaseTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LowercaseTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *LowercaseTokenFilter) UnmarshalJSON(data []byte) error

type LowercaseTokenizer 

type LowercaseTokenizer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

LowercaseTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L80-L82

func NewLowercaseTokenizer added in v8.5.0 

func NewLowercaseTokenizer() *LowercaseTokenizer

NewLowercaseTokenizer returns a LowercaseTokenizer.

func (LowercaseTokenizer) MarshalJSON added in v8.9.0 

func (s LowercaseTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*LowercaseTokenizer) UnmarshalJSON added in v8.7.1 

func (s *LowercaseTokenizer) UnmarshalJSON(data []byte) error

type MLDatafeed added in v8.5.0 

type MLDatafeed struct {
	Aggregations map[string]Aggregations `json:"aggregations,omitempty"`
	// Authorization The security privileges that the datafeed uses to run its queries. If Elastic
	// Stack security features were disabled at the time of the most recent update
	// to the datafeed, this property is omitted.
	Authorization          *DatafeedAuthorization `json:"authorization,omitempty"`
	ChunkingConfig         *ChunkingConfig        `json:"chunking_config,omitempty"`
	DatafeedId             string                 `json:"datafeed_id"`
	DelayedDataCheckConfig DelayedDataCheckConfig `json:"delayed_data_check_config"`
	Frequency              Duration               `json:"frequency,omitempty"`
	Indexes                []string               `json:"indexes,omitempty"`
	Indices                []string               `json:"indices"`
	IndicesOptions         *IndicesOptions        `json:"indices_options,omitempty"`
	JobId                  string                 `json:"job_id"`
	MaxEmptySearches       *int                   `json:"max_empty_searches,omitempty"`
	Query                  Query                  `json:"query"`
	QueryDelay             Duration               `json:"query_delay,omitempty"`
	RuntimeMappings        RuntimeFields          `json:"runtime_mappings,omitempty"`
	ScriptFields           map[string]ScriptField `json:"script_fields,omitempty"`
	ScrollSize             *int                   `json:"scroll_size,omitempty"`
}

MLDatafeed type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L37-L61

func NewMLDatafeed added in v8.5.0 

func NewMLDatafeed() *MLDatafeed

NewMLDatafeed returns a MLDatafeed.

func (*MLDatafeed) UnmarshalJSON added in v8.7.1 

func (s *MLDatafeed) UnmarshalJSON(data []byte) error

type MLFilter added in v8.5.0 

type MLFilter struct {
	// Description A description of the filter.
	Description *string `json:"description,omitempty"`
	// FilterId A string that uniquely identifies a filter.
	FilterId string `json:"filter_id"`
	// Items An array of strings which is the filter item list.
	Items []string `json:"items"`
}

MLFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Filter.ts#L22-L29

func NewMLFilter added in v8.5.0 

func NewMLFilter() *MLFilter

NewMLFilter returns a MLFilter.

func (*MLFilter) UnmarshalJSON added in v8.7.1 

func (s *MLFilter) UnmarshalJSON(data []byte) error

type MTermVectorsOperation added in v8.5.0 

type MTermVectorsOperation struct {
	// Doc An artificial document (a document not present in the index) for which you
	// want to retrieve term vectors.
	Doc json.RawMessage `json:"doc,omitempty"`
	// FieldStatistics If `true`, the response includes the document count, sum of document
	// frequencies, and sum of total term frequencies.
	FieldStatistics *bool `json:"field_statistics,omitempty"`
	// Fields Comma-separated list or wildcard expressions of fields to include in the
	// statistics.
	// Used as the default list unless a specific field list is provided in the
	// `completion_fields` or `fielddata_fields` parameters.
	Fields []string `json:"fields,omitempty"`
	// Filter Filter terms based on their tf-idf scores.
	Filter *TermVectorsFilter `json:"filter,omitempty"`
	// Id_ The ID of the document.
	Id_ *string `json:"_id,omitempty"`
	// Index_ The index of the document.
	Index_ *string `json:"_index,omitempty"`
	// Offsets If `true`, the response includes term offsets.
	Offsets *bool `json:"offsets,omitempty"`
	// Payloads If `true`, the response includes term payloads.
	Payloads *bool `json:"payloads,omitempty"`
	// Positions If `true`, the response includes term positions.
	Positions *bool `json:"positions,omitempty"`
	// Routing Custom value used to route operations to a specific shard.
	Routing *string `json:"routing,omitempty"`
	// TermStatistics If true, the response includes term frequency and document frequency.
	TermStatistics *bool `json:"term_statistics,omitempty"`
	// Version If `true`, returns the document version as part of a hit.
	Version *int64 `json:"version,omitempty"`
	// VersionType Specific version type.
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

MTermVectorsOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/mtermvectors/types.ts#L35-L94

func NewMTermVectorsOperation added in v8.5.0 

func NewMTermVectorsOperation() *MTermVectorsOperation

NewMTermVectorsOperation returns a MTermVectorsOperation.

func (*MTermVectorsOperation) UnmarshalJSON added in v8.7.1 

func (s *MTermVectorsOperation) UnmarshalJSON(data []byte) error

type MachineLearning 

type MachineLearning struct {
	Available              bool                     `json:"available"`
	DataFrameAnalyticsJobs MlDataFrameAnalyticsJobs `json:"data_frame_analytics_jobs"`
	Datafeeds              map[string]XpackDatafeed `json:"datafeeds"`
	Enabled                bool                     `json:"enabled"`
	Inference              MlInference              `json:"inference"`
	// Jobs Job usage statistics. The `_all` entry is always present and gathers
	// statistics for all jobs.
	Jobs      map[string]JobUsage `json:"jobs"`
	NodeCount int                 `json:"node_count"`
}

MachineLearning type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L382-L389

func NewMachineLearning added in v8.5.0 

func NewMachineLearning() *MachineLearning

NewMachineLearning returns a MachineLearning.

func (*MachineLearning) UnmarshalJSON added in v8.7.1 

func (s *MachineLearning) UnmarshalJSON(data []byte) error

type ManageUserPrivileges 

type ManageUserPrivileges struct {
	Applications []string `json:"applications"`
}

ManageUserPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L438-L440

func NewManageUserPrivileges added in v8.5.0 

func NewManageUserPrivileges() *ManageUserPrivileges

NewManageUserPrivileges returns a ManageUserPrivileges.

type MapboxVectorTiles 

type MapboxVectorTiles []byte

MapboxVectorTiles type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Binary.ts#L21-L21

type MappingCharFilter 

type MappingCharFilter struct {
	Mappings     []string `json:"mappings,omitempty"`
	MappingsPath *string  `json:"mappings_path,omitempty"`
	Type         string   `json:"type,omitempty"`
	Version      *string  `json:"version,omitempty"`
}

MappingCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/char_filters.ts#L51-L55

func NewMappingCharFilter added in v8.5.0 

func NewMappingCharFilter() *MappingCharFilter

NewMappingCharFilter returns a MappingCharFilter.

func (MappingCharFilter) MarshalJSON added in v8.9.0 

func (s MappingCharFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*MappingCharFilter) UnmarshalJSON added in v8.7.1 

func (s *MappingCharFilter) UnmarshalJSON(data []byte) error

type MappingLimitSettings 

type MappingLimitSettings struct {
	Coerce          *bool                                `json:"coerce,omitempty"`
	Depth           *MappingLimitSettingsDepth           `json:"depth,omitempty"`
	DimensionFields *MappingLimitSettingsDimensionFields `json:"dimension_fields,omitempty"`
	FieldNameLength *MappingLimitSettingsFieldNameLength `json:"field_name_length,omitempty"`
	IgnoreMalformed string                               `json:"ignore_malformed,omitempty"`
	NestedFields    *MappingLimitSettingsNestedFields    `json:"nested_fields,omitempty"`
	NestedObjects   *MappingLimitSettingsNestedObjects   `json:"nested_objects,omitempty"`
	Source          *MappingLimitSettingsSourceFields    `json:"source,omitempty"`
	TotalFields     *MappingLimitSettingsTotalFields     `json:"total_fields,omitempty"`
}

MappingLimitSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L425-L439

func NewMappingLimitSettings added in v8.5.0 

func NewMappingLimitSettings() *MappingLimitSettings

NewMappingLimitSettings returns a MappingLimitSettings.

func (*MappingLimitSettings) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettings) UnmarshalJSON(data []byte) error

type MappingLimitSettingsDepth 

type MappingLimitSettingsDepth struct {
	// Limit The maximum depth for a field, which is measured as the number of inner
	// objects. For instance, if all fields are defined
	// at the root object level, then the depth is 1. If there is one object
	// mapping, then the depth is 2, etc.
	Limit *int64 `json:"limit,omitempty"`
}

MappingLimitSettingsDepth type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L460-L467

func NewMappingLimitSettingsDepth added in v8.5.0 

func NewMappingLimitSettingsDepth() *MappingLimitSettingsDepth

NewMappingLimitSettingsDepth returns a MappingLimitSettingsDepth.

func (*MappingLimitSettingsDepth) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsDepth) UnmarshalJSON(data []byte) error

type MappingLimitSettingsDimensionFields 

type MappingLimitSettingsDimensionFields struct {
	// Limit [preview] This functionality is in technical preview and may be changed or
	// removed in a future release.
	// Elastic will work to fix any issues, but features in technical preview are
	// not subject to the support SLA of official GA features.
	Limit *int64 `json:"limit,omitempty"`
}

MappingLimitSettingsDimensionFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L497-L503

func NewMappingLimitSettingsDimensionFields added in v8.5.0 

func NewMappingLimitSettingsDimensionFields() *MappingLimitSettingsDimensionFields

NewMappingLimitSettingsDimensionFields returns a MappingLimitSettingsDimensionFields.

func (*MappingLimitSettingsDimensionFields) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsDimensionFields) UnmarshalJSON(data []byte) error

type MappingLimitSettingsFieldNameLength 

type MappingLimitSettingsFieldNameLength struct {
	// Limit Setting for the maximum length of a field name. This setting isn’t really
	// something that addresses mappings explosion but
	// might still be useful if you want to limit the field length. It usually
	// shouldn’t be necessary to set this setting. The
	// default is okay unless a user starts to add a huge number of fields with
	// really long names. Default is `Long.MAX_VALUE` (no limit).
	Limit *int64 `json:"limit,omitempty"`
}

MappingLimitSettingsFieldNameLength type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L488-L495

func NewMappingLimitSettingsFieldNameLength added in v8.5.0 

func NewMappingLimitSettingsFieldNameLength() *MappingLimitSettingsFieldNameLength

NewMappingLimitSettingsFieldNameLength returns a MappingLimitSettingsFieldNameLength.

func (*MappingLimitSettingsFieldNameLength) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsFieldNameLength) UnmarshalJSON(data []byte) error

type MappingLimitSettingsNestedFields 

type MappingLimitSettingsNestedFields struct {
	// Limit The maximum number of distinct nested mappings in an index. The nested type
	// should only be used in special cases, when
	// arrays of objects need to be queried independently of each other. To
	// safeguard against poorly designed mappings, this
	// setting limits the number of unique nested types per index.
	Limit *int64 `json:"limit,omitempty"`
}

MappingLimitSettingsNestedFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L469-L477

func NewMappingLimitSettingsNestedFields added in v8.5.0 

func NewMappingLimitSettingsNestedFields() *MappingLimitSettingsNestedFields

NewMappingLimitSettingsNestedFields returns a MappingLimitSettingsNestedFields.

func (*MappingLimitSettingsNestedFields) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsNestedFields) UnmarshalJSON(data []byte) error

type MappingLimitSettingsNestedObjects 

type MappingLimitSettingsNestedObjects struct {
	// Limit The maximum number of nested JSON objects that a single document can contain
	// across all nested types. This limit helps
	// to prevent out of memory errors when a document contains too many nested
	// objects.
	Limit *int64 `json:"limit,omitempty"`
}

MappingLimitSettingsNestedObjects type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L479-L486

func NewMappingLimitSettingsNestedObjects added in v8.5.0 

func NewMappingLimitSettingsNestedObjects() *MappingLimitSettingsNestedObjects

NewMappingLimitSettingsNestedObjects returns a MappingLimitSettingsNestedObjects.

func (*MappingLimitSettingsNestedObjects) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsNestedObjects) UnmarshalJSON(data []byte) error

type MappingLimitSettingsSourceFields added in v8.18.0 

type MappingLimitSettingsSourceFields struct {
	Mode sourcemode.SourceMode `json:"mode"`
}

MappingLimitSettingsSourceFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L505-L507

func NewMappingLimitSettingsSourceFields added in v8.18.0 

func NewMappingLimitSettingsSourceFields() *MappingLimitSettingsSourceFields

NewMappingLimitSettingsSourceFields returns a MappingLimitSettingsSourceFields.

type MappingLimitSettingsTotalFields 

type MappingLimitSettingsTotalFields struct {
	// IgnoreDynamicBeyondLimit This setting determines what happens when a dynamically mapped field would
	// exceed the total fields limit. When set
	// to false (the default), the index request of the document that tries to add a
	// dynamic field to the mapping will fail
	// with the message Limit of total fields [X] has been exceeded. When set to
	// true, the index request will not fail.
	// Instead, fields that would exceed the limit are not added to the mapping,
	// similar to dynamic: false.
	// The fields that were not added to the mapping will be added to the _ignored
	// field.
	IgnoreDynamicBeyondLimit string `json:"ignore_dynamic_beyond_limit,omitempty"`
	// Limit The maximum number of fields in an index. Field and object mappings, as well
	// as field aliases count towards this limit.
	// The limit is in place to prevent mappings and searches from becoming too
	// large. Higher values can lead to performance
	// degradations and memory issues, especially in clusters with a high load or
	// few resources.
	Limit string `json:"limit,omitempty"`
}

MappingLimitSettingsTotalFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L441-L458

func NewMappingLimitSettingsTotalFields added in v8.5.0 

func NewMappingLimitSettingsTotalFields() *MappingLimitSettingsTotalFields

NewMappingLimitSettingsTotalFields returns a MappingLimitSettingsTotalFields.

func (*MappingLimitSettingsTotalFields) UnmarshalJSON added in v8.7.1 

func (s *MappingLimitSettingsTotalFields) UnmarshalJSON(data []byte) error

type MappingStats added in v8.7.0 

type MappingStats struct {
	TotalCount                    int64    `json:"total_count"`
	TotalEstimatedOverhead        ByteSize `json:"total_estimated_overhead,omitempty"`
	TotalEstimatedOverheadInBytes int64    `json:"total_estimated_overhead_in_bytes"`
}

MappingStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L186-L190

func NewMappingStats added in v8.7.0 

func NewMappingStats() *MappingStats

NewMappingStats returns a MappingStats.

func (*MappingStats) UnmarshalJSON added in v8.7.1 

func (s *MappingStats) UnmarshalJSON(data []byte) error

type MasterIsStableIndicator added in v8.7.1 

type MasterIsStableIndicator struct {
	Details   *MasterIsStableIndicatorDetails             `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

MasterIsStableIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L80-L84

func NewMasterIsStableIndicator added in v8.7.1 

func NewMasterIsStableIndicator() *MasterIsStableIndicator

NewMasterIsStableIndicator returns a MasterIsStableIndicator.

func (*MasterIsStableIndicator) UnmarshalJSON added in v8.9.0 

func (s *MasterIsStableIndicator) UnmarshalJSON(data []byte) error

type MasterIsStableIndicatorClusterFormationNode added in v8.7.1 

type MasterIsStableIndicatorClusterFormationNode struct {
	ClusterFormationMessage string  `json:"cluster_formation_message"`
	Name                    *string `json:"name,omitempty"`
	NodeId                  string  `json:"node_id"`
}

MasterIsStableIndicatorClusterFormationNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L99-L103

func NewMasterIsStableIndicatorClusterFormationNode added in v8.7.1 

func NewMasterIsStableIndicatorClusterFormationNode() *MasterIsStableIndicatorClusterFormationNode

NewMasterIsStableIndicatorClusterFormationNode returns a MasterIsStableIndicatorClusterFormationNode.

func (*MasterIsStableIndicatorClusterFormationNode) UnmarshalJSON added in v8.9.0 

func (s *MasterIsStableIndicatorClusterFormationNode) UnmarshalJSON(data []byte) error

type MasterIsStableIndicatorDetails added in v8.7.1 

type MasterIsStableIndicatorDetails struct {
	ClusterFormation         []MasterIsStableIndicatorClusterFormationNode    `json:"cluster_formation,omitempty"`
	CurrentMaster            IndicatorNode                                    `json:"current_master"`
	ExceptionFetchingHistory *MasterIsStableIndicatorExceptionFetchingHistory `json:"exception_fetching_history,omitempty"`
	RecentMasters            []IndicatorNode                                  `json:"recent_masters"`
}

MasterIsStableIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L85-L90

func NewMasterIsStableIndicatorDetails added in v8.7.1 

func NewMasterIsStableIndicatorDetails() *MasterIsStableIndicatorDetails

NewMasterIsStableIndicatorDetails returns a MasterIsStableIndicatorDetails.

type MasterIsStableIndicatorExceptionFetchingHistory added in v8.7.1 

type MasterIsStableIndicatorExceptionFetchingHistory struct {
	Message    string `json:"message"`
	StackTrace string `json:"stack_trace"`
}

MasterIsStableIndicatorExceptionFetchingHistory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L95-L98

func NewMasterIsStableIndicatorExceptionFetchingHistory added in v8.7.1 

func NewMasterIsStableIndicatorExceptionFetchingHistory() *MasterIsStableIndicatorExceptionFetchingHistory

NewMasterIsStableIndicatorExceptionFetchingHistory returns a MasterIsStableIndicatorExceptionFetchingHistory.

func (*MasterIsStableIndicatorExceptionFetchingHistory) UnmarshalJSON added in v8.9.0 

func (s *MasterIsStableIndicatorExceptionFetchingHistory) UnmarshalJSON(data []byte) error

type MasterRecord 

type MasterRecord struct {
	// Host host name
	Host *string `json:"host,omitempty"`
	// Id node id
	Id *string `json:"id,omitempty"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// Node node name
	Node *string `json:"node,omitempty"`
}

MasterRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/master/types.ts#L20-L39

func NewMasterRecord added in v8.5.0 

func NewMasterRecord() *MasterRecord

NewMasterRecord returns a MasterRecord.

func (*MasterRecord) UnmarshalJSON added in v8.9.0 

func (s *MasterRecord) UnmarshalJSON(data []byte) error

type MatchAllQuery 

type MatchAllQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

MatchAllQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/MatchAllQuery.ts#L22-L25

func NewMatchAllQuery added in v8.5.0 

func NewMatchAllQuery() *MatchAllQuery

NewMatchAllQuery returns a MatchAllQuery.

func (*MatchAllQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchAllQuery) UnmarshalJSON(data []byte) error

type MatchBoolPrefixQuery 

type MatchBoolPrefixQuery struct {
	// Analyzer Analyzer used to convert the text in the query value into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Fuzziness Maximum edit distance allowed for matching.
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// FuzzyRewrite Method used to rewrite the query.
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	FuzzyRewrite *string `json:"fuzzy_rewrite,omitempty"`
	// FuzzyTranspositions If `true`, edits for fuzzy matching include transpositions of two adjacent
	// characters (for example, `ab` to `ba`).
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	FuzzyTranspositions *bool `json:"fuzzy_transpositions,omitempty"`
	// MaxExpansions Maximum number of terms to which the query will expand.
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	MaxExpansions *int `json:"max_expansions,omitempty"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	// Applied to the constructed bool query.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Operator Boolean logic used to interpret text in the query value.
	// Applied to the constructed bool query.
	Operator *operator.Operator `json:"operator,omitempty"`
	// PrefixLength Number of beginning characters left unchanged for fuzzy matching.
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Query Terms you wish to find in the provided field.
	// The last term is used in a prefix query.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
}

MatchBoolPrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L406-L463

func NewMatchBoolPrefixQuery added in v8.5.0 

func NewMatchBoolPrefixQuery() *MatchBoolPrefixQuery

NewMatchBoolPrefixQuery returns a MatchBoolPrefixQuery.

func (*MatchBoolPrefixQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchBoolPrefixQuery) UnmarshalJSON(data []byte) error

type MatchNoneQuery 

type MatchNoneQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

MatchNoneQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/MatchNoneQuery.ts#L22-L25

func NewMatchNoneQuery added in v8.5.0 

func NewMatchNoneQuery() *MatchNoneQuery

NewMatchNoneQuery returns a MatchNoneQuery.

func (*MatchNoneQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchNoneQuery) UnmarshalJSON(data []byte) error

type MatchOnlyTextProperty 

type MatchOnlyTextProperty struct {
	// CopyTo Allows you to copy the values of multiple fields into a group
	// field, which can then be queried as a single field.
	CopyTo []string `json:"copy_to,omitempty"`
	// Fields Multi-fields allow the same string value to be indexed in multiple ways for
	// different purposes, such as one
	// field for search and a multi-field for sorting and aggregations, or the same
	// string value analyzed by different analyzers.
	Fields map[string]Property `json:"fields,omitempty"`
	// Meta Metadata about the field.
	Meta map[string]string `json:"meta,omitempty"`
	Type string            `json:"type,omitempty"`
}

MatchOnlyTextProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L256-L281

func NewMatchOnlyTextProperty added in v8.5.0 

func NewMatchOnlyTextProperty() *MatchOnlyTextProperty

NewMatchOnlyTextProperty returns a MatchOnlyTextProperty.

func (MatchOnlyTextProperty) MarshalJSON added in v8.9.0 

func (s MatchOnlyTextProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*MatchOnlyTextProperty) UnmarshalJSON added in v8.7.0 

func (s *MatchOnlyTextProperty) UnmarshalJSON(data []byte) error

type MatchPhrasePrefixQuery 

type MatchPhrasePrefixQuery struct {
	// Analyzer Analyzer used to convert text in the query value into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// MaxExpansions Maximum number of terms to which the last provided term of the query value
	// will expand.
	MaxExpansions *int `json:"max_expansions,omitempty"`
	// Query Text you wish to find in the provided field.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// Slop Maximum number of positions allowed between matching tokens.
	Slop *int `json:"slop,omitempty"`
	// ZeroTermsQuery Indicates whether no documents are returned if the analyzer removes all
	// tokens, such as when using a `stop` filter.
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchPhrasePrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L491-L520

func NewMatchPhrasePrefixQuery added in v8.5.0 

func NewMatchPhrasePrefixQuery() *MatchPhrasePrefixQuery

NewMatchPhrasePrefixQuery returns a MatchPhrasePrefixQuery.

func (*MatchPhrasePrefixQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchPhrasePrefixQuery) UnmarshalJSON(data []byte) error

type MatchPhraseQuery 

type MatchPhraseQuery struct {
	// Analyzer Analyzer used to convert the text in the query value into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Query Query terms that are analyzed and turned into a phrase query.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// Slop Maximum number of positions allowed between matching tokens.
	Slop *int `json:"slop,omitempty"`
	// ZeroTermsQuery Indicates whether no documents are returned if the `analyzer` removes all
	// tokens, such as when using a `stop` filter.
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchPhraseQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L465-L489

func NewMatchPhraseQuery added in v8.5.0 

func NewMatchPhraseQuery() *MatchPhraseQuery

NewMatchPhraseQuery returns a MatchPhraseQuery.

func (*MatchPhraseQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchPhraseQuery) UnmarshalJSON(data []byte) error

type MatchQuery 

type MatchQuery struct {
	// Analyzer Analyzer used to convert the text in the query value into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// AutoGenerateSynonymsPhraseQuery If `true`, match phrase queries are automatically created for multi-term
	// synonyms.
	AutoGenerateSynonymsPhraseQuery *bool `json:"auto_generate_synonyms_phrase_query,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost           *float32 `json:"boost,omitempty"`
	CutoffFrequency *Float64 `json:"cutoff_frequency,omitempty"`
	// Fuzziness Maximum edit distance allowed for matching.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// FuzzyRewrite Method used to rewrite the query.
	FuzzyRewrite *string `json:"fuzzy_rewrite,omitempty"`
	// FuzzyTranspositions If `true`, edits for fuzzy matching include transpositions of two adjacent
	// characters (for example, `ab` to `ba`).
	FuzzyTranspositions *bool `json:"fuzzy_transpositions,omitempty"`
	// Lenient If `true`, format-based errors, such as providing a text query value for a
	// numeric field, are ignored.
	Lenient *bool `json:"lenient,omitempty"`
	// MaxExpansions Maximum number of terms to which the query will expand.
	MaxExpansions *int `json:"max_expansions,omitempty"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Operator Boolean logic used to interpret text in the query value.
	Operator *operator.Operator `json:"operator,omitempty"`
	// PrefixLength Number of beginning characters left unchanged for fuzzy matching.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Query Text, number, boolean value or date you wish to find in the provided field.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// ZeroTermsQuery Indicates whether no documents are returned if the `analyzer` removes all
	// tokens, such as when using a `stop` filter.
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L336-L404

func NewMatchQuery added in v8.5.0 

func NewMatchQuery() *MatchQuery

NewMatchQuery returns a MatchQuery.

func (*MatchQuery) UnmarshalJSON added in v8.7.1 

func (s *MatchQuery) UnmarshalJSON(data []byte) error

type MatchedField added in v8.13.0 

type MatchedField struct {
	Length int    `json:"length"`
	Match  string `json:"match"`
	Offset int    `json:"offset"`
}

MatchedField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/text_structure/test_grok_pattern/types.ts#L23-L27

func NewMatchedField added in v8.13.0 

func NewMatchedField() *MatchedField

NewMatchedField returns a MatchedField.

func (*MatchedField) UnmarshalJSON added in v8.13.0 

func (s *MatchedField) UnmarshalJSON(data []byte) error

type MatchedText added in v8.13.0 

type MatchedText struct {
	Fields  map[string][]MatchedField `json:"fields,omitempty"`
	Matched bool                      `json:"matched"`
}

MatchedText type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/text_structure/test_grok_pattern/types.ts#L29-L32

func NewMatchedText added in v8.13.0 

func NewMatchedText() *MatchedText

NewMatchedText returns a MatchedText.

func (*MatchedText) UnmarshalJSON added in v8.13.0 

func (s *MatchedText) UnmarshalJSON(data []byte) error

type MatrixAggregation 

type MatrixAggregation struct {
	// Fields An array of fields for computing the statistics.
	Fields []string `json:"fields,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing map[string]Float64 `json:"missing,omitempty"`
}

MatrixAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/matrix.ts#L26-L36

func NewMatrixAggregation added in v8.5.0 

func NewMatrixAggregation() *MatrixAggregation

NewMatrixAggregation returns a MatrixAggregation.

func (*MatrixAggregation) UnmarshalJSON added in v8.7.1 

func (s *MatrixAggregation) UnmarshalJSON(data []byte) error

type MatrixStatsAggregate 

type MatrixStatsAggregate struct {
	DocCount int64               `json:"doc_count"`
	Fields   []MatrixStatsFields `json:"fields,omitempty"`
	Meta     Metadata            `json:"meta,omitempty"`
}

MatrixStatsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L866-L873

func NewMatrixStatsAggregate added in v8.5.0 

func NewMatrixStatsAggregate() *MatrixStatsAggregate

NewMatrixStatsAggregate returns a MatrixStatsAggregate.

func (*MatrixStatsAggregate) UnmarshalJSON added in v8.7.1 

func (s *MatrixStatsAggregate) UnmarshalJSON(data []byte) error

type MatrixStatsAggregation 

type MatrixStatsAggregation struct {
	// Fields An array of fields for computing the statistics.
	Fields []string `json:"fields,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing map[string]Float64 `json:"missing,omitempty"`
	// Mode Array value the aggregation will use for array or multi-valued fields.
	Mode *sortmode.SortMode `json:"mode,omitempty"`
}

MatrixStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/matrix.ts#L38-L44

func NewMatrixStatsAggregation added in v8.5.0 

func NewMatrixStatsAggregation() *MatrixStatsAggregation

NewMatrixStatsAggregation returns a MatrixStatsAggregation.

func (*MatrixStatsAggregation) UnmarshalJSON added in v8.7.1 

func (s *MatrixStatsAggregation) UnmarshalJSON(data []byte) error

type MatrixStatsFields 

type MatrixStatsFields struct {
	Correlation map[string]Float64 `json:"correlation"`
	Count       int64              `json:"count"`
	Covariance  map[string]Float64 `json:"covariance"`
	Kurtosis    Float64            `json:"kurtosis"`
	Mean        Float64            `json:"mean"`
	Name        string             `json:"name"`
	Skewness    Float64            `json:"skewness"`
	Variance    Float64            `json:"variance"`
}

MatrixStatsFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L875-L884

func NewMatrixStatsFields added in v8.5.0 

func NewMatrixStatsFields() *MatrixStatsFields

NewMatrixStatsFields returns a MatrixStatsFields.

func (*MatrixStatsFields) UnmarshalJSON added in v8.7.1 

func (s *MatrixStatsFields) UnmarshalJSON(data []byte) error

type MaxAggregate 

type MaxAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

MaxAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L205-L209

func NewMaxAggregate added in v8.5.0 

func NewMaxAggregate() *MaxAggregate

NewMaxAggregate returns a MaxAggregate.

func (*MaxAggregate) UnmarshalJSON added in v8.7.1 

func (s *MaxAggregate) UnmarshalJSON(data []byte) error

type MaxAggregation 

type MaxAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

MaxAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L165-L165

func NewMaxAggregation added in v8.5.0 

func NewMaxAggregation() *MaxAggregation

NewMaxAggregation returns a MaxAggregation.

func (*MaxAggregation) UnmarshalJSON added in v8.7.1 

func (s *MaxAggregation) UnmarshalJSON(data []byte) error

type MaxBucketAggregation 

type MaxBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

MaxBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L244-L247

func NewMaxBucketAggregation added in v8.5.0 

func NewMaxBucketAggregation() *MaxBucketAggregation

NewMaxBucketAggregation returns a MaxBucketAggregation.

func (*MaxBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *MaxBucketAggregation) UnmarshalJSON(data []byte) error

type Maxmind added in v8.16.0 

type Maxmind struct {
	AccountId string `json:"account_id"`
}

Maxmind type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L55-L57

func NewMaxmind added in v8.16.0 

func NewMaxmind() *Maxmind

NewMaxmind returns a Maxmind.

func (*Maxmind) UnmarshalJSON added in v8.16.0 

func (s *Maxmind) UnmarshalJSON(data []byte) error

type MedianAbsoluteDeviationAggregate 

type MedianAbsoluteDeviationAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

MedianAbsoluteDeviationAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L196-L197

func NewMedianAbsoluteDeviationAggregate added in v8.5.0 

func NewMedianAbsoluteDeviationAggregate() *MedianAbsoluteDeviationAggregate

NewMedianAbsoluteDeviationAggregate returns a MedianAbsoluteDeviationAggregate.

func (*MedianAbsoluteDeviationAggregate) UnmarshalJSON added in v8.7.1 

func (s *MedianAbsoluteDeviationAggregate) UnmarshalJSON(data []byte) error

type MedianAbsoluteDeviationAggregation 

type MedianAbsoluteDeviationAggregation struct {
	// Compression Limits the maximum number of nodes used by the underlying TDigest algorithm
	// to `20 * compression`, enabling control of memory usage and approximation
	// error.
	Compression *Float64 `json:"compression,omitempty"`
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

MedianAbsoluteDeviationAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L167-L176

func NewMedianAbsoluteDeviationAggregation added in v8.5.0 

func NewMedianAbsoluteDeviationAggregation() *MedianAbsoluteDeviationAggregation

NewMedianAbsoluteDeviationAggregation returns a MedianAbsoluteDeviationAggregation.

func (*MedianAbsoluteDeviationAggregation) UnmarshalJSON added in v8.7.1 

func (s *MedianAbsoluteDeviationAggregation) UnmarshalJSON(data []byte) error

type MemMlStats 

type MemMlStats struct {
	// AnomalyDetectors Amount of native memory set aside for anomaly detection jobs.
	AnomalyDetectors ByteSize `json:"anomaly_detectors,omitempty"`
	// AnomalyDetectorsInBytes Amount of native memory, in bytes, set aside for anomaly detection jobs.
	AnomalyDetectorsInBytes int `json:"anomaly_detectors_in_bytes"`
	// DataFrameAnalytics Amount of native memory set aside for data frame analytics jobs.
	DataFrameAnalytics ByteSize `json:"data_frame_analytics,omitempty"`
	// DataFrameAnalyticsInBytes Amount of native memory, in bytes, set aside for data frame analytics jobs.
	DataFrameAnalyticsInBytes int `json:"data_frame_analytics_in_bytes"`
	// Max Maximum amount of native memory (separate to the JVM heap) that may be used
	// by machine learning native processes.
	Max ByteSize `json:"max,omitempty"`
	// MaxInBytes Maximum amount of native memory (separate to the JVM heap), in bytes, that
	// may be used by machine learning native processes.
	MaxInBytes int `json:"max_in_bytes"`
	// NativeCodeOverhead Amount of native memory set aside for loading machine learning native code
	// shared libraries.
	NativeCodeOverhead ByteSize `json:"native_code_overhead,omitempty"`
	// NativeCodeOverheadInBytes Amount of native memory, in bytes, set aside for loading machine learning
	// native code shared libraries.
	NativeCodeOverheadInBytes int `json:"native_code_overhead_in_bytes"`
	// NativeInference Amount of native memory set aside for trained models that have a PyTorch
	// model_type.
	NativeInference ByteSize `json:"native_inference,omitempty"`
	// NativeInferenceInBytes Amount of native memory, in bytes, set aside for trained models that have a
	// PyTorch model_type.
	NativeInferenceInBytes int `json:"native_inference_in_bytes"`
}

MemMlStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/get_memory_stats/types.ts#L90-L111

func NewMemMlStats added in v8.5.0 

func NewMemMlStats() *MemMlStats

NewMemMlStats returns a MemMlStats.

func (*MemMlStats) UnmarshalJSON added in v8.7.1 

func (s *MemMlStats) UnmarshalJSON(data []byte) error

type MemStats 

type MemStats struct {
	// AdjustedTotal If the amount of physical memory has been overridden using the
	// es.total_memory_bytes system property
	// then this reports the overridden value. Otherwise it reports the same value
	// as total.
	AdjustedTotal ByteSize `json:"adjusted_total,omitempty"`
	// AdjustedTotalInBytes If the amount of physical memory has been overridden using the
	// `es.total_memory_bytes` system property
	// then this reports the overridden value in bytes. Otherwise it reports the
	// same value as `total_in_bytes`.
	AdjustedTotalInBytes int `json:"adjusted_total_in_bytes"`
	// Ml Contains statistics about machine learning use of native memory on the node.
	Ml MemMlStats `json:"ml"`
	// Total Total amount of physical memory.
	Total ByteSize `json:"total,omitempty"`
	// TotalInBytes Total amount of physical memory in bytes.
	TotalInBytes int `json:"total_in_bytes"`
}

MemStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/get_memory_stats/types.ts#L65-L88

func NewMemStats added in v8.5.0 

func NewMemStats() *MemStats

NewMemStats returns a MemStats.

func (*MemStats) UnmarshalJSON added in v8.7.1 

func (s *MemStats) UnmarshalJSON(data []byte) error

type Memory 

type Memory struct {
	Attributes  map[string]string `json:"attributes"`
	EphemeralId string            `json:"ephemeral_id"`
	// Jvm Contains Java Virtual Machine (JVM) statistics for the node.
	Jvm JvmStats `json:"jvm"`
	// Mem Contains statistics about memory usage for the node.
	Mem MemStats `json:"mem"`
	// Name Human-readable identifier for the node. Based on the Node name setting
	// setting.
	Name string `json:"name"`
	// Roles Roles assigned to the node.
	Roles []string `json:"roles"`
	// TransportAddress The host and port where transport HTTP connections are accepted.
	TransportAddress string `json:"transport_address"`
}

Memory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/get_memory_stats/types.ts#L25-L48

func NewMemory added in v8.5.0 

func NewMemory() *Memory

NewMemory returns a Memory.

func (*Memory) UnmarshalJSON added in v8.7.1 

func (s *Memory) UnmarshalJSON(data []byte) error

type MemoryStats 

type MemoryStats struct {
	// AdjustedTotalInBytes If the amount of physical memory has been overridden using the
	// `es`.`total_memory_bytes` system property then this reports the overridden
	// value in bytes.
	// Otherwise it reports the same value as `total_in_bytes`.
	AdjustedTotalInBytes *int64 `json:"adjusted_total_in_bytes,omitempty"`
	// FreeInBytes Amount of free physical memory in bytes.
	FreeInBytes     *int64  `json:"free_in_bytes,omitempty"`
	Resident        *string `json:"resident,omitempty"`
	ResidentInBytes *int64  `json:"resident_in_bytes,omitempty"`
	Share           *string `json:"share,omitempty"`
	ShareInBytes    *int64  `json:"share_in_bytes,omitempty"`
	// TotalInBytes Total amount of physical memory in bytes.
	TotalInBytes        *int64  `json:"total_in_bytes,omitempty"`
	TotalVirtual        *string `json:"total_virtual,omitempty"`
	TotalVirtualInBytes *int64  `json:"total_virtual_in_bytes,omitempty"`
	// UsedInBytes Amount of used physical memory in bytes.
	UsedInBytes *int64 `json:"used_in_bytes,omitempty"`
}

MemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L632-L656

func NewMemoryStats added in v8.5.0 

func NewMemoryStats() *MemoryStats

NewMemoryStats returns a MemoryStats.

func (*MemoryStats) UnmarshalJSON added in v8.7.1 

func (s *MemoryStats) UnmarshalJSON(data []byte) error

type Merge 

type Merge struct {
	Scheduler *MergeScheduler `json:"scheduler,omitempty"`
}

Merge type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L346-L348

func NewMerge added in v8.5.0 

func NewMerge() *Merge

NewMerge returns a Merge.

type MergeScheduler 

type MergeScheduler struct {
	MaxMergeCount  Stringifiedinteger `json:"max_merge_count,omitempty"`
	MaxThreadCount Stringifiedinteger `json:"max_thread_count,omitempty"`
}

MergeScheduler type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L350-L353

func NewMergeScheduler added in v8.5.0 

func NewMergeScheduler() *MergeScheduler

NewMergeScheduler returns a MergeScheduler.

func (*MergeScheduler) UnmarshalJSON added in v8.7.1 

func (s *MergeScheduler) UnmarshalJSON(data []byte) error

type MergesStats 

type MergesStats struct {
	Current                    int64    `json:"current"`
	CurrentDocs                int64    `json:"current_docs"`
	CurrentSize                *string  `json:"current_size,omitempty"`
	CurrentSizeInBytes         int64    `json:"current_size_in_bytes"`
	Total                      int64    `json:"total"`
	TotalAutoThrottle          *string  `json:"total_auto_throttle,omitempty"`
	TotalAutoThrottleInBytes   int64    `json:"total_auto_throttle_in_bytes"`
	TotalDocs                  int64    `json:"total_docs"`
	TotalSize                  *string  `json:"total_size,omitempty"`
	TotalSizeInBytes           int64    `json:"total_size_in_bytes"`
	TotalStoppedTime           Duration `json:"total_stopped_time,omitempty"`
	TotalStoppedTimeInMillis   int64    `json:"total_stopped_time_in_millis"`
	TotalThrottledTime         Duration `json:"total_throttled_time,omitempty"`
	TotalThrottledTimeInMillis int64    `json:"total_throttled_time_in_millis"`
	TotalTime                  Duration `json:"total_time,omitempty"`
	TotalTimeInMillis          int64    `json:"total_time_in_millis"`
}

MergesStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L164-L181

func NewMergesStats added in v8.5.0 

func NewMergesStats() *MergesStats

NewMergesStats returns a MergesStats.

func (*MergesStats) UnmarshalJSON added in v8.7.1 

func (s *MergesStats) UnmarshalJSON(data []byte) error

type Message added in v8.18.0 

type Message struct {
	// Content The content of the message.
	//
	// String example:
	// “`
	//
	//	{
	//	   "content": "Some string"
	//	}
	//
	// “`
	//
	// Object example:
	// “`
	//
	//	{
	//	  "content": [
	//	      {
	//	       "text": "Some text",
	//	       "type": "text"
	//	      }
	//	   ]
	//	}
	//
	// “`
	Content MessageContent `json:"content,omitempty"`
	// Role The role of the message author. Valid values are `user`, `assistant`,
	// `system`, and `tool`.
	Role string `json:"role"`
	// ToolCallId Only for `tool` role messages. The tool call that this message is responding
	// to.
	ToolCallId *string `json:"tool_call_id,omitempty"`
	// ToolCalls Only for `assistant` role messages. The tool calls generated by the model. If
	// it's specified, the `content` field is optional.
	// Example:
	// “`
	//
	//	{
	//	  "tool_calls": [
	//	      {
	//	          "id": "call_KcAjWtAww20AihPHphUh46Gd",
	//	          "type": "function",
	//	          "function": {
	//	              "name": "get_current_weather",
	//	              "arguments": "{\"location\":\"Boston, MA\"}"
	//	          }
	//	      }
	//	  ]
	//	}
	//
	// “`
	ToolCalls []ToolCall `json:"tool_calls,omitempty"`
}

Message type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L174-L228

func NewMessage added in v8.18.0 

func NewMessage() *Message

NewMessage returns a Message.

func (*Message) UnmarshalJSON added in v8.18.0 

func (s *Message) UnmarshalJSON(data []byte) error

type MessageContent added in v8.18.0 

type MessageContent any

MessageContent holds the union for the following types: 

string
[]ContentObject

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L169-L172

type Metadata 

type Metadata map[string]json.RawMessage

Metadata type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L100-L100

type Metrics 

type Metrics []string

Metrics type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L76-L76

type MgetOperation added in v8.5.0 

type MgetOperation struct {
	// Id_ The unique document ID.
	Id_ string `json:"_id"`
	// Index_ The index that contains the document.
	Index_ *string `json:"_index,omitempty"`
	// Routing The key for the primary shard the document resides on. Required if routing is
	// used during indexing.
	Routing *string `json:"routing,omitempty"`
	// Source_ If `false`, excludes all _source fields.
	Source_ SourceConfig `json:"_source,omitempty"`
	// StoredFields The stored fields you want to retrieve.
	StoredFields []string                 `json:"stored_fields,omitempty"`
	Version      *int64                   `json:"version,omitempty"`
	VersionType  *versiontype.VersionType `json:"version_type,omitempty"`
}

MgetOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/mget/types.ts#L32-L55

func NewMgetOperation added in v8.5.0 

func NewMgetOperation() *MgetOperation

NewMgetOperation returns a MgetOperation.

func (*MgetOperation) UnmarshalJSON added in v8.7.1 

func (s *MgetOperation) UnmarshalJSON(data []byte) error

type MgetResponseItem added in v8.9.0 

type MgetResponseItem any

MgetResponseItem holds the union for the following types: 

GetResult
MultiGetError

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/mget/types.ts#L57-L60

type MigrateAction added in v8.15.0 

type MigrateAction struct {
	Enabled *bool `json:"enabled,omitempty"`
}

MigrateAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L141-L143

func NewMigrateAction added in v8.15.0 

func NewMigrateAction() *MigrateAction

NewMigrateAction returns a MigrateAction.

func (*MigrateAction) UnmarshalJSON added in v8.15.0 

func (s *MigrateAction) UnmarshalJSON(data []byte) error

type MigrateReindex added in v8.18.0 

type MigrateReindex struct {
	// Mode Reindex mode. Currently only 'upgrade' is supported.
	Mode modeenum.ModeEnum `json:"mode"`
	// Source The source index or data stream (only data streams are currently supported).
	Source SourceIndex `json:"source"`
}

MigrateReindex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/migrate_reindex/MigrateReindexRequest.ts#L39-L48

func NewMigrateReindex added in v8.18.0 

func NewMigrateReindex() *MigrateReindex

NewMigrateReindex returns a MigrateReindex.

type MigrationFeatureIndexInfo 

type MigrationFeatureIndexInfo struct {
	FailureCause *ErrorCause `json:"failure_cause,omitempty"`
	Index        string      `json:"index"`
	Version      string      `json:"version"`
}

MigrationFeatureIndexInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L44-L48

func NewMigrationFeatureIndexInfo added in v8.5.0 

func NewMigrationFeatureIndexInfo() *MigrationFeatureIndexInfo

NewMigrationFeatureIndexInfo returns a MigrationFeatureIndexInfo.

func (*MigrationFeatureIndexInfo) UnmarshalJSON added in v8.7.1 

func (s *MigrationFeatureIndexInfo) UnmarshalJSON(data []byte) error

type MinAggregate 

type MinAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

MinAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L199-L203

func NewMinAggregate added in v8.5.0 

func NewMinAggregate() *MinAggregate

NewMinAggregate returns a MinAggregate.

func (*MinAggregate) UnmarshalJSON added in v8.7.1 

func (s *MinAggregate) UnmarshalJSON(data []byte) error

type MinAggregation 

type MinAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

MinAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L178-L178

func NewMinAggregation added in v8.5.0 

func NewMinAggregation() *MinAggregation

NewMinAggregation returns a MinAggregation.

func (*MinAggregation) UnmarshalJSON added in v8.7.1 

func (s *MinAggregation) UnmarshalJSON(data []byte) error

type MinBucketAggregation 

type MinBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

MinBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L249-L252

func NewMinBucketAggregation added in v8.5.0 

func NewMinBucketAggregation() *MinBucketAggregation

NewMinBucketAggregation returns a MinBucketAggregation.

func (*MinBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *MinBucketAggregation) UnmarshalJSON(data []byte) error

type MinHashTokenFilter added in v8.18.1 

type MinHashTokenFilter struct {
	// BucketCount Number of buckets to which hashes are assigned. Defaults to `512`.
	BucketCount *int `json:"bucket_count,omitempty"`
	// HashCount Number of ways to hash each token in the stream. Defaults to `1`.
	HashCount *int `json:"hash_count,omitempty"`
	// HashSetSize Number of hashes to keep from each bucket. Defaults to `1`.
	// Hashes are retained by ascending size, starting with the bucket’s smallest
	// hash first.
	HashSetSize *int    `json:"hash_set_size,omitempty"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
	// WithRotation If `true`, the filter fills empty buckets with the value of the first
	// non-empty bucket to its circular right if the `hash_set_size` is `1`. If the
	// `bucket_count` argument is greater than 1, this parameter defaults to `true`.
	// Otherwise, this parameter defaults to `false`.
	WithRotation *bool `json:"with_rotation,omitempty"`
}

MinHashTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L505-L516

func NewMinHashTokenFilter added in v8.18.1 

func NewMinHashTokenFilter() *MinHashTokenFilter

NewMinHashTokenFilter returns a MinHashTokenFilter.

func (MinHashTokenFilter) MarshalJSON added in v8.18.1 

func (s MinHashTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*MinHashTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *MinHashTokenFilter) UnmarshalJSON(data []byte) error

type MinimalLicenseInformation 

type MinimalLicenseInformation struct {
	ExpiryDateInMillis int64                       `json:"expiry_date_in_millis"`
	Mode               licensetype.LicenseType     `json:"mode"`
	Status             licensestatus.LicenseStatus `json:"status"`
	Type               licensetype.LicenseType     `json:"type"`
	Uid                string                      `json:"uid"`
}

MinimalLicenseInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/info/types.ts#L34-L40

func NewMinimalLicenseInformation added in v8.5.0 

func NewMinimalLicenseInformation() *MinimalLicenseInformation

NewMinimalLicenseInformation returns a MinimalLicenseInformation.

func (*MinimalLicenseInformation) UnmarshalJSON added in v8.7.1 

func (s *MinimalLicenseInformation) UnmarshalJSON(data []byte) error

type MinimumShouldMatch 

type MinimumShouldMatch any

MinimumShouldMatch holds the union for the following types: 

int
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L167-L171

type Missing 

type Missing any

Missing holds the union for the following types: 

string
int
Float64
bool

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/AggregationContainer.ts#L535-L535

type MissingAggregate 

type MissingAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

MissingAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L528-L532

func NewMissingAggregate added in v8.5.0 

func NewMissingAggregate() *MissingAggregate

NewMissingAggregate returns a MissingAggregate.

func (MissingAggregate) MarshalJSON 

func (s MissingAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*MissingAggregate) UnmarshalJSON added in v8.7.0 

func (s *MissingAggregate) UnmarshalJSON(data []byte) error

type MissingAggregation 

type MissingAggregation struct {
	// Field The name of the field.
	Field   *string `json:"field,omitempty"`
	Missing Missing `json:"missing,omitempty"`
}

MissingAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L593-L599

func NewMissingAggregation added in v8.5.0 

func NewMissingAggregation() *MissingAggregation

NewMissingAggregation returns a MissingAggregation.

func (*MissingAggregation) UnmarshalJSON added in v8.7.1 

func (s *MissingAggregation) UnmarshalJSON(data []byte) error

type MistralServiceSettings added in v8.18.0 

type MistralServiceSettings struct {
	// ApiKey A valid API key of your Mistral account.
	// You can find your Mistral API keys or you can create a new one on the API
	// Keys page.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// MaxInputTokens The maximum number of tokens per input before chunking occurs.
	MaxInputTokens *int `json:"max_input_tokens,omitempty"`
	// Model The name of the model to use for the inference task.
	// Refer to the Mistral models documentation for the list of available text
	// embedding models.
	Model string `json:"model"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// the Mistral API.
	// By default, the `mistral` service sets the number of requests allowed per
	// minute to 240.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
}

MistralServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1049-L1076

func NewMistralServiceSettings added in v8.18.0 

func NewMistralServiceSettings() *MistralServiceSettings

NewMistralServiceSettings returns a MistralServiceSettings.

func (*MistralServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *MistralServiceSettings) UnmarshalJSON(data []byte) error

type MlCounter 

type MlCounter struct {
	Count int64 `json:"count"`
}

MlCounter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L265-L267

func NewMlCounter added in v8.5.0 

func NewMlCounter() *MlCounter

NewMlCounter returns a MlCounter.

func (*MlCounter) UnmarshalJSON added in v8.7.1 

func (s *MlCounter) UnmarshalJSON(data []byte) error

type MlDataFrameAnalyticsJobs 

type MlDataFrameAnalyticsJobs struct {
	All_           MlDataFrameAnalyticsJobsCount     `json:"_all"`
	AnalysisCounts *MlDataFrameAnalyticsJobsAnalysis `json:"analysis_counts,omitempty"`
	MemoryUsage    *MlDataFrameAnalyticsJobsMemory   `json:"memory_usage,omitempty"`
	Stopped        *MlDataFrameAnalyticsJobsCount    `json:"stopped,omitempty"`
}

MlDataFrameAnalyticsJobs type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L187-L192

func NewMlDataFrameAnalyticsJobs added in v8.5.0 

func NewMlDataFrameAnalyticsJobs() *MlDataFrameAnalyticsJobs

NewMlDataFrameAnalyticsJobs returns a MlDataFrameAnalyticsJobs.

type MlDataFrameAnalyticsJobsAnalysis 

type MlDataFrameAnalyticsJobsAnalysis struct {
	Classification   *int `json:"classification,omitempty"`
	OutlierDetection *int `json:"outlier_detection,omitempty"`
	Regression       *int `json:"regression,omitempty"`
}

MlDataFrameAnalyticsJobsAnalysis type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L194-L198

func NewMlDataFrameAnalyticsJobsAnalysis added in v8.5.0 

func NewMlDataFrameAnalyticsJobsAnalysis() *MlDataFrameAnalyticsJobsAnalysis

NewMlDataFrameAnalyticsJobsAnalysis returns a MlDataFrameAnalyticsJobsAnalysis.

func (*MlDataFrameAnalyticsJobsAnalysis) UnmarshalJSON added in v8.7.1 

func (s *MlDataFrameAnalyticsJobsAnalysis) UnmarshalJSON(data []byte) error

type MlDataFrameAnalyticsJobsCount 

type MlDataFrameAnalyticsJobsCount struct {
	Count int64 `json:"count"`
}

MlDataFrameAnalyticsJobsCount type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L204-L206

func NewMlDataFrameAnalyticsJobsCount added in v8.5.0 

func NewMlDataFrameAnalyticsJobsCount() *MlDataFrameAnalyticsJobsCount

NewMlDataFrameAnalyticsJobsCount returns a MlDataFrameAnalyticsJobsCount.

func (*MlDataFrameAnalyticsJobsCount) UnmarshalJSON added in v8.7.1 

func (s *MlDataFrameAnalyticsJobsCount) UnmarshalJSON(data []byte) error

type MlDataFrameAnalyticsJobsMemory 

type MlDataFrameAnalyticsJobsMemory struct {
	PeakUsageBytes JobStatistics `json:"peak_usage_bytes"`
}

MlDataFrameAnalyticsJobsMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L200-L202

func NewMlDataFrameAnalyticsJobsMemory added in v8.5.0 

func NewMlDataFrameAnalyticsJobsMemory() *MlDataFrameAnalyticsJobsMemory

NewMlDataFrameAnalyticsJobsMemory returns a MlDataFrameAnalyticsJobsMemory.

type MlInference 

type MlInference struct {
	Deployments      *MlInferenceDeployments               `json:"deployments,omitempty"`
	IngestProcessors map[string]MlInferenceIngestProcessor `json:"ingest_processors"`
	TrainedModels    MlInferenceTrainedModels              `json:"trained_models"`
}

MlInference type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L208-L216

func NewMlInference added in v8.5.0 

func NewMlInference() *MlInference

NewMlInference returns a MlInference.

type MlInferenceDeployments 

type MlInferenceDeployments struct {
	Count           int                          `json:"count"`
	InferenceCounts JobStatistics                `json:"inference_counts"`
	ModelSizesBytes JobStatistics                `json:"model_sizes_bytes"`
	TimeMs          MlInferenceDeploymentsTimeMs `json:"time_ms"`
}

MlInferenceDeployments type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L237-L242

func NewMlInferenceDeployments added in v8.5.0 

func NewMlInferenceDeployments() *MlInferenceDeployments

NewMlInferenceDeployments returns a MlInferenceDeployments.

func (*MlInferenceDeployments) UnmarshalJSON added in v8.7.1 

func (s *MlInferenceDeployments) UnmarshalJSON(data []byte) error

type MlInferenceDeploymentsTimeMs 

type MlInferenceDeploymentsTimeMs struct {
	Avg Float64 `json:"avg"`
}

MlInferenceDeploymentsTimeMs type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L244-L246

func NewMlInferenceDeploymentsTimeMs added in v8.5.0 

func NewMlInferenceDeploymentsTimeMs() *MlInferenceDeploymentsTimeMs

NewMlInferenceDeploymentsTimeMs returns a MlInferenceDeploymentsTimeMs.

func (*MlInferenceDeploymentsTimeMs) UnmarshalJSON added in v8.7.1 

func (s *MlInferenceDeploymentsTimeMs) UnmarshalJSON(data []byte) error

type MlInferenceIngestProcessor 

type MlInferenceIngestProcessor struct {
	NumDocsProcessed MlInferenceIngestProcessorCount `json:"num_docs_processed"`
	NumFailures      MlInferenceIngestProcessorCount `json:"num_failures"`
	Pipelines        MlCounter                       `json:"pipelines"`
	TimeMs           MlInferenceIngestProcessorCount `json:"time_ms"`
}

MlInferenceIngestProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L218-L223

func NewMlInferenceIngestProcessor added in v8.5.0 

func NewMlInferenceIngestProcessor() *MlInferenceIngestProcessor

NewMlInferenceIngestProcessor returns a MlInferenceIngestProcessor.

type MlInferenceIngestProcessorCount 

type MlInferenceIngestProcessorCount struct {
	Max int64 `json:"max"`
	Min int64 `json:"min"`
	Sum int64 `json:"sum"`
}

MlInferenceIngestProcessorCount type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L248-L252

func NewMlInferenceIngestProcessorCount added in v8.5.0 

func NewMlInferenceIngestProcessorCount() *MlInferenceIngestProcessorCount

NewMlInferenceIngestProcessorCount returns a MlInferenceIngestProcessorCount.

func (*MlInferenceIngestProcessorCount) UnmarshalJSON added in v8.7.1 

func (s *MlInferenceIngestProcessorCount) UnmarshalJSON(data []byte) error

type MlInferenceTrainedModels 

type MlInferenceTrainedModels struct {
	All_                          MlCounter                      `json:"_all"`
	Count                         *MlInferenceTrainedModelsCount `json:"count,omitempty"`
	EstimatedHeapMemoryUsageBytes *JobStatistics                 `json:"estimated_heap_memory_usage_bytes,omitempty"`
	EstimatedOperations           *JobStatistics                 `json:"estimated_operations,omitempty"`
	ModelSizeBytes                *JobStatistics                 `json:"model_size_bytes,omitempty"`
}

MlInferenceTrainedModels type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L225-L235

func NewMlInferenceTrainedModels added in v8.5.0 

func NewMlInferenceTrainedModels() *MlInferenceTrainedModels

NewMlInferenceTrainedModels returns a MlInferenceTrainedModels.

type MlInferenceTrainedModelsCount 

type MlInferenceTrainedModelsCount struct {
	Classification *int64 `json:"classification,omitempty"`
	Ner            *int64 `json:"ner,omitempty"`
	Other          int64  `json:"other"`
	PassThrough    *int64 `json:"pass_through,omitempty"`
	Prepackaged    int64  `json:"prepackaged"`
	Regression     *int64 `json:"regression,omitempty"`
	TextEmbedding  *int64 `json:"text_embedding,omitempty"`
	Total          int64  `json:"total"`
}

MlInferenceTrainedModelsCount type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L254-L263

func NewMlInferenceTrainedModelsCount added in v8.5.0 

func NewMlInferenceTrainedModelsCount() *MlInferenceTrainedModelsCount

NewMlInferenceTrainedModelsCount returns a MlInferenceTrainedModelsCount.

func (*MlInferenceTrainedModelsCount) UnmarshalJSON added in v8.7.1 

func (s *MlInferenceTrainedModelsCount) UnmarshalJSON(data []byte) error

type MlJobForecasts added in v8.5.0 

type MlJobForecasts struct {
	ForecastedJobs int64 `json:"forecasted_jobs"`
	Total          int64 `json:"total"`
}

MlJobForecasts type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L182-L185

func NewMlJobForecasts added in v8.5.0 

func NewMlJobForecasts() *MlJobForecasts

NewMlJobForecasts returns a MlJobForecasts.

func (*MlJobForecasts) UnmarshalJSON added in v8.7.1 

func (s *MlJobForecasts) UnmarshalJSON(data []byte) error

type ModelPackageConfig added in v8.17.0 

type ModelPackageConfig struct {
	CreateTime           *int64                     `json:"create_time,omitempty"`
	Description          *string                    `json:"description,omitempty"`
	InferenceConfig      map[string]json.RawMessage `json:"inference_config,omitempty"`
	Metadata             Metadata                   `json:"metadata,omitempty"`
	MinimumVersion       *string                    `json:"minimum_version,omitempty"`
	ModelRepository      *string                    `json:"model_repository,omitempty"`
	ModelType            *string                    `json:"model_type,omitempty"`
	PackagedModelId      string                     `json:"packaged_model_id"`
	PlatformArchitecture *string                    `json:"platform_architecture,omitempty"`
	PrefixStrings        *TrainedModelPrefixStrings `json:"prefix_strings,omitempty"`
	Sha256               *string                    `json:"sha256,omitempty"`
	Size                 ByteSize                   `json:"size,omitempty"`
	Tags                 []string                   `json:"tags,omitempty"`
	VocabularyFile       *string                    `json:"vocabulary_file,omitempty"`
}

ModelPackageConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L257-L272

func NewModelPackageConfig added in v8.17.0 

func NewModelPackageConfig() *ModelPackageConfig

NewModelPackageConfig returns a ModelPackageConfig.

func (*ModelPackageConfig) UnmarshalJSON added in v8.17.0 

func (s *ModelPackageConfig) UnmarshalJSON(data []byte) error

type ModelPlotConfig 

type ModelPlotConfig struct {
	// AnnotationsEnabled If true, enables calculation and storage of the model change annotations for
	// each entity that is being analyzed.
	AnnotationsEnabled *bool `json:"annotations_enabled,omitempty"`
	// Enabled If true, enables calculation and storage of the model bounds for each entity
	// that is being analyzed.
	Enabled *bool `json:"enabled,omitempty"`
	// Terms Limits data collection to this comma separated list of partition or by field
	// values. If terms are not specified or it is an empty string, no filtering is
	// applied. Wildcards are not supported. Only the specified terms can be viewed
	// when using the Single Metric Viewer.
	Terms *string `json:"terms,omitempty"`
}

ModelPlotConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/ModelPlot.ts#L23-L42

func NewModelPlotConfig added in v8.5.0 

func NewModelPlotConfig() *ModelPlotConfig

NewModelPlotConfig returns a ModelPlotConfig.

func (*ModelPlotConfig) UnmarshalJSON added in v8.7.1 

func (s *ModelPlotConfig) UnmarshalJSON(data []byte) error

type ModelSizeStats 

type ModelSizeStats struct {
	AssignmentMemoryBasis         *string                                   `json:"assignment_memory_basis,omitempty"`
	BucketAllocationFailuresCount int64                                     `json:"bucket_allocation_failures_count"`
	CategorizationStatus          categorizationstatus.CategorizationStatus `json:"categorization_status"`
	CategorizedDocCount           int                                       `json:"categorized_doc_count"`
	DeadCategoryCount             int                                       `json:"dead_category_count"`
	FailedCategoryCount           int                                       `json:"failed_category_count"`
	FrequentCategoryCount         int                                       `json:"frequent_category_count"`
	JobId                         string                                    `json:"job_id"`
	LogTime                       DateTime                                  `json:"log_time"`
	MemoryStatus                  memorystatus.MemoryStatus                 `json:"memory_status"`
	ModelBytes                    ByteSize                                  `json:"model_bytes"`
	ModelBytesExceeded            ByteSize                                  `json:"model_bytes_exceeded,omitempty"`
	ModelBytesMemoryLimit         ByteSize                                  `json:"model_bytes_memory_limit,omitempty"`
	OutputMemoryAllocatorBytes    ByteSize                                  `json:"output_memory_allocator_bytes,omitempty"`
	PeakModelBytes                ByteSize                                  `json:"peak_model_bytes,omitempty"`
	RareCategoryCount             int                                       `json:"rare_category_count"`
	ResultType                    string                                    `json:"result_type"`
	Timestamp                     *int64                                    `json:"timestamp,omitempty"`
	TotalByFieldCount             int64                                     `json:"total_by_field_count"`
	TotalCategoryCount            int                                       `json:"total_category_count"`
	TotalOverFieldCount           int64                                     `json:"total_over_field_count"`
	TotalPartitionFieldCount      int64                                     `json:"total_partition_field_count"`
}

ModelSizeStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Model.ts#L59-L82

func NewModelSizeStats added in v8.5.0 

func NewModelSizeStats() *ModelSizeStats

NewModelSizeStats returns a ModelSizeStats.

func (*ModelSizeStats) UnmarshalJSON added in v8.7.1 

func (s *ModelSizeStats) UnmarshalJSON(data []byte) error

type ModelSnapshot 

type ModelSnapshot struct {
	// Description An optional description of the job.
	Description *string `json:"description,omitempty"`
	// JobId A numerical character string that uniquely identifies the job that the
	// snapshot was created for.
	JobId string `json:"job_id"`
	// LatestRecordTimeStamp The timestamp of the latest processed record.
	LatestRecordTimeStamp *int `json:"latest_record_time_stamp,omitempty"`
	// LatestResultTimeStamp The timestamp of the latest bucket result.
	LatestResultTimeStamp *int `json:"latest_result_time_stamp,omitempty"`
	// MinVersion The minimum version required to be able to restore the model snapshot.
	MinVersion string `json:"min_version"`
	// ModelSizeStats Summary information describing the model.
	ModelSizeStats *ModelSizeStats `json:"model_size_stats,omitempty"`
	// Retain If true, this snapshot will not be deleted during automatic cleanup of
	// snapshots older than model_snapshot_retention_days. However, this snapshot
	// will be deleted when the job is deleted. The default value is false.
	Retain bool `json:"retain"`
	// SnapshotDocCount For internal use only.
	SnapshotDocCount int64 `json:"snapshot_doc_count"`
	// SnapshotId A numerical character string that uniquely identifies the model snapshot.
	SnapshotId string `json:"snapshot_id"`
	// Timestamp The creation timestamp for the snapshot.
	Timestamp int64 `json:"timestamp"`
}

ModelSnapshot type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Model.ts#L25-L46

func NewModelSnapshot added in v8.5.0 

func NewModelSnapshot() *ModelSnapshot

NewModelSnapshot returns a ModelSnapshot.

func (*ModelSnapshot) UnmarshalJSON added in v8.7.1 

func (s *ModelSnapshot) UnmarshalJSON(data []byte) error

type ModelSnapshotUpgrade 

type ModelSnapshotUpgrade struct {
	AssignmentExplanation string                                    `json:"assignment_explanation"`
	JobId                 string                                    `json:"job_id"`
	Node                  DiscoveryNode                             `json:"node"`
	SnapshotId            string                                    `json:"snapshot_id"`
	State                 snapshotupgradestate.SnapshotUpgradeState `json:"state"`
}

ModelSnapshotUpgrade type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Model.ts#L48-L57

func NewModelSnapshotUpgrade added in v8.5.0 

func NewModelSnapshotUpgrade() *ModelSnapshotUpgrade

NewModelSnapshotUpgrade returns a ModelSnapshotUpgrade.

func (*ModelSnapshotUpgrade) UnmarshalJSON added in v8.7.1 

func (s *ModelSnapshotUpgrade) UnmarshalJSON(data []byte) error

type Monitoring 

type Monitoring struct {
	Available         bool             `json:"available"`
	CollectionEnabled bool             `json:"collection_enabled"`
	Enabled           bool             `json:"enabled"`
	EnabledExporters  map[string]int64 `json:"enabled_exporters"`
}

Monitoring type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L391-L394

func NewMonitoring added in v8.5.0 

func NewMonitoring() *Monitoring

NewMonitoring returns a Monitoring.

func (*Monitoring) UnmarshalJSON added in v8.7.1 

func (s *Monitoring) UnmarshalJSON(data []byte) error

type MoreLikeThisQuery 

type MoreLikeThisQuery struct {
	// Analyzer The analyzer that is used to analyze the free form text.
	// Defaults to the analyzer associated with the first field in fields.
	Analyzer *string `json:"analyzer,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// BoostTerms Each term in the formed query could be further boosted by their tf-idf score.
	// This sets the boost factor to use when using this feature.
	// Defaults to deactivated (0).
	BoostTerms *Float64 `json:"boost_terms,omitempty"`
	// FailOnUnsupportedField Controls whether the query should fail (throw an exception) if any of the
	// specified fields are not of the supported types (`text` or `keyword`).
	FailOnUnsupportedField *bool `json:"fail_on_unsupported_field,omitempty"`
	// Fields A list of fields to fetch and analyze the text from.
	// Defaults to the `index.query.default_field` index setting, which has a
	// default value of `*`.
	Fields []string `json:"fields,omitempty"`
	// Include Specifies whether the input documents should also be included in the search
	// results returned.
	Include *bool `json:"include,omitempty"`
	// Like Specifies free form text and/or a single or multiple documents for which you
	// want to find similar documents.
	Like []Like `json:"like"`
	// MaxDocFreq The maximum document frequency above which the terms are ignored from the
	// input document.
	MaxDocFreq *int `json:"max_doc_freq,omitempty"`
	// MaxQueryTerms The maximum number of query terms that can be selected.
	MaxQueryTerms *int `json:"max_query_terms,omitempty"`
	// MaxWordLength The maximum word length above which the terms are ignored.
	// Defaults to unbounded (`0`).
	MaxWordLength *int `json:"max_word_length,omitempty"`
	// MinDocFreq The minimum document frequency below which the terms are ignored from the
	// input document.
	MinDocFreq *int `json:"min_doc_freq,omitempty"`
	// MinTermFreq The minimum term frequency below which the terms are ignored from the input
	// document.
	MinTermFreq *int `json:"min_term_freq,omitempty"`
	// MinWordLength The minimum word length below which the terms are ignored.
	MinWordLength *int `json:"min_word_length,omitempty"`
	// MinimumShouldMatch After the disjunctive query has been formed, this parameter controls the
	// number of terms that must match.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	QueryName_         *string            `json:"_name,omitempty"`
	Routing            *string            `json:"routing,omitempty"`
	// StopWords An array of stop words.
	// Any word in this set is ignored.
	StopWords StopWords `json:"stop_words,omitempty"`
	// Unlike Used in combination with `like` to exclude documents that match a set of
	// terms.
	Unlike      []Like                   `json:"unlike,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

MoreLikeThisQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L87-L172

func NewMoreLikeThisQuery added in v8.5.0 

func NewMoreLikeThisQuery() *MoreLikeThisQuery

NewMoreLikeThisQuery returns a MoreLikeThisQuery.

func (*MoreLikeThisQuery) UnmarshalJSON added in v8.7.1 

func (s *MoreLikeThisQuery) UnmarshalJSON(data []byte) error

type MountedSnapshot 

type MountedSnapshot struct {
	Indices  []string        `json:"indices"`
	Shards   ShardStatistics `json:"shards"`
	Snapshot string          `json:"snapshot"`
}

MountedSnapshot type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/searchable_snapshots/mount/types.ts#L23-L27

func NewMountedSnapshot added in v8.5.0 

func NewMountedSnapshot() *MountedSnapshot

NewMountedSnapshot returns a MountedSnapshot.

func (*MountedSnapshot) UnmarshalJSON added in v8.7.1 

func (s *MountedSnapshot) UnmarshalJSON(data []byte) error

type MovingAverageAggregation 

type MovingAverageAggregation any

MovingAverageAggregation holds the union for the following types: 

LinearMovingAverageAggregation
SimpleMovingAverageAggregation
EwmaMovingAverageAggregation
HoltMovingAverageAggregation
HoltWintersMovingAverageAggregation

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L254-L260

type MovingFunctionAggregation 

type MovingFunctionAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Script The script that should be executed on each window of data.
	Script *string `json:"script,omitempty"`
	// Shift By default, the window consists of the last n values excluding the current
	// bucket.
	// Increasing `shift` by 1, moves the starting window position by 1 to the
	// right.
	Shift *int `json:"shift,omitempty"`
	// Window The size of window to "slide" across the histogram.
	Window *int `json:"window,omitempty"`
}

MovingFunctionAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L314-L332

func NewMovingFunctionAggregation added in v8.5.0 

func NewMovingFunctionAggregation() *MovingFunctionAggregation

NewMovingFunctionAggregation returns a MovingFunctionAggregation.

func (*MovingFunctionAggregation) UnmarshalJSON added in v8.7.0 

func (s *MovingFunctionAggregation) UnmarshalJSON(data []byte) error

type MovingPercentilesAggregation 

type MovingPercentilesAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	Keyed     *bool                `json:"keyed,omitempty"`
	// Shift By default, the window consists of the last n values excluding the current
	// bucket.
	// Increasing `shift` by 1, moves the starting window position by 1 to the
	// right.
	Shift *int `json:"shift,omitempty"`
	// Window The size of window to "slide" across the histogram.
	Window *int `json:"window,omitempty"`
}

MovingPercentilesAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L334-L349

func NewMovingPercentilesAggregation added in v8.5.0 

func NewMovingPercentilesAggregation() *MovingPercentilesAggregation

NewMovingPercentilesAggregation returns a MovingPercentilesAggregation.

func (*MovingPercentilesAggregation) UnmarshalJSON added in v8.7.0 

func (s *MovingPercentilesAggregation) UnmarshalJSON(data []byte) error

type MsearchRequestItem added in v8.9.0 

type MsearchRequestItem any

MsearchRequestItem holds the union for the following types: 

MultisearchHeader
MultisearchBody

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L47-L50

type MsearchResponseItem added in v8.9.0 

type MsearchResponseItem any

MsearchResponseItem holds the union for the following types: 

MultiSearchItem
ErrorResponseBase

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L211-L214

type MultiBucketAggregateBaseAdjacencyMatrixBucket 

type MultiBucketAggregateBaseAdjacencyMatrixBucket struct {
	Buckets BucketsAdjacencyMatrixBucket `json:"buckets"`
	Meta    Metadata                     `json:"meta,omitempty"`
}

MultiBucketAggregateBaseAdjacencyMatrixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseAdjacencyMatrixBucket added in v8.5.0 

func NewMultiBucketAggregateBaseAdjacencyMatrixBucket() *MultiBucketAggregateBaseAdjacencyMatrixBucket

NewMultiBucketAggregateBaseAdjacencyMatrixBucket returns a MultiBucketAggregateBaseAdjacencyMatrixBucket.

func (*MultiBucketAggregateBaseAdjacencyMatrixBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseAdjacencyMatrixBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseCompositeBucket 

type MultiBucketAggregateBaseCompositeBucket struct {
	Buckets BucketsCompositeBucket `json:"buckets"`
	Meta    Metadata               `json:"meta,omitempty"`
}

MultiBucketAggregateBaseCompositeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseCompositeBucket added in v8.5.0 

func NewMultiBucketAggregateBaseCompositeBucket() *MultiBucketAggregateBaseCompositeBucket

NewMultiBucketAggregateBaseCompositeBucket returns a MultiBucketAggregateBaseCompositeBucket.

func (*MultiBucketAggregateBaseCompositeBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseCompositeBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseDateHistogramBucket 

type MultiBucketAggregateBaseDateHistogramBucket struct {
	Buckets BucketsDateHistogramBucket `json:"buckets"`
	Meta    Metadata                   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseDateHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseDateHistogramBucket added in v8.5.0 

func NewMultiBucketAggregateBaseDateHistogramBucket() *MultiBucketAggregateBaseDateHistogramBucket

NewMultiBucketAggregateBaseDateHistogramBucket returns a MultiBucketAggregateBaseDateHistogramBucket.

func (*MultiBucketAggregateBaseDateHistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseDateHistogramBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseDoubleTermsBucket 

type MultiBucketAggregateBaseDoubleTermsBucket struct {
	Buckets BucketsDoubleTermsBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

MultiBucketAggregateBaseDoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseDoubleTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseDoubleTermsBucket() *MultiBucketAggregateBaseDoubleTermsBucket

NewMultiBucketAggregateBaseDoubleTermsBucket returns a MultiBucketAggregateBaseDoubleTermsBucket.

func (*MultiBucketAggregateBaseDoubleTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseDoubleTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseFiltersBucket 

type MultiBucketAggregateBaseFiltersBucket struct {
	Buckets BucketsFiltersBucket `json:"buckets"`
	Meta    Metadata             `json:"meta,omitempty"`
}

MultiBucketAggregateBaseFiltersBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseFiltersBucket added in v8.5.0 

func NewMultiBucketAggregateBaseFiltersBucket() *MultiBucketAggregateBaseFiltersBucket

NewMultiBucketAggregateBaseFiltersBucket returns a MultiBucketAggregateBaseFiltersBucket.

func (*MultiBucketAggregateBaseFiltersBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseFiltersBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseFrequentItemSetsBucket added in v8.8.0 

type MultiBucketAggregateBaseFrequentItemSetsBucket struct {
	Buckets BucketsFrequentItemSetsBucket `json:"buckets"`
	Meta    Metadata                      `json:"meta,omitempty"`
}

MultiBucketAggregateBaseFrequentItemSetsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseFrequentItemSetsBucket added in v8.8.0 

func NewMultiBucketAggregateBaseFrequentItemSetsBucket() *MultiBucketAggregateBaseFrequentItemSetsBucket

NewMultiBucketAggregateBaseFrequentItemSetsBucket returns a MultiBucketAggregateBaseFrequentItemSetsBucket.

func (*MultiBucketAggregateBaseFrequentItemSetsBucket) UnmarshalJSON added in v8.8.0 

func (s *MultiBucketAggregateBaseFrequentItemSetsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseGeoHashGridBucket 

type MultiBucketAggregateBaseGeoHashGridBucket struct {
	Buckets BucketsGeoHashGridBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoHashGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseGeoHashGridBucket added in v8.5.0 

func NewMultiBucketAggregateBaseGeoHashGridBucket() *MultiBucketAggregateBaseGeoHashGridBucket

NewMultiBucketAggregateBaseGeoHashGridBucket returns a MultiBucketAggregateBaseGeoHashGridBucket.

func (*MultiBucketAggregateBaseGeoHashGridBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseGeoHashGridBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseGeoHexGridBucket added in v8.5.0 

type MultiBucketAggregateBaseGeoHexGridBucket struct {
	Buckets BucketsGeoHexGridBucket `json:"buckets"`
	Meta    Metadata                `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoHexGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseGeoHexGridBucket added in v8.5.0 

func NewMultiBucketAggregateBaseGeoHexGridBucket() *MultiBucketAggregateBaseGeoHexGridBucket

NewMultiBucketAggregateBaseGeoHexGridBucket returns a MultiBucketAggregateBaseGeoHexGridBucket.

func (*MultiBucketAggregateBaseGeoHexGridBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseGeoHexGridBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseGeoTileGridBucket 

type MultiBucketAggregateBaseGeoTileGridBucket struct {
	Buckets BucketsGeoTileGridBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoTileGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseGeoTileGridBucket added in v8.5.0 

func NewMultiBucketAggregateBaseGeoTileGridBucket() *MultiBucketAggregateBaseGeoTileGridBucket

NewMultiBucketAggregateBaseGeoTileGridBucket returns a MultiBucketAggregateBaseGeoTileGridBucket.

func (*MultiBucketAggregateBaseGeoTileGridBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseGeoTileGridBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseHistogramBucket 

type MultiBucketAggregateBaseHistogramBucket struct {
	Buckets BucketsHistogramBucket `json:"buckets"`
	Meta    Metadata               `json:"meta,omitempty"`
}

MultiBucketAggregateBaseHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseHistogramBucket added in v8.5.0 

func NewMultiBucketAggregateBaseHistogramBucket() *MultiBucketAggregateBaseHistogramBucket

NewMultiBucketAggregateBaseHistogramBucket returns a MultiBucketAggregateBaseHistogramBucket.

func (*MultiBucketAggregateBaseHistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseHistogramBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseIpPrefixBucket added in v8.5.0 

type MultiBucketAggregateBaseIpPrefixBucket struct {
	Buckets BucketsIpPrefixBucket `json:"buckets"`
	Meta    Metadata              `json:"meta,omitempty"`
}

MultiBucketAggregateBaseIpPrefixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseIpPrefixBucket added in v8.5.0 

func NewMultiBucketAggregateBaseIpPrefixBucket() *MultiBucketAggregateBaseIpPrefixBucket

NewMultiBucketAggregateBaseIpPrefixBucket returns a MultiBucketAggregateBaseIpPrefixBucket.

func (*MultiBucketAggregateBaseIpPrefixBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseIpPrefixBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseIpRangeBucket 

type MultiBucketAggregateBaseIpRangeBucket struct {
	Buckets BucketsIpRangeBucket `json:"buckets"`
	Meta    Metadata             `json:"meta,omitempty"`
}

MultiBucketAggregateBaseIpRangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseIpRangeBucket added in v8.5.0 

func NewMultiBucketAggregateBaseIpRangeBucket() *MultiBucketAggregateBaseIpRangeBucket

NewMultiBucketAggregateBaseIpRangeBucket returns a MultiBucketAggregateBaseIpRangeBucket.

func (*MultiBucketAggregateBaseIpRangeBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseIpRangeBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseLongRareTermsBucket 

type MultiBucketAggregateBaseLongRareTermsBucket struct {
	Buckets BucketsLongRareTermsBucket `json:"buckets"`
	Meta    Metadata                   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseLongRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseLongRareTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseLongRareTermsBucket() *MultiBucketAggregateBaseLongRareTermsBucket

NewMultiBucketAggregateBaseLongRareTermsBucket returns a MultiBucketAggregateBaseLongRareTermsBucket.

func (*MultiBucketAggregateBaseLongRareTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseLongRareTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseLongTermsBucket 

type MultiBucketAggregateBaseLongTermsBucket struct {
	Buckets BucketsLongTermsBucket `json:"buckets"`
	Meta    Metadata               `json:"meta,omitempty"`
}

MultiBucketAggregateBaseLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseLongTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseLongTermsBucket() *MultiBucketAggregateBaseLongTermsBucket

NewMultiBucketAggregateBaseLongTermsBucket returns a MultiBucketAggregateBaseLongTermsBucket.

func (*MultiBucketAggregateBaseLongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseLongTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseMultiTermsBucket 

type MultiBucketAggregateBaseMultiTermsBucket struct {
	Buckets BucketsMultiTermsBucket `json:"buckets"`
	Meta    Metadata                `json:"meta,omitempty"`
}

MultiBucketAggregateBaseMultiTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseMultiTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseMultiTermsBucket() *MultiBucketAggregateBaseMultiTermsBucket

NewMultiBucketAggregateBaseMultiTermsBucket returns a MultiBucketAggregateBaseMultiTermsBucket.

func (*MultiBucketAggregateBaseMultiTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseMultiTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseRangeBucket 

type MultiBucketAggregateBaseRangeBucket struct {
	Buckets BucketsRangeBucket `json:"buckets"`
	Meta    Metadata           `json:"meta,omitempty"`
}

MultiBucketAggregateBaseRangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseRangeBucket added in v8.5.0 

func NewMultiBucketAggregateBaseRangeBucket() *MultiBucketAggregateBaseRangeBucket

NewMultiBucketAggregateBaseRangeBucket returns a MultiBucketAggregateBaseRangeBucket.

func (*MultiBucketAggregateBaseRangeBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseRangeBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseSignificantLongTermsBucket 

type MultiBucketAggregateBaseSignificantLongTermsBucket struct {
	Buckets BucketsSignificantLongTermsBucket `json:"buckets"`
	Meta    Metadata                          `json:"meta,omitempty"`
}

MultiBucketAggregateBaseSignificantLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseSignificantLongTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseSignificantLongTermsBucket() *MultiBucketAggregateBaseSignificantLongTermsBucket

NewMultiBucketAggregateBaseSignificantLongTermsBucket returns a MultiBucketAggregateBaseSignificantLongTermsBucket.

func (*MultiBucketAggregateBaseSignificantLongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseSignificantLongTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseSignificantStringTermsBucket 

type MultiBucketAggregateBaseSignificantStringTermsBucket struct {
	Buckets BucketsSignificantStringTermsBucket `json:"buckets"`
	Meta    Metadata                            `json:"meta,omitempty"`
}

MultiBucketAggregateBaseSignificantStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseSignificantStringTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseSignificantStringTermsBucket() *MultiBucketAggregateBaseSignificantStringTermsBucket

NewMultiBucketAggregateBaseSignificantStringTermsBucket returns a MultiBucketAggregateBaseSignificantStringTermsBucket.

func (*MultiBucketAggregateBaseSignificantStringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseSignificantStringTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseStringRareTermsBucket 

type MultiBucketAggregateBaseStringRareTermsBucket struct {
	Buckets BucketsStringRareTermsBucket `json:"buckets"`
	Meta    Metadata                     `json:"meta,omitempty"`
}

MultiBucketAggregateBaseStringRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseStringRareTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseStringRareTermsBucket() *MultiBucketAggregateBaseStringRareTermsBucket

NewMultiBucketAggregateBaseStringRareTermsBucket returns a MultiBucketAggregateBaseStringRareTermsBucket.

func (*MultiBucketAggregateBaseStringRareTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseStringRareTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseStringTermsBucket 

type MultiBucketAggregateBaseStringTermsBucket struct {
	Buckets BucketsStringTermsBucket `json:"buckets"`
	Meta    Metadata                 `json:"meta,omitempty"`
}

MultiBucketAggregateBaseStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseStringTermsBucket added in v8.5.0 

func NewMultiBucketAggregateBaseStringTermsBucket() *MultiBucketAggregateBaseStringTermsBucket

NewMultiBucketAggregateBaseStringTermsBucket returns a MultiBucketAggregateBaseStringTermsBucket.

func (*MultiBucketAggregateBaseStringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseStringTermsBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseTimeSeriesBucket added in v8.16.0 

type MultiBucketAggregateBaseTimeSeriesBucket struct {
	Buckets BucketsTimeSeriesBucket `json:"buckets"`
	Meta    Metadata                `json:"meta,omitempty"`
}

MultiBucketAggregateBaseTimeSeriesBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseTimeSeriesBucket added in v8.16.0 

func NewMultiBucketAggregateBaseTimeSeriesBucket() *MultiBucketAggregateBaseTimeSeriesBucket

NewMultiBucketAggregateBaseTimeSeriesBucket returns a MultiBucketAggregateBaseTimeSeriesBucket.

func (*MultiBucketAggregateBaseTimeSeriesBucket) UnmarshalJSON added in v8.16.0 

func (s *MultiBucketAggregateBaseTimeSeriesBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseVariableWidthHistogramBucket 

type MultiBucketAggregateBaseVariableWidthHistogramBucket struct {
	Buckets BucketsVariableWidthHistogramBucket `json:"buckets"`
	Meta    Metadata                            `json:"meta,omitempty"`
}

MultiBucketAggregateBaseVariableWidthHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseVariableWidthHistogramBucket added in v8.5.0 

func NewMultiBucketAggregateBaseVariableWidthHistogramBucket() *MultiBucketAggregateBaseVariableWidthHistogramBucket

NewMultiBucketAggregateBaseVariableWidthHistogramBucket returns a MultiBucketAggregateBaseVariableWidthHistogramBucket.

func (*MultiBucketAggregateBaseVariableWidthHistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseVariableWidthHistogramBucket) UnmarshalJSON(data []byte) error

type MultiBucketAggregateBaseVoid 

type MultiBucketAggregateBaseVoid struct {
	Buckets BucketsVoid `json:"buckets"`
	Meta    Metadata    `json:"meta,omitempty"`
}

MultiBucketAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L357-L359

func NewMultiBucketAggregateBaseVoid added in v8.5.0 

func NewMultiBucketAggregateBaseVoid() *MultiBucketAggregateBaseVoid

NewMultiBucketAggregateBaseVoid returns a MultiBucketAggregateBaseVoid.

func (*MultiBucketAggregateBaseVoid) UnmarshalJSON added in v8.7.0 

func (s *MultiBucketAggregateBaseVoid) UnmarshalJSON(data []byte) error

type MultiGetError 

type MultiGetError struct {
	Error  ErrorCause `json:"error"`
	Id_    string     `json:"_id"`
	Index_ string     `json:"_index"`
}

MultiGetError type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/mget/types.ts#L62-L66

func NewMultiGetError added in v8.5.0 

func NewMultiGetError() *MultiGetError

NewMultiGetError returns a MultiGetError.

func (*MultiGetError) UnmarshalJSON added in v8.7.1 

func (s *MultiGetError) UnmarshalJSON(data []byte) error

type MultiMatchQuery 

type MultiMatchQuery struct {
	// Analyzer Analyzer used to convert the text in the query value into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// AutoGenerateSynonymsPhraseQuery If `true`, match phrase queries are automatically created for multi-term
	// synonyms.
	AutoGenerateSynonymsPhraseQuery *bool `json:"auto_generate_synonyms_phrase_query,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost           *float32 `json:"boost,omitempty"`
	CutoffFrequency *Float64 `json:"cutoff_frequency,omitempty"`
	// Fields The fields to be queried.
	// Defaults to the `index.query.default_field` index settings, which in turn
	// defaults to `*`.
	Fields []string `json:"fields,omitempty"`
	// Fuzziness Maximum edit distance allowed for matching.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// FuzzyRewrite Method used to rewrite the query.
	FuzzyRewrite *string `json:"fuzzy_rewrite,omitempty"`
	// FuzzyTranspositions If `true`, edits for fuzzy matching include transpositions of two adjacent
	// characters (for example, `ab` to `ba`).
	// Can be applied to the term subqueries constructed for all terms but the final
	// term.
	FuzzyTranspositions *bool `json:"fuzzy_transpositions,omitempty"`
	// Lenient If `true`, format-based errors, such as providing a text query value for a
	// numeric field, are ignored.
	Lenient *bool `json:"lenient,omitempty"`
	// MaxExpansions Maximum number of terms to which the query will expand.
	MaxExpansions *int `json:"max_expansions,omitempty"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Operator Boolean logic used to interpret text in the query value.
	Operator *operator.Operator `json:"operator,omitempty"`
	// PrefixLength Number of beginning characters left unchanged for fuzzy matching.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Query Text, number, boolean value or date you wish to find in the provided field.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// Slop Maximum number of positions allowed between matching tokens.
	Slop *int `json:"slop,omitempty"`
	// TieBreaker Determines how scores for each per-term blended query and scores across
	// groups are combined.
	TieBreaker *Float64 `json:"tie_breaker,omitempty"`
	// Type How `the` multi_match query is executed internally.
	Type *textquerytype.TextQueryType `json:"type,omitempty"`
	// ZeroTermsQuery Indicates whether no documents are returned if the `analyzer` removes all
	// tokens, such as when using a `stop` filter.
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MultiMatchQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L522-L608

func NewMultiMatchQuery added in v8.5.0 

func NewMultiMatchQuery() *MultiMatchQuery

NewMultiMatchQuery returns a MultiMatchQuery.

func (*MultiMatchQuery) UnmarshalJSON added in v8.7.1 

func (s *MultiMatchQuery) UnmarshalJSON(data []byte) error

type MultiSearchItem added in v8.9.0 

type MultiSearchItem struct {
	Aggregations map[string]Aggregate       `json:"aggregations,omitempty"`
	Clusters_    *ClusterStatistics         `json:"_clusters,omitempty"`
	Fields       map[string]json.RawMessage `json:"fields,omitempty"`
	// Hits The returned documents and metadata.
	Hits            HitsMetadata `json:"hits"`
	MaxScore        *Float64     `json:"max_score,omitempty"`
	NumReducePhases *int64       `json:"num_reduce_phases,omitempty"`
	PitId           *string      `json:"pit_id,omitempty"`
	Profile         *Profile     `json:"profile,omitempty"`
	// ScrollId_ The identifier for the search and its search context.
	// You can use this scroll ID with the scroll API to retrieve the next batch of
	// search results for the request.
	// This property is returned only if the `scroll` query parameter is specified
	// in the request.
	ScrollId_ *string `json:"_scroll_id,omitempty"`
	// Shards_ A count of shards used for the request.
	Shards_         ShardStatistics      `json:"_shards"`
	Status          *int                 `json:"status,omitempty"`
	Suggest         map[string][]Suggest `json:"suggest,omitempty"`
	TerminatedEarly *bool                `json:"terminated_early,omitempty"`
	// TimedOut If `true`, the request timed out before completion; returned results may be
	// partial or empty.
	TimedOut bool `json:"timed_out"`
	// Took The number of milliseconds it took Elasticsearch to run the request.
	// This value is calculated by measuring the time elapsed between receipt of a
	// request on the coordinating node and the time at which the coordinating node
	// is ready to send the response.
	// It includes:
	//
	// * Communication time between the coordinating node and data nodes
	// * Time the request spends in the search thread pool, queued for execution
	// * Actual run time
	//
	// It does not include:
	//
	// * Time needed to send the request to Elasticsearch
	// * Time needed to serialize the JSON response
	// * Time needed to send the response to a client
	Took int64 `json:"took"`
}

MultiSearchItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L216-L219

func NewMultiSearchItem added in v8.9.0 

func NewMultiSearchItem() *MultiSearchItem

NewMultiSearchItem returns a MultiSearchItem.

func (*MultiSearchItem) UnmarshalJSON added in v8.9.0 

func (s *MultiSearchItem) UnmarshalJSON(data []byte) error

type MultiSearchResult added in v8.9.0 

type MultiSearchResult struct {
	Responses []MsearchResponseItem `json:"responses"`
	Took      int64                 `json:"took"`
}

MultiSearchResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L206-L209

func NewMultiSearchResult added in v8.9.0 

func NewMultiSearchResult() *MultiSearchResult

NewMultiSearchResult returns a MultiSearchResult.

func (*MultiSearchResult) UnmarshalJSON added in v8.9.0 

func (s *MultiSearchResult) UnmarshalJSON(data []byte) error

type MultiTermLookup 

type MultiTermLookup struct {
	// Field A fields from which to retrieve terms.
	Field string `json:"field"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
}

MultiTermLookup type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L643-L653

func NewMultiTermLookup added in v8.5.0 

func NewMultiTermLookup() *MultiTermLookup

NewMultiTermLookup returns a MultiTermLookup.

func (*MultiTermLookup) UnmarshalJSON added in v8.7.1 

func (s *MultiTermLookup) UnmarshalJSON(data []byte) error

type MultiTermsAggregate 

type MultiTermsAggregate struct {
	Buckets                 BucketsMultiTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                  `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                `json:"meta,omitempty"`
	SumOtherDocCount        *int64                  `json:"sum_other_doc_count,omitempty"`
}

MultiTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L501-L506

func NewMultiTermsAggregate added in v8.5.0 

func NewMultiTermsAggregate() *MultiTermsAggregate

NewMultiTermsAggregate returns a MultiTermsAggregate.

func (*MultiTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *MultiTermsAggregate) UnmarshalJSON(data []byte) error

type MultiTermsAggregation 

type MultiTermsAggregation struct {
	// CollectMode Specifies the strategy for data collection.
	CollectMode *termsaggregationcollectmode.TermsAggregationCollectMode `json:"collect_mode,omitempty"`
	// MinDocCount The minimum number of documents in a bucket for it to be returned.
	MinDocCount *int64 `json:"min_doc_count,omitempty"`
	// Order Specifies the sort order of the buckets.
	// Defaults to sorting by descending document count.
	Order AggregateOrder `json:"order,omitempty"`
	// ShardMinDocCount The minimum number of documents in a bucket on each shard for it to be
	// returned.
	ShardMinDocCount *int64 `json:"shard_min_doc_count,omitempty"`
	// ShardSize The number of candidate terms produced by each shard.
	// By default, `shard_size` will be automatically estimated based on the number
	// of shards and the `size` parameter.
	ShardSize *int `json:"shard_size,omitempty"`
	// ShowTermDocCountError Calculates the doc count error on per term basis.
	ShowTermDocCountError *bool `json:"show_term_doc_count_error,omitempty"`
	// Size The number of term buckets should be returned out of the overall terms list.
	Size *int `json:"size,omitempty"`
	// Terms The field from which to generate sets of terms.
	Terms []MultiTermLookup `json:"terms"`
}

MultiTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L601-L641

func NewMultiTermsAggregation added in v8.5.0 

func NewMultiTermsAggregation() *MultiTermsAggregation

NewMultiTermsAggregation returns a MultiTermsAggregation.

func (*MultiTermsAggregation) UnmarshalJSON added in v8.7.0 

func (s *MultiTermsAggregation) UnmarshalJSON(data []byte) error

type MultiTermsBucket 

type MultiTermsBucket struct {
	Aggregations            map[string]Aggregate `json:"-"`
	DocCount                int64                `json:"doc_count"`
	DocCountErrorUpperBound *int64               `json:"doc_count_error_upper_bound,omitempty"`
	Key                     []FieldValue         `json:"key"`
	KeyAsString             *string              `json:"key_as_string,omitempty"`
}

MultiTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L508-L512

func NewMultiTermsBucket added in v8.5.0 

func NewMultiTermsBucket() *MultiTermsBucket

NewMultiTermsBucket returns a MultiTermsBucket.

func (MultiTermsBucket) MarshalJSON 

func (s MultiTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*MultiTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *MultiTermsBucket) UnmarshalJSON(data []byte) error

type MultiplexerTokenFilter 

type MultiplexerTokenFilter struct {
	// Filters A list of token filters to apply to incoming tokens.
	Filters []string `json:"filters"`
	// PreserveOriginal If `true` (the default) then emit the original token in addition to the
	// filtered tokens.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	Type             string             `json:"type,omitempty"`
	Version          *string            `json:"version,omitempty"`
}

MultiplexerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L356-L362

func NewMultiplexerTokenFilter added in v8.5.0 

func NewMultiplexerTokenFilter() *MultiplexerTokenFilter

NewMultiplexerTokenFilter returns a MultiplexerTokenFilter.

func (MultiplexerTokenFilter) MarshalJSON added in v8.9.0 

func (s MultiplexerTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*MultiplexerTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *MultiplexerTokenFilter) UnmarshalJSON(data []byte) error

type MultisearchBody added in v8.9.0 

type MultisearchBody struct {
	Aggregations map[string]Aggregations `json:"aggregations,omitempty"`
	Collapse     *FieldCollapse          `json:"collapse,omitempty"`
	// DocvalueFields Array of wildcard (*) patterns. The request returns doc values for field
	// names matching these patterns in the hits.fields property of the response.
	DocvalueFields []FieldAndFormat `json:"docvalue_fields,omitempty"`
	// Explain If true, returns detailed information about score computation as part of a
	// hit.
	Explain *bool `json:"explain,omitempty"`
	// Ext Configuration of search extensions defined by Elasticsearch plugins.
	Ext map[string]json.RawMessage `json:"ext,omitempty"`
	// Fields Array of wildcard (*) patterns. The request returns values for field names
	// matching these patterns in the hits.fields property of the response.
	Fields []FieldAndFormat `json:"fields,omitempty"`
	// From Starting document offset. By default, you cannot page through more than
	// 10,000
	// hits using the from and size parameters. To page through more hits, use the
	// search_after parameter.
	From      *int       `json:"from,omitempty"`
	Highlight *Highlight `json:"highlight,omitempty"`
	// IndicesBoost Boosts the _score of documents from specified indices.
	IndicesBoost []map[string]Float64 `json:"indices_boost,omitempty"`
	// Knn Defines the approximate kNN search to run.
	Knn []KnnSearch `json:"knn,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are
	// not included in the search results.
	MinScore *Float64 `json:"min_score,omitempty"`
	// Pit Limits the search to a point in time (PIT). If you provide a PIT, you
	// cannot specify an <index> in the request path.
	Pit        *PointInTimeReference `json:"pit,omitempty"`
	PostFilter *Query                `json:"post_filter,omitempty"`
	Profile    *bool                 `json:"profile,omitempty"`
	// Query Defines the search definition using the Query DSL.
	Query   *Query    `json:"query,omitempty"`
	Rescore []Rescore `json:"rescore,omitempty"`
	// RuntimeMappings Defines one or more runtime fields in the search request. These fields take
	// precedence over mapped fields with the same name.
	RuntimeMappings RuntimeFields `json:"runtime_mappings,omitempty"`
	// ScriptFields Retrieve a script evaluation (based on different fields) for each hit.
	ScriptFields map[string]ScriptField `json:"script_fields,omitempty"`
	SearchAfter  []FieldValue           `json:"search_after,omitempty"`
	// SeqNoPrimaryTerm If true, returns sequence number and primary term of the last modification
	// of each hit. See Optimistic concurrency control.
	SeqNoPrimaryTerm *bool `json:"seq_no_primary_term,omitempty"`
	// Size The number of hits to return. By default, you cannot page through more
	// than 10,000 hits using the from and size parameters. To page through more
	// hits, use the search_after parameter.
	Size *int               `json:"size,omitempty"`
	Sort []SortCombinations `json:"sort,omitempty"`
	// Source_ Indicates which source fields are returned for matching documents. These
	// fields are returned in the hits._source property of the search response.
	Source_ SourceConfig `json:"_source,omitempty"`
	// Stats Stats groups to associate with the search. Each group maintains a statistics
	// aggregation for its associated searches. You can retrieve these stats using
	// the indices stats API.
	Stats []string `json:"stats,omitempty"`
	// StoredFields List of stored fields to return as part of a hit. If no fields are specified,
	// no stored fields are included in the response. If this field is specified,
	// the _source
	// parameter defaults to false. You can pass _source: true to return both source
	// fields
	// and stored fields in the search response.
	StoredFields []string   `json:"stored_fields,omitempty"`
	Suggest      *Suggester `json:"suggest,omitempty"`
	// TerminateAfter Maximum number of documents to collect for each shard. If a query reaches
	// this
	// limit, Elasticsearch terminates the query early. Elasticsearch collects
	// documents
	// before sorting. Defaults to 0, which does not terminate query execution
	// early.
	TerminateAfter *int64 `json:"terminate_after,omitempty"`
	// Timeout Specifies the period of time to wait for a response from each shard. If no
	// response
	// is received before the timeout expires, the request fails and returns an
	// error.
	// Defaults to no timeout.
	Timeout *string `json:"timeout,omitempty"`
	// TrackScores If true, calculate and return document scores, even if the scores are not
	// used for sorting.
	TrackScores *bool `json:"track_scores,omitempty"`
	// TrackTotalHits Number of hits matching the query to count accurately. If true, the exact
	// number of hits is returned at the cost of some performance. If false, the
	// response does not include the total number of hits matching the query.
	// Defaults to 10,000 hits.
	TrackTotalHits TrackHits `json:"track_total_hits,omitempty"`
	// Version If true, returns document version as part of a hit.
	Version *bool `json:"version,omitempty"`
}

MultisearchBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L70-L204

func NewMultisearchBody added in v8.9.0 

func NewMultisearchBody() *MultisearchBody

NewMultisearchBody returns a MultisearchBody.

func (*MultisearchBody) UnmarshalJSON added in v8.9.0 

func (s *MultisearchBody) UnmarshalJSON(data []byte) error

type MultisearchHeader added in v8.9.0 

type MultisearchHeader struct {
	AllowNoIndices            *bool                           `json:"allow_no_indices,omitempty"`
	AllowPartialSearchResults *bool                           `json:"allow_partial_search_results,omitempty"`
	CcsMinimizeRoundtrips     *bool                           `json:"ccs_minimize_roundtrips,omitempty"`
	ExpandWildcards           []expandwildcard.ExpandWildcard `json:"expand_wildcards,omitempty"`
	IgnoreThrottled           *bool                           `json:"ignore_throttled,omitempty"`
	IgnoreUnavailable         *bool                           `json:"ignore_unavailable,omitempty"`
	Index                     []string                        `json:"index,omitempty"`
	Preference                *string                         `json:"preference,omitempty"`
	RequestCache              *bool                           `json:"request_cache,omitempty"`
	Routing                   *string                         `json:"routing,omitempty"`
	SearchType                *searchtype.SearchType          `json:"search_type,omitempty"`
}

MultisearchHeader type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch/types.ts#L52-L67

func NewMultisearchHeader added in v8.9.0 

func NewMultisearchHeader() *MultisearchHeader

NewMultisearchHeader returns a MultisearchHeader.

func (*MultisearchHeader) UnmarshalJSON added in v8.9.0 

func (s *MultisearchHeader) UnmarshalJSON(data []byte) error

type Murmur3HashProperty 

type Murmur3HashProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

Murmur3HashProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L90-L92

func NewMurmur3HashProperty added in v8.5.0 

func NewMurmur3HashProperty() *Murmur3HashProperty

NewMurmur3HashProperty returns a Murmur3HashProperty.

func (Murmur3HashProperty) MarshalJSON added in v8.9.0 

func (s Murmur3HashProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*Murmur3HashProperty) UnmarshalJSON added in v8.7.0 

func (s *Murmur3HashProperty) UnmarshalJSON(data []byte) error

type MutualInformationHeuristic 

type MutualInformationHeuristic struct {
	// BackgroundIsSuperset Set to `false` if you defined a custom background filter that represents a
	// different set of documents that you want to compare to.
	BackgroundIsSuperset *bool `json:"background_is_superset,omitempty"`
	// IncludeNegatives Set to `false` to filter out the terms that appear less often in the subset
	// than in documents outside the subset.
	IncludeNegatives *bool `json:"include_negatives,omitempty"`
}

MutualInformationHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L800-L809

func NewMutualInformationHeuristic added in v8.5.0 

func NewMutualInformationHeuristic() *MutualInformationHeuristic

NewMutualInformationHeuristic returns a MutualInformationHeuristic.

func (*MutualInformationHeuristic) UnmarshalJSON added in v8.7.1 

func (s *MutualInformationHeuristic) UnmarshalJSON(data []byte) error

type NGramTokenFilter 

type NGramTokenFilter struct {
	// MaxGram Maximum length of characters in a gram. Defaults to `2`.
	MaxGram *int `json:"max_gram,omitempty"`
	// MinGram Minimum length of characters in a gram. Defaults to `1`.
	MinGram *int `json:"min_gram,omitempty"`
	// PreserveOriginal Emits original token when set to `true`. Defaults to `false`.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	Type             string             `json:"type,omitempty"`
	Version          *string            `json:"version,omitempty"`
}

NGramTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L364-L372

func NewNGramTokenFilter added in v8.5.0 

func NewNGramTokenFilter() *NGramTokenFilter

NewNGramTokenFilter returns a NGramTokenFilter.

func (NGramTokenFilter) MarshalJSON added in v8.9.0 

func (s NGramTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NGramTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *NGramTokenFilter) UnmarshalJSON(data []byte) error

type NGramTokenizer 

type NGramTokenizer struct {
	CustomTokenChars *string               `json:"custom_token_chars,omitempty"`
	MaxGram          *int                  `json:"max_gram,omitempty"`
	MinGram          *int                  `json:"min_gram,omitempty"`
	TokenChars       []tokenchar.TokenChar `json:"token_chars,omitempty"`
	Type             string                `json:"type,omitempty"`
	Version          *string               `json:"version,omitempty"`
}

NGramTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L84-L93

func NewNGramTokenizer added in v8.5.0 

func NewNGramTokenizer() *NGramTokenizer

NewNGramTokenizer returns a NGramTokenizer.

func (NGramTokenizer) MarshalJSON added in v8.9.0 

func (s NGramTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NGramTokenizer) UnmarshalJSON added in v8.7.1 

func (s *NGramTokenizer) UnmarshalJSON(data []byte) error

type Names 

type Names []string

Names type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L81-L81

type NativeCode 

type NativeCode struct {
	BuildHash string `json:"build_hash"`
	Version   string `json:"version"`
}

NativeCode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/info/types.ts#L29-L32

func NewNativeCode added in v8.5.0 

func NewNativeCode() *NativeCode

NewNativeCode returns a NativeCode.

func (*NativeCode) UnmarshalJSON added in v8.7.1 

func (s *NativeCode) UnmarshalJSON(data []byte) error

type NativeCodeInformation 

type NativeCodeInformation struct {
	BuildHash string `json:"build_hash"`
	Version   string `json:"version"`
}

NativeCodeInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/info/types.ts#L29-L32

func NewNativeCodeInformation added in v8.5.0 

func NewNativeCodeInformation() *NativeCodeInformation

NewNativeCodeInformation returns a NativeCodeInformation.

func (*NativeCodeInformation) UnmarshalJSON added in v8.7.1 

func (s *NativeCodeInformation) UnmarshalJSON(data []byte) error

type NerInferenceOptions 

type NerInferenceOptions struct {
	// ClassificationLabels The token classification labels. Must be IOB formatted tags
	ClassificationLabels []string `json:"classification_labels,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   *Vocabulary                  `json:"vocabulary,omitempty"`
}

NerInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L273-L282

func NewNerInferenceOptions added in v8.5.0 

func NewNerInferenceOptions() *NerInferenceOptions

NewNerInferenceOptions returns a NerInferenceOptions.

func (*NerInferenceOptions) UnmarshalJSON added in v8.9.0 

func (s *NerInferenceOptions) UnmarshalJSON(data []byte) error

type NerInferenceUpdateOptions 

type NerInferenceUpdateOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

NerInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L423-L428

func NewNerInferenceUpdateOptions added in v8.5.0 

func NewNerInferenceUpdateOptions() *NerInferenceUpdateOptions

NewNerInferenceUpdateOptions returns a NerInferenceUpdateOptions.

func (*NerInferenceUpdateOptions) UnmarshalJSON added in v8.9.0 

func (s *NerInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type NestedAggregate 

type NestedAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

NestedAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L534-L538

func NewNestedAggregate added in v8.5.0 

func NewNestedAggregate() *NestedAggregate

NewNestedAggregate returns a NestedAggregate.

func (NestedAggregate) MarshalJSON 

func (s NestedAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*NestedAggregate) UnmarshalJSON added in v8.7.0 

func (s *NestedAggregate) UnmarshalJSON(data []byte) error

type NestedAggregation 

type NestedAggregation struct {
	// Path The path to the field of type `nested`.
	Path *string `json:"path,omitempty"`
}

NestedAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L655-L660

func NewNestedAggregation added in v8.5.0 

func NewNestedAggregation() *NestedAggregation

NewNestedAggregation returns a NestedAggregation.

func (*NestedAggregation) UnmarshalJSON added in v8.7.1 

func (s *NestedAggregation) UnmarshalJSON(data []byte) error

type NestedIdentity 

type NestedIdentity struct {
	Field   string          `json:"field"`
	Nested_ *NestedIdentity `json:"_nested,omitempty"`
	Offset  int             `json:"offset"`
}

NestedIdentity type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L90-L94

func NewNestedIdentity added in v8.5.0 

func NewNestedIdentity() *NestedIdentity

NewNestedIdentity returns a NestedIdentity.

func (*NestedIdentity) UnmarshalJSON added in v8.7.1 

func (s *NestedIdentity) UnmarshalJSON(data []byte) error

type NestedProperty 

type NestedProperty struct {
	CopyTo          []string                       `json:"copy_to,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Enabled         *bool                          `json:"enabled,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IncludeInParent *bool                          `json:"include_in_parent,omitempty"`
	IncludeInRoot   *bool                          `json:"include_in_root,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

NestedProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/complex.ts#L39-L44

func NewNestedProperty added in v8.5.0 

func NewNestedProperty() *NestedProperty

NewNestedProperty returns a NestedProperty.

func (NestedProperty) MarshalJSON added in v8.9.0 

func (s NestedProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NestedProperty) UnmarshalJSON added in v8.7.0 

func (s *NestedProperty) UnmarshalJSON(data []byte) error

type NestedQuery 

type NestedQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// IgnoreUnmapped Indicates whether to ignore an unmapped path and not return any documents
	// instead of an error.
	IgnoreUnmapped *bool `json:"ignore_unmapped,omitempty"`
	// InnerHits If defined, each search hit will contain inner hits.
	InnerHits *InnerHits `json:"inner_hits,omitempty"`
	// Path Path to the nested object you wish to search.
	Path string `json:"path"`
	// Query Query you wish to run on nested objects in the path.
	Query      *Query  `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// ScoreMode How scores for matching child objects affect the root parent document’s
	// relevance score.
	ScoreMode *childscoremode.ChildScoreMode `json:"score_mode,omitempty"`
}

NestedQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/joining.ts#L112-L139

func NewNestedQuery added in v8.5.0 

func NewNestedQuery() *NestedQuery

NewNestedQuery returns a NestedQuery.

func (*NestedQuery) UnmarshalJSON added in v8.7.1 

func (s *NestedQuery) UnmarshalJSON(data []byte) error

type NestedSortValue 

type NestedSortValue struct {
	Filter      *Query           `json:"filter,omitempty"`
	MaxChildren *int             `json:"max_children,omitempty"`
	Nested      *NestedSortValue `json:"nested,omitempty"`
	Path        string           `json:"path"`
}

NestedSortValue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L29-L34

func NewNestedSortValue added in v8.5.0 

func NewNestedSortValue() *NestedSortValue

NewNestedSortValue returns a NestedSortValue.

func (*NestedSortValue) UnmarshalJSON added in v8.7.1 

func (s *NestedSortValue) UnmarshalJSON(data []byte) error

type NetworkDirectionProcessor added in v8.16.0 

type NetworkDirectionProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// DestinationIp Field containing the destination IP address.
	DestinationIp *string `json:"destination_ip,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If true and any required fields are missing, the processor quietly exits
	// without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// InternalNetworks List of internal networks. Supports IPv4 and IPv6 addresses and ranges in
	// CIDR notation. Also supports the named ranges listed below. These may be
	// constructed with template snippets. Must specify only one of
	// internal_networks or internal_networks_field.
	InternalNetworks []string `json:"internal_networks,omitempty"`
	// InternalNetworksField A field on the given document to read the internal_networks configuration
	// from.
	InternalNetworksField *string `json:"internal_networks_field,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// SourceIp Field containing the source IP address.
	SourceIp *string `json:"source_ip,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Output field for the network direction.
	TargetField *string `json:"target_field,omitempty"`
}

NetworkDirectionProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1248-L1282

func NewNetworkDirectionProcessor added in v8.16.0 

func NewNetworkDirectionProcessor() *NetworkDirectionProcessor

NewNetworkDirectionProcessor returns a NetworkDirectionProcessor.

func (*NetworkDirectionProcessor) UnmarshalJSON added in v8.16.0 

func (s *NetworkDirectionProcessor) UnmarshalJSON(data []byte) error

type NeverCondition 

type NeverCondition struct {
}

NeverCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L72-L72

func NewNeverCondition added in v8.5.0 

func NewNeverCondition() *NeverCondition

NewNeverCondition returns a NeverCondition.

type NlpBertTokenizationConfig 

type NlpBertTokenizationConfig struct {
	// DoLowerCase Should the tokenizer lower case the text
	DoLowerCase *bool `json:"do_lower_case,omitempty"`
	// MaxSequenceLength Maximum input sequence length for the model
	MaxSequenceLength *int `json:"max_sequence_length,omitempty"`
	// Span Tokenization spanning options. Special value of -1 indicates no spanning
	// takes place
	Span *int `json:"span,omitempty"`
	// Truncate Should tokenization input be automatically truncated before sending to the
	// model for inference
	Truncate *tokenizationtruncate.TokenizationTruncate `json:"truncate,omitempty"`
	// WithSpecialTokens Is tokenization completed with special tokens
	WithSpecialTokens *bool `json:"with_special_tokens,omitempty"`
}

NlpBertTokenizationConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L188-L189

func NewNlpBertTokenizationConfig added in v8.5.0 

func NewNlpBertTokenizationConfig() *NlpBertTokenizationConfig

NewNlpBertTokenizationConfig returns a NlpBertTokenizationConfig.

func (*NlpBertTokenizationConfig) UnmarshalJSON added in v8.7.1 

func (s *NlpBertTokenizationConfig) UnmarshalJSON(data []byte) error

type NlpRobertaTokenizationConfig 

type NlpRobertaTokenizationConfig struct {
	// AddPrefixSpace Should the tokenizer prefix input with a space character
	AddPrefixSpace *bool `json:"add_prefix_space,omitempty"`
	// DoLowerCase Should the tokenizer lower case the text
	DoLowerCase *bool `json:"do_lower_case,omitempty"`
	// MaxSequenceLength Maximum input sequence length for the model
	MaxSequenceLength *int `json:"max_sequence_length,omitempty"`
	// Span Tokenization spanning options. Special value of -1 indicates no spanning
	// takes place
	Span *int `json:"span,omitempty"`
	// Truncate Should tokenization input be automatically truncated before sending to the
	// model for inference
	Truncate *tokenizationtruncate.TokenizationTruncate `json:"truncate,omitempty"`
	// WithSpecialTokens Is tokenization completed with special tokens
	WithSpecialTokens *bool `json:"with_special_tokens,omitempty"`
}

NlpRobertaTokenizationConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L191-L198

func NewNlpRobertaTokenizationConfig added in v8.5.0 

func NewNlpRobertaTokenizationConfig() *NlpRobertaTokenizationConfig

NewNlpRobertaTokenizationConfig returns a NlpRobertaTokenizationConfig.

func (*NlpRobertaTokenizationConfig) UnmarshalJSON added in v8.7.1 

func (s *NlpRobertaTokenizationConfig) UnmarshalJSON(data []byte) error

type NlpTokenizationUpdateOptions 

type NlpTokenizationUpdateOptions struct {
	// Span Span options to apply
	Span *int `json:"span,omitempty"`
	// Truncate Truncate options to apply
	Truncate *tokenizationtruncate.TokenizationTruncate `json:"truncate,omitempty"`
}

NlpTokenizationUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L375-L380

func NewNlpTokenizationUpdateOptions added in v8.5.0 

func NewNlpTokenizationUpdateOptions() *NlpTokenizationUpdateOptions

NewNlpTokenizationUpdateOptions returns a NlpTokenizationUpdateOptions.

func (*NlpTokenizationUpdateOptions) UnmarshalJSON added in v8.7.1 

func (s *NlpTokenizationUpdateOptions) UnmarshalJSON(data []byte) error

type Node 

type Node struct {
	SharedCache Shared `json:"shared_cache"`
}

Node type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/searchable_snapshots/cache_stats/Response.ts#L30-L32

func NewNode added in v8.5.0 

func NewNode() *Node

NewNode returns a Node.

type NodeAllocationExplanation 

type NodeAllocationExplanation struct {
	Deciders         []AllocationDecision `json:"deciders"`
	NodeAttributes   map[string]string    `json:"node_attributes"`
	NodeDecision     decision.Decision    `json:"node_decision"`
	NodeId           string               `json:"node_id"`
	NodeName         string               `json:"node_name"`
	Roles            []noderole.NodeRole  `json:"roles"`
	Store            *AllocationStore     `json:"store,omitempty"`
	TransportAddress string               `json:"transport_address"`
	WeightRanking    int                  `json:"weight_ranking"`
}

NodeAllocationExplanation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L103-L117

func NewNodeAllocationExplanation added in v8.5.0 

func NewNodeAllocationExplanation() *NodeAllocationExplanation

NewNodeAllocationExplanation returns a NodeAllocationExplanation.

func (*NodeAllocationExplanation) UnmarshalJSON added in v8.7.1 

func (s *NodeAllocationExplanation) UnmarshalJSON(data []byte) error

type NodeAttributes 

type NodeAttributes struct {
	// Attributes Lists node attributes.
	Attributes map[string]string `json:"attributes"`
	// EphemeralId The ephemeral ID of the node.
	EphemeralId string `json:"ephemeral_id"`
	// Id The unique identifier of the node.
	Id *string `json:"id,omitempty"`
	// Name The unique identifier of the node.
	Name string `json:"name"`
	// TransportAddress The host and port where transport HTTP connections are accepted.
	TransportAddress string `json:"transport_address"`
}

NodeAttributes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Node.ts#L41-L52

func NewNodeAttributes added in v8.5.0 

func NewNodeAttributes() *NodeAttributes

NewNodeAttributes returns a NodeAttributes.

func (*NodeAttributes) UnmarshalJSON added in v8.7.1 

func (s *NodeAttributes) UnmarshalJSON(data []byte) error

type NodeAttributesRecord 

type NodeAttributesRecord struct {
	// Attr The attribute name.
	Attr *string `json:"attr,omitempty"`
	// Host The host name.
	Host *string `json:"host,omitempty"`
	// Id The unique node identifier.
	Id *string `json:"id,omitempty"`
	// Ip The IP address.
	Ip *string `json:"ip,omitempty"`
	// Node The node name.
	Node *string `json:"node,omitempty"`
	// Pid The process identifier.
	Pid *string `json:"pid,omitempty"`
	// Port The bound transport port.
	Port *string `json:"port,omitempty"`
	// Value The attribute value.
	Value *string `json:"value,omitempty"`
}

NodeAttributesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/nodeattrs/types.ts#L20-L55

func NewNodeAttributesRecord added in v8.5.0 

func NewNodeAttributesRecord() *NodeAttributesRecord

NewNodeAttributesRecord returns a NodeAttributesRecord.

func (*NodeAttributesRecord) UnmarshalJSON added in v8.9.0 

func (s *NodeAttributesRecord) UnmarshalJSON(data []byte) error

type NodeBufferPool 

type NodeBufferPool struct {
	// Count Number of buffer pools.
	Count *int64 `json:"count,omitempty"`
	// TotalCapacity Total capacity of buffer pools.
	TotalCapacity *string `json:"total_capacity,omitempty"`
	// TotalCapacityInBytes Total capacity of buffer pools in bytes.
	TotalCapacityInBytes *int64 `json:"total_capacity_in_bytes,omitempty"`
	// Used Size of buffer pools.
	Used *string `json:"used,omitempty"`
	// UsedInBytes Size of buffer pools in bytes.
	UsedInBytes *int64 `json:"used_in_bytes,omitempty"`
}

NodeBufferPool type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L859-L880

func NewNodeBufferPool added in v8.5.0 

func NewNodeBufferPool() *NodeBufferPool

NewNodeBufferPool returns a NodeBufferPool.

func (*NodeBufferPool) UnmarshalJSON added in v8.7.1 

func (s *NodeBufferPool) UnmarshalJSON(data []byte) error

type NodeDiskUsage 

type NodeDiskUsage struct {
	LeastAvailable DiskUsage `json:"least_available"`
	MostAvailable  DiskUsage `json:"most_available"`
	NodeName       string    `json:"node_name"`
}

NodeDiskUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L57-L61

func NewNodeDiskUsage added in v8.5.0 

func NewNodeDiskUsage() *NodeDiskUsage

NewNodeDiskUsage returns a NodeDiskUsage.

func (*NodeDiskUsage) UnmarshalJSON added in v8.7.1 

func (s *NodeDiskUsage) UnmarshalJSON(data []byte) error

type NodeIds 

type NodeIds []string

NodeIds type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L64-L64

type NodeInfo 

type NodeInfo struct {
	Aggregations map[string]NodeInfoAggregation `json:"aggregations,omitempty"`
	Attributes   map[string]string              `json:"attributes"`
	BuildFlavor  string                         `json:"build_flavor"`
	// BuildHash Short hash of the last git commit in this release.
	BuildHash string `json:"build_hash"`
	BuildType string `json:"build_type"`
	// Host The node’s host name.
	Host   string          `json:"host"`
	Http   *NodeInfoHttp   `json:"http,omitempty"`
	Ingest *NodeInfoIngest `json:"ingest,omitempty"`
	// Ip The node’s IP address.
	Ip      string        `json:"ip"`
	Jvm     *NodeJvmInfo  `json:"jvm,omitempty"`
	Modules []PluginStats `json:"modules,omitempty"`
	// Name The node's name
	Name       string                        `json:"name"`
	Network    *NodeInfoNetwork              `json:"network,omitempty"`
	Os         *NodeOperatingSystemInfo      `json:"os,omitempty"`
	Plugins    []PluginStats                 `json:"plugins,omitempty"`
	Process    *NodeProcessInfo              `json:"process,omitempty"`
	Roles      []noderole.NodeRole           `json:"roles"`
	Settings   *NodeInfoSettings             `json:"settings,omitempty"`
	ThreadPool map[string]NodeThreadPoolInfo `json:"thread_pool,omitempty"`
	// TotalIndexingBuffer Total heap allowed to be used to hold recently indexed documents before they
	// must be written to disk. This size is a shared pool across all shards on this
	// node, and is controlled by Indexing Buffer settings.
	TotalIndexingBuffer *int64 `json:"total_indexing_buffer,omitempty"`
	// TotalIndexingBufferInBytes Same as total_indexing_buffer, but expressed in bytes.
	TotalIndexingBufferInBytes ByteSize           `json:"total_indexing_buffer_in_bytes,omitempty"`
	Transport                  *NodeInfoTransport `json:"transport,omitempty"`
	// TransportAddress Host and port where transport HTTP connections are accepted.
	TransportAddress string `json:"transport_address"`
	// Version Elasticsearch version running on this node.
	Version string `json:"version"`
}

NodeInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L31-L67

func NewNodeInfo added in v8.5.0 

func NewNodeInfo() *NodeInfo

NewNodeInfo returns a NodeInfo.

func (*NodeInfo) UnmarshalJSON added in v8.7.1 

func (s *NodeInfo) UnmarshalJSON(data []byte) error

type NodeInfoAction 

type NodeInfoAction struct {
	DestructiveRequiresName string `json:"destructive_requires_name"`
}

NodeInfoAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L184-L186

func NewNodeInfoAction added in v8.5.0 

func NewNodeInfoAction() *NodeInfoAction

NewNodeInfoAction returns a NodeInfoAction.

func (*NodeInfoAction) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoAction) UnmarshalJSON(data []byte) error

type NodeInfoAggregation 

type NodeInfoAggregation struct {
	Types []string `json:"types"`
}

NodeInfoAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L235-L237

func NewNodeInfoAggregation added in v8.5.0 

func NewNodeInfoAggregation() *NodeInfoAggregation

NewNodeInfoAggregation returns a NodeInfoAggregation.

type NodeInfoBootstrap 

type NodeInfoBootstrap struct {
	MemoryLock string `json:"memory_lock"`
}

NodeInfoBootstrap type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L204-L206

func NewNodeInfoBootstrap added in v8.5.0 

func NewNodeInfoBootstrap() *NodeInfoBootstrap

NewNodeInfoBootstrap returns a NodeInfoBootstrap.

func (*NodeInfoBootstrap) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoBootstrap) UnmarshalJSON(data []byte) error

type NodeInfoClient 

type NodeInfoClient struct {
	Type string `json:"type"`
}

NodeInfoClient type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L188-L190

func NewNodeInfoClient added in v8.5.0 

func NewNodeInfoClient() *NodeInfoClient

NewNodeInfoClient returns a NodeInfoClient.

func (*NodeInfoClient) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoClient) UnmarshalJSON(data []byte) error

type NodeInfoDiscover 

type NodeInfoDiscover struct {
	NodeInfoDiscover map[string]json.RawMessage `json:"-"`
	SeedHosts        []string                   `json:"seed_hosts,omitempty"`
	SeedProviders    []string                   `json:"seed_providers,omitempty"`
	Type             *string                    `json:"type,omitempty"`
}

NodeInfoDiscover type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L173-L182

func NewNodeInfoDiscover added in v8.5.0 

func NewNodeInfoDiscover() *NodeInfoDiscover

NewNodeInfoDiscover returns a NodeInfoDiscover.

func (NodeInfoDiscover) MarshalJSON added in v8.13.0 

func (s NodeInfoDiscover) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*NodeInfoDiscover) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoDiscover) UnmarshalJSON(data []byte) error

type NodeInfoHttp 

type NodeInfoHttp struct {
	BoundAddress            []string `json:"bound_address"`
	MaxContentLength        ByteSize `json:"max_content_length,omitempty"`
	MaxContentLengthInBytes int64    `json:"max_content_length_in_bytes"`
	PublishAddress          string   `json:"publish_address"`
}

NodeInfoHttp type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L311-L316

func NewNodeInfoHttp added in v8.5.0 

func NewNodeInfoHttp() *NodeInfoHttp

NewNodeInfoHttp returns a NodeInfoHttp.

func (*NodeInfoHttp) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoHttp) UnmarshalJSON(data []byte) error

type NodeInfoIngest 

type NodeInfoIngest struct {
	Processors []NodeInfoIngestProcessor `json:"processors"`
}

NodeInfoIngest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L227-L229

func NewNodeInfoIngest added in v8.5.0 

func NewNodeInfoIngest() *NodeInfoIngest

NewNodeInfoIngest returns a NodeInfoIngest.

type NodeInfoIngestDownloader 

type NodeInfoIngestDownloader struct {
	Enabled string `json:"enabled"`
}

NodeInfoIngestDownloader type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L128-L130

func NewNodeInfoIngestDownloader added in v8.5.0 

func NewNodeInfoIngestDownloader() *NodeInfoIngestDownloader

NewNodeInfoIngestDownloader returns a NodeInfoIngestDownloader.

func (*NodeInfoIngestDownloader) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoIngestDownloader) UnmarshalJSON(data []byte) error

type NodeInfoIngestInfo 

type NodeInfoIngestInfo struct {
	Downloader NodeInfoIngestDownloader `json:"downloader"`
}

NodeInfoIngestInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L124-L126

func NewNodeInfoIngestInfo added in v8.5.0 

func NewNodeInfoIngestInfo() *NodeInfoIngestInfo

NewNodeInfoIngestInfo returns a NodeInfoIngestInfo.

type NodeInfoIngestProcessor 

type NodeInfoIngestProcessor struct {
	Type string `json:"type"`
}

NodeInfoIngestProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L231-L233

func NewNodeInfoIngestProcessor added in v8.5.0 

func NewNodeInfoIngestProcessor() *NodeInfoIngestProcessor

NewNodeInfoIngestProcessor returns a NodeInfoIngestProcessor.

func (*NodeInfoIngestProcessor) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoIngestProcessor) UnmarshalJSON(data []byte) error

type NodeInfoJvmMemory 

type NodeInfoJvmMemory struct {
	DirectMax          ByteSize `json:"direct_max,omitempty"`
	DirectMaxInBytes   int64    `json:"direct_max_in_bytes"`
	HeapInit           ByteSize `json:"heap_init,omitempty"`
	HeapInitInBytes    int64    `json:"heap_init_in_bytes"`
	HeapMax            ByteSize `json:"heap_max,omitempty"`
	HeapMaxInBytes     int64    `json:"heap_max_in_bytes"`
	NonHeapInit        ByteSize `json:"non_heap_init,omitempty"`
	NonHeapInitInBytes int64    `json:"non_heap_init_in_bytes"`
	NonHeapMax         ByteSize `json:"non_heap_max,omitempty"`
	NonHeapMaxInBytes  int64    `json:"non_heap_max_in_bytes"`
}

NodeInfoJvmMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L318-L329

func NewNodeInfoJvmMemory added in v8.5.0 

func NewNodeInfoJvmMemory() *NodeInfoJvmMemory

NewNodeInfoJvmMemory returns a NodeInfoJvmMemory.

func (*NodeInfoJvmMemory) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoJvmMemory) UnmarshalJSON(data []byte) error

type NodeInfoMemory 

type NodeInfoMemory struct {
	Total        string `json:"total"`
	TotalInBytes int64  `json:"total_in_bytes"`
}

NodeInfoMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L331-L334

func NewNodeInfoMemory added in v8.5.0 

func NewNodeInfoMemory() *NodeInfoMemory

NewNodeInfoMemory returns a NodeInfoMemory.

func (*NodeInfoMemory) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoMemory) UnmarshalJSON(data []byte) error

type NodeInfoNetwork 

type NodeInfoNetwork struct {
	PrimaryInterface NodeInfoNetworkInterface `json:"primary_interface"`
	RefreshInterval  int                      `json:"refresh_interval"`
}

NodeInfoNetwork type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L336-L339

func NewNodeInfoNetwork added in v8.5.0 

func NewNodeInfoNetwork() *NodeInfoNetwork

NewNodeInfoNetwork returns a NodeInfoNetwork.

func (*NodeInfoNetwork) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoNetwork) UnmarshalJSON(data []byte) error

type NodeInfoNetworkInterface 

type NodeInfoNetworkInterface struct {
	Address    string `json:"address"`
	MacAddress string `json:"mac_address"`
	Name       string `json:"name"`
}

NodeInfoNetworkInterface type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L341-L345

func NewNodeInfoNetworkInterface added in v8.5.0 

func NewNodeInfoNetworkInterface() *NodeInfoNetworkInterface

NewNodeInfoNetworkInterface returns a NodeInfoNetworkInterface.

func (*NodeInfoNetworkInterface) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoNetworkInterface) UnmarshalJSON(data []byte) error

type NodeInfoOSCPU 

type NodeInfoOSCPU struct {
	CacheSize        string `json:"cache_size"`
	CacheSizeInBytes int    `json:"cache_size_in_bytes"`
	CoresPerSocket   int    `json:"cores_per_socket"`
	Mhz              int    `json:"mhz"`
	Model            string `json:"model"`
	TotalCores       int    `json:"total_cores"`
	TotalSockets     int    `json:"total_sockets"`
	Vendor           string `json:"vendor"`
}

NodeInfoOSCPU type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L347-L356

func NewNodeInfoOSCPU added in v8.5.0 

func NewNodeInfoOSCPU() *NodeInfoOSCPU

NewNodeInfoOSCPU returns a NodeInfoOSCPU.

func (*NodeInfoOSCPU) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoOSCPU) UnmarshalJSON(data []byte) error

type NodeInfoPath 

type NodeInfoPath struct {
	Data []string `json:"data,omitempty"`
	Home *string  `json:"home,omitempty"`
	Logs *string  `json:"logs,omitempty"`
	Repo []string `json:"repo,omitempty"`
}

NodeInfoPath type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L158-L163

func NewNodeInfoPath added in v8.5.0 

func NewNodeInfoPath() *NodeInfoPath

NewNodeInfoPath returns a NodeInfoPath.

func (*NodeInfoPath) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoPath) UnmarshalJSON(data []byte) error

type NodeInfoRepositories 

type NodeInfoRepositories struct {
	Url NodeInfoRepositoriesUrl `json:"url"`
}

NodeInfoRepositories type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L165-L167

func NewNodeInfoRepositories added in v8.5.0 

func NewNodeInfoRepositories() *NodeInfoRepositories

NewNodeInfoRepositories returns a NodeInfoRepositories.

type NodeInfoRepositoriesUrl 

type NodeInfoRepositoriesUrl struct {
	AllowedUrls string `json:"allowed_urls"`
}

NodeInfoRepositoriesUrl type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L169-L171

func NewNodeInfoRepositoriesUrl added in v8.5.0 

func NewNodeInfoRepositoriesUrl() *NodeInfoRepositoriesUrl

NewNodeInfoRepositoriesUrl returns a NodeInfoRepositoriesUrl.

func (*NodeInfoRepositoriesUrl) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoRepositoriesUrl) UnmarshalJSON(data []byte) error

type NodeInfoScript 

type NodeInfoScript struct {
	AllowedTypes               string  `json:"allowed_types"`
	DisableMaxCompilationsRate *string `json:"disable_max_compilations_rate,omitempty"`
}

NodeInfoScript type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L289-L292

func NewNodeInfoScript added in v8.5.0 

func NewNodeInfoScript() *NodeInfoScript

NewNodeInfoScript returns a NodeInfoScript.

func (*NodeInfoScript) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoScript) UnmarshalJSON(data []byte) error

type NodeInfoSearch 

type NodeInfoSearch struct {
	Remote NodeInfoSearchRemote `json:"remote"`
}

NodeInfoSearch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L294-L296

func NewNodeInfoSearch added in v8.5.0 

func NewNodeInfoSearch() *NodeInfoSearch

NewNodeInfoSearch returns a NodeInfoSearch.

type NodeInfoSearchRemote 

type NodeInfoSearchRemote struct {
	Connect string `json:"connect"`
}

NodeInfoSearchRemote type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L298-L300

func NewNodeInfoSearchRemote added in v8.5.0 

func NewNodeInfoSearchRemote() *NodeInfoSearchRemote

NewNodeInfoSearchRemote returns a NodeInfoSearchRemote.

func (*NodeInfoSearchRemote) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoSearchRemote) UnmarshalJSON(data []byte) error

type NodeInfoSettings 

type NodeInfoSettings struct {
	Action       *NodeInfoAction           `json:"action,omitempty"`
	Bootstrap    *NodeInfoBootstrap        `json:"bootstrap,omitempty"`
	Client       *NodeInfoClient           `json:"client,omitempty"`
	Cluster      NodeInfoSettingsCluster   `json:"cluster"`
	Discovery    *NodeInfoDiscover         `json:"discovery,omitempty"`
	Http         NodeInfoSettingsHttp      `json:"http"`
	Ingest       *NodeInfoSettingsIngest   `json:"ingest,omitempty"`
	Network      *NodeInfoSettingsNetwork  `json:"network,omitempty"`
	Node         NodeInfoSettingsNode      `json:"node"`
	Path         *NodeInfoPath             `json:"path,omitempty"`
	Repositories *NodeInfoRepositories     `json:"repositories,omitempty"`
	Script       *NodeInfoScript           `json:"script,omitempty"`
	Search       *NodeInfoSearch           `json:"search,omitempty"`
	Transport    NodeInfoSettingsTransport `json:"transport"`
	Xpack        *NodeInfoXpack            `json:"xpack,omitempty"`
}

NodeInfoSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L69-L85

func NewNodeInfoSettings added in v8.5.0 

func NewNodeInfoSettings() *NodeInfoSettings

NewNodeInfoSettings returns a NodeInfoSettings.

type NodeInfoSettingsCluster 

type NodeInfoSettingsCluster struct {
	DeprecationIndexing *DeprecationIndexing            `json:"deprecation_indexing,omitempty"`
	Election            NodeInfoSettingsClusterElection `json:"election"`
	InitialMasterNodes  []string                        `json:"initial_master_nodes,omitempty"`
	Name                string                          `json:"name"`
	Routing             *IndexRouting                   `json:"routing,omitempty"`
}

NodeInfoSettingsCluster type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L132-L142

func NewNodeInfoSettingsCluster added in v8.5.0 

func NewNodeInfoSettingsCluster() *NodeInfoSettingsCluster

NewNodeInfoSettingsCluster returns a NodeInfoSettingsCluster.

func (*NodeInfoSettingsCluster) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsCluster) UnmarshalJSON(data []byte) error

type NodeInfoSettingsClusterElection 

type NodeInfoSettingsClusterElection struct {
	Strategy string `json:"strategy"`
}

NodeInfoSettingsClusterElection type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L148-L150

func NewNodeInfoSettingsClusterElection added in v8.5.0 

func NewNodeInfoSettingsClusterElection() *NodeInfoSettingsClusterElection

NewNodeInfoSettingsClusterElection returns a NodeInfoSettingsClusterElection.

func (*NodeInfoSettingsClusterElection) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsClusterElection) UnmarshalJSON(data []byte) error

type NodeInfoSettingsHttp 

type NodeInfoSettingsHttp struct {
	Compression string                   `json:"compression,omitempty"`
	Port        string                   `json:"port,omitempty"`
	Type        NodeInfoSettingsHttpType `json:"type"`
	TypeDefault *string                  `json:"type.default,omitempty"`
}

NodeInfoSettingsHttp type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L192-L197

func NewNodeInfoSettingsHttp added in v8.5.0 

func NewNodeInfoSettingsHttp() *NodeInfoSettingsHttp

NewNodeInfoSettingsHttp returns a NodeInfoSettingsHttp.

func (*NodeInfoSettingsHttp) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsHttp) UnmarshalJSON(data []byte) error

type NodeInfoSettingsHttpType 

type NodeInfoSettingsHttpType struct {
	Default string `json:"default"`
}

NodeInfoSettingsHttpType type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L199-L202

func NewNodeInfoSettingsHttpType added in v8.5.0 

func NewNodeInfoSettingsHttpType() *NodeInfoSettingsHttpType

NewNodeInfoSettingsHttpType returns a NodeInfoSettingsHttpType.

func (*NodeInfoSettingsHttpType) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsHttpType) UnmarshalJSON(data []byte) error

type NodeInfoSettingsIngest 

type NodeInfoSettingsIngest struct {
	Append          *NodeInfoIngestInfo `json:"append,omitempty"`
	Attachment      *NodeInfoIngestInfo `json:"attachment,omitempty"`
	Bytes           *NodeInfoIngestInfo `json:"bytes,omitempty"`
	Circle          *NodeInfoIngestInfo `json:"circle,omitempty"`
	Convert         *NodeInfoIngestInfo `json:"convert,omitempty"`
	Csv             *NodeInfoIngestInfo `json:"csv,omitempty"`
	Date            *NodeInfoIngestInfo `json:"date,omitempty"`
	DateIndexName   *NodeInfoIngestInfo `json:"date_index_name,omitempty"`
	Dissect         *NodeInfoIngestInfo `json:"dissect,omitempty"`
	DotExpander     *NodeInfoIngestInfo `json:"dot_expander,omitempty"`
	Drop            *NodeInfoIngestInfo `json:"drop,omitempty"`
	Enrich          *NodeInfoIngestInfo `json:"enrich,omitempty"`
	Fail            *NodeInfoIngestInfo `json:"fail,omitempty"`
	Foreach         *NodeInfoIngestInfo `json:"foreach,omitempty"`
	Geoip           *NodeInfoIngestInfo `json:"geoip,omitempty"`
	Grok            *NodeInfoIngestInfo `json:"grok,omitempty"`
	Gsub            *NodeInfoIngestInfo `json:"gsub,omitempty"`
	Inference       *NodeInfoIngestInfo `json:"inference,omitempty"`
	Join            *NodeInfoIngestInfo `json:"join,omitempty"`
	Json            *NodeInfoIngestInfo `json:"json,omitempty"`
	Kv              *NodeInfoIngestInfo `json:"kv,omitempty"`
	Lowercase       *NodeInfoIngestInfo `json:"lowercase,omitempty"`
	Pipeline        *NodeInfoIngestInfo `json:"pipeline,omitempty"`
	Remove          *NodeInfoIngestInfo `json:"remove,omitempty"`
	Rename          *NodeInfoIngestInfo `json:"rename,omitempty"`
	Script          *NodeInfoIngestInfo `json:"script,omitempty"`
	Set             *NodeInfoIngestInfo `json:"set,omitempty"`
	SetSecurityUser *NodeInfoIngestInfo `json:"set_security_user,omitempty"`
	Sort            *NodeInfoIngestInfo `json:"sort,omitempty"`
	Split           *NodeInfoIngestInfo `json:"split,omitempty"`
	Trim            *NodeInfoIngestInfo `json:"trim,omitempty"`
	Uppercase       *NodeInfoIngestInfo `json:"uppercase,omitempty"`
	Urldecode       *NodeInfoIngestInfo `json:"urldecode,omitempty"`
	UserAgent       *NodeInfoIngestInfo `json:"user_agent,omitempty"`
}

NodeInfoSettingsIngest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L87-L122

func NewNodeInfoSettingsIngest added in v8.5.0 

func NewNodeInfoSettingsIngest() *NodeInfoSettingsIngest

NewNodeInfoSettingsIngest returns a NodeInfoSettingsIngest.

type NodeInfoSettingsNetwork 

type NodeInfoSettingsNetwork struct {
	Host []string `json:"host,omitempty"`
}

NodeInfoSettingsNetwork type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L223-L225

func NewNodeInfoSettingsNetwork added in v8.5.0 

func NewNodeInfoSettingsNetwork() *NodeInfoSettingsNetwork

NewNodeInfoSettingsNetwork returns a NodeInfoSettingsNetwork.

func (*NodeInfoSettingsNetwork) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsNetwork) UnmarshalJSON(data []byte) error

type NodeInfoSettingsNode 

type NodeInfoSettingsNode struct {
	Attr                 map[string]json.RawMessage `json:"attr"`
	MaxLocalStorageNodes *string                    `json:"max_local_storage_nodes,omitempty"`
	Name                 string                     `json:"name"`
}

NodeInfoSettingsNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L152-L156

func NewNodeInfoSettingsNode added in v8.5.0 

func NewNodeInfoSettingsNode() *NodeInfoSettingsNode

NewNodeInfoSettingsNode returns a NodeInfoSettingsNode.

func (*NodeInfoSettingsNode) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsNode) UnmarshalJSON(data []byte) error

type NodeInfoSettingsTransport 

type NodeInfoSettingsTransport struct {
	Features    *NodeInfoSettingsTransportFeatures `json:"features,omitempty"`
	Type        NodeInfoSettingsTransportType      `json:"type"`
	TypeDefault *string                            `json:"type.default,omitempty"`
}

NodeInfoSettingsTransport type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L208-L212

func NewNodeInfoSettingsTransport added in v8.5.0 

func NewNodeInfoSettingsTransport() *NodeInfoSettingsTransport

NewNodeInfoSettingsTransport returns a NodeInfoSettingsTransport.

func (*NodeInfoSettingsTransport) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoSettingsTransport) UnmarshalJSON(data []byte) error

type NodeInfoSettingsTransportFeatures 

type NodeInfoSettingsTransportFeatures struct {
	XPack string `json:"x-pack"`
}

NodeInfoSettingsTransportFeatures type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L219-L221

func NewNodeInfoSettingsTransportFeatures added in v8.5.0 

func NewNodeInfoSettingsTransportFeatures() *NodeInfoSettingsTransportFeatures

NewNodeInfoSettingsTransportFeatures returns a NodeInfoSettingsTransportFeatures.

func (*NodeInfoSettingsTransportFeatures) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoSettingsTransportFeatures) UnmarshalJSON(data []byte) error

type NodeInfoSettingsTransportType 

type NodeInfoSettingsTransportType struct {
	Default string `json:"default"`
}

NodeInfoSettingsTransportType type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L214-L217

func NewNodeInfoSettingsTransportType added in v8.5.0 

func NewNodeInfoSettingsTransportType() *NodeInfoSettingsTransportType

NewNodeInfoSettingsTransportType returns a NodeInfoSettingsTransportType.

func (*NodeInfoSettingsTransportType) UnmarshalJSON added in v8.7.1 

func (s *NodeInfoSettingsTransportType) UnmarshalJSON(data []byte) error

type NodeInfoTransport 

type NodeInfoTransport struct {
	BoundAddress   []string          `json:"bound_address"`
	Profiles       map[string]string `json:"profiles"`
	PublishAddress string            `json:"publish_address"`
}

NodeInfoTransport type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L358-L362

func NewNodeInfoTransport added in v8.5.0 

func NewNodeInfoTransport() *NodeInfoTransport

NewNodeInfoTransport returns a NodeInfoTransport.

func (*NodeInfoTransport) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoTransport) UnmarshalJSON(data []byte) error

type NodeInfoXpack 

type NodeInfoXpack struct {
	License      *NodeInfoXpackLicense      `json:"license,omitempty"`
	Ml           *NodeInfoXpackMl           `json:"ml,omitempty"`
	Notification map[string]json.RawMessage `json:"notification,omitempty"`
	Security     NodeInfoXpackSecurity      `json:"security"`
}

NodeInfoXpack type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L239-L244

func NewNodeInfoXpack added in v8.5.0 

func NewNodeInfoXpack() *NodeInfoXpack

NewNodeInfoXpack returns a NodeInfoXpack.

type NodeInfoXpackLicense 

type NodeInfoXpackLicense struct {
	SelfGenerated NodeInfoXpackLicenseType `json:"self_generated"`
}

NodeInfoXpackLicense type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L281-L283

func NewNodeInfoXpackLicense added in v8.5.0 

func NewNodeInfoXpackLicense() *NodeInfoXpackLicense

NewNodeInfoXpackLicense returns a NodeInfoXpackLicense.

type NodeInfoXpackLicenseType 

type NodeInfoXpackLicenseType struct {
	Type string `json:"type"`
}

NodeInfoXpackLicenseType type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L285-L287

func NewNodeInfoXpackLicenseType added in v8.5.0 

func NewNodeInfoXpackLicenseType() *NodeInfoXpackLicenseType

NewNodeInfoXpackLicenseType returns a NodeInfoXpackLicenseType.

func (*NodeInfoXpackLicenseType) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoXpackLicenseType) UnmarshalJSON(data []byte) error

type NodeInfoXpackMl added in v8.16.0 

type NodeInfoXpackMl struct {
	UseAutoMachineMemoryPercent *bool `json:"use_auto_machine_memory_percent,omitempty"`
}

NodeInfoXpackMl type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L253-L255

func NewNodeInfoXpackMl added in v8.16.0 

func NewNodeInfoXpackMl() *NodeInfoXpackMl

NewNodeInfoXpackMl returns a NodeInfoXpackMl.

func (*NodeInfoXpackMl) UnmarshalJSON added in v8.16.0 

func (s *NodeInfoXpackMl) UnmarshalJSON(data []byte) error

type NodeInfoXpackSecurity 

type NodeInfoXpackSecurity struct {
	Authc     *NodeInfoXpackSecurityAuthc `json:"authc,omitempty"`
	Enabled   string                      `json:"enabled"`
	Http      *NodeInfoXpackSecuritySsl   `json:"http,omitempty"`
	Transport *NodeInfoXpackSecuritySsl   `json:"transport,omitempty"`
}

NodeInfoXpackSecurity type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L246-L251

func NewNodeInfoXpackSecurity added in v8.5.0 

func NewNodeInfoXpackSecurity() *NodeInfoXpackSecurity

NewNodeInfoXpackSecurity returns a NodeInfoXpackSecurity.

func (*NodeInfoXpackSecurity) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoXpackSecurity) UnmarshalJSON(data []byte) error

type NodeInfoXpackSecurityAuthc 

type NodeInfoXpackSecurityAuthc struct {
	Realms *NodeInfoXpackSecurityAuthcRealms `json:"realms,omitempty"`
	Token  *NodeInfoXpackSecurityAuthcToken  `json:"token,omitempty"`
}

NodeInfoXpackSecurityAuthc type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L261-L264

func NewNodeInfoXpackSecurityAuthc added in v8.5.0 

func NewNodeInfoXpackSecurityAuthc() *NodeInfoXpackSecurityAuthc

NewNodeInfoXpackSecurityAuthc returns a NodeInfoXpackSecurityAuthc.

type NodeInfoXpackSecurityAuthcRealms 

type NodeInfoXpackSecurityAuthcRealms struct {
	File   map[string]NodeInfoXpackSecurityAuthcRealmsStatus `json:"file,omitempty"`
	Native map[string]NodeInfoXpackSecurityAuthcRealmsStatus `json:"native,omitempty"`
	Pki    map[string]NodeInfoXpackSecurityAuthcRealmsStatus `json:"pki,omitempty"`
}

NodeInfoXpackSecurityAuthcRealms type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L266-L270

func NewNodeInfoXpackSecurityAuthcRealms added in v8.5.0 

func NewNodeInfoXpackSecurityAuthcRealms() *NodeInfoXpackSecurityAuthcRealms

NewNodeInfoXpackSecurityAuthcRealms returns a NodeInfoXpackSecurityAuthcRealms.

type NodeInfoXpackSecurityAuthcRealmsStatus 

type NodeInfoXpackSecurityAuthcRealmsStatus struct {
	Enabled *string `json:"enabled,omitempty"`
	Order   string  `json:"order"`
}

NodeInfoXpackSecurityAuthcRealmsStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L276-L279

func NewNodeInfoXpackSecurityAuthcRealmsStatus added in v8.5.0 

func NewNodeInfoXpackSecurityAuthcRealmsStatus() *NodeInfoXpackSecurityAuthcRealmsStatus

NewNodeInfoXpackSecurityAuthcRealmsStatus returns a NodeInfoXpackSecurityAuthcRealmsStatus.

func (*NodeInfoXpackSecurityAuthcRealmsStatus) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoXpackSecurityAuthcRealmsStatus) UnmarshalJSON(data []byte) error

type NodeInfoXpackSecurityAuthcToken 

type NodeInfoXpackSecurityAuthcToken struct {
	Enabled string `json:"enabled"`
}

NodeInfoXpackSecurityAuthcToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L272-L274

func NewNodeInfoXpackSecurityAuthcToken added in v8.5.0 

func NewNodeInfoXpackSecurityAuthcToken() *NodeInfoXpackSecurityAuthcToken

NewNodeInfoXpackSecurityAuthcToken returns a NodeInfoXpackSecurityAuthcToken.

func (*NodeInfoXpackSecurityAuthcToken) UnmarshalJSON added in v8.9.0 

func (s *NodeInfoXpackSecurityAuthcToken) UnmarshalJSON(data []byte) error

type NodeInfoXpackSecuritySsl 

type NodeInfoXpackSecuritySsl struct {
	Ssl map[string]string `json:"ssl"`
}

NodeInfoXpackSecuritySsl type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L257-L259

func NewNodeInfoXpackSecuritySsl added in v8.5.0 

func NewNodeInfoXpackSecuritySsl() *NodeInfoXpackSecuritySsl

NewNodeInfoXpackSecuritySsl returns a NodeInfoXpackSecuritySsl.

type NodeJvmInfo 

type NodeJvmInfo struct {
	GcCollectors                          []string          `json:"gc_collectors"`
	InputArguments                        []string          `json:"input_arguments"`
	Mem                                   NodeInfoJvmMemory `json:"mem"`
	MemoryPools                           []string          `json:"memory_pools"`
	Pid                                   int               `json:"pid"`
	StartTimeInMillis                     int64             `json:"start_time_in_millis"`
	UsingBundledJdk                       bool              `json:"using_bundled_jdk"`
	UsingCompressedOrdinaryObjectPointers string            `json:"using_compressed_ordinary_object_pointers,omitempty"`
	Version                               string            `json:"version"`
	VmName                                string            `json:"vm_name"`
	VmVendor                              string            `json:"vm_vendor"`
	VmVersion                             string            `json:"vm_version"`
}

NodeJvmInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L364-L378

func NewNodeJvmInfo added in v8.5.0 

func NewNodeJvmInfo() *NodeJvmInfo

NewNodeJvmInfo returns a NodeJvmInfo.

func (*NodeJvmInfo) UnmarshalJSON added in v8.7.1 

func (s *NodeJvmInfo) UnmarshalJSON(data []byte) error

type NodeOperatingSystemInfo 

type NodeOperatingSystemInfo struct {
	// AllocatedProcessors The number of processors actually used to calculate thread pool size. This
	// number can be set with the node.processors setting of a node and defaults to
	// the number of processors reported by the OS.
	AllocatedProcessors *int `json:"allocated_processors,omitempty"`
	// Arch Name of the JVM architecture (ex: amd64, x86)
	Arch string `json:"arch"`
	// AvailableProcessors Number of processors available to the Java virtual machine
	AvailableProcessors int             `json:"available_processors"`
	Cpu                 *NodeInfoOSCPU  `json:"cpu,omitempty"`
	Mem                 *NodeInfoMemory `json:"mem,omitempty"`
	// Name Name of the operating system (ex: Linux, Windows, Mac OS X)
	Name       string `json:"name"`
	PrettyName string `json:"pretty_name"`
	// RefreshIntervalInMillis Refresh interval for the OS statistics
	RefreshIntervalInMillis int64           `json:"refresh_interval_in_millis"`
	Swap                    *NodeInfoMemory `json:"swap,omitempty"`
	// Version Version of the operating system
	Version string `json:"version"`
}

NodeOperatingSystemInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L380-L397

func NewNodeOperatingSystemInfo added in v8.5.0 

func NewNodeOperatingSystemInfo() *NodeOperatingSystemInfo

NewNodeOperatingSystemInfo returns a NodeOperatingSystemInfo.

func (*NodeOperatingSystemInfo) UnmarshalJSON added in v8.7.1 

func (s *NodeOperatingSystemInfo) UnmarshalJSON(data []byte) error

type NodePackagingType 

type NodePackagingType struct {
	// Count Number of selected nodes using the distribution flavor and file type.
	Count int `json:"count"`
	// Flavor Type of Elasticsearch distribution. This is always `default`.
	Flavor string `json:"flavor"`
	// Type File type (such as `tar` or `zip`) used for the distribution package.
	Type string `json:"type"`
}

NodePackagingType type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L526-L539

func NewNodePackagingType added in v8.5.0 

func NewNodePackagingType() *NodePackagingType

NewNodePackagingType returns a NodePackagingType.

func (*NodePackagingType) UnmarshalJSON added in v8.7.1 

func (s *NodePackagingType) UnmarshalJSON(data []byte) error

type NodeProcessInfo 

type NodeProcessInfo struct {
	// Id Process identifier (PID)
	Id int64 `json:"id"`
	// Mlockall Indicates if the process address space has been successfully locked in memory
	Mlockall bool `json:"mlockall"`
	// RefreshIntervalInMillis Refresh interval for the process statistics
	RefreshIntervalInMillis int64 `json:"refresh_interval_in_millis"`
}

NodeProcessInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L399-L406

func NewNodeProcessInfo added in v8.5.0 

func NewNodeProcessInfo() *NodeProcessInfo

NewNodeProcessInfo returns a NodeProcessInfo.

func (*NodeProcessInfo) UnmarshalJSON added in v8.7.1 

func (s *NodeProcessInfo) UnmarshalJSON(data []byte) error

type NodeReloadResult 

type NodeReloadResult struct {
	Name            string      `json:"name"`
	ReloadException *ErrorCause `json:"reload_exception,omitempty"`
}

NodeReloadResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/NodeReloadResult.ts#L23-L26

func NewNodeReloadResult added in v8.18.0 

func NewNodeReloadResult() *NodeReloadResult

NewNodeReloadResult returns a NodeReloadResult.

func (*NodeReloadResult) UnmarshalJSON added in v8.18.0 

func (s *NodeReloadResult) UnmarshalJSON(data []byte) error

type NodeShard 

type NodeShard struct {
	AllocationId          map[string]string                   `json:"allocation_id,omitempty"`
	Index                 string                              `json:"index"`
	Node                  *string                             `json:"node,omitempty"`
	Primary               bool                                `json:"primary"`
	RecoverySource        map[string]string                   `json:"recovery_source,omitempty"`
	RelocatingNode        *string                             `json:"relocating_node,omitempty"`
	RelocationFailureInfo *RelocationFailureInfo              `json:"relocation_failure_info,omitempty"`
	Shard                 int                                 `json:"shard"`
	State                 shardroutingstate.ShardRoutingState `json:"state"`
	UnassignedInfo        *UnassignedInformation              `json:"unassigned_info,omitempty"`
}

NodeShard type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Node.ts#L54-L65

func NewNodeShard added in v8.5.0 

func NewNodeShard() *NodeShard

NewNodeShard returns a NodeShard.

func (*NodeShard) UnmarshalJSON added in v8.7.1 

func (s *NodeShard) UnmarshalJSON(data []byte) error

type NodeShutdownStatus 

type NodeShutdownStatus struct {
	NodeId                string                        `json:"node_id"`
	PersistentTasks       PersistentTaskStatus          `json:"persistent_tasks"`
	Plugins               PluginsStatus                 `json:"plugins"`
	Reason                string                        `json:"reason"`
	ShardMigration        ShardMigrationStatus          `json:"shard_migration"`
	ShutdownStartedmillis int64                         `json:"shutdown_startedmillis"`
	Status                shutdownstatus.ShutdownStatus `json:"status"`
	Type                  shutdowntype.ShutdownType     `json:"type"`
}

NodeShutdownStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L29-L38

func NewNodeShutdownStatus added in v8.5.0 

func NewNodeShutdownStatus() *NodeShutdownStatus

NewNodeShutdownStatus returns a NodeShutdownStatus.

func (*NodeShutdownStatus) UnmarshalJSON added in v8.7.1 

func (s *NodeShutdownStatus) UnmarshalJSON(data []byte) error

type NodeStatistics 

type NodeStatistics struct {
	// Failed Number of nodes that rejected the request or failed to respond. If this value
	// is not 0, a reason for the rejection or failure is included in the response.
	Failed   int          `json:"failed"`
	Failures []ErrorCause `json:"failures,omitempty"`
	// Successful Number of nodes that responded successfully to the request.
	Successful int `json:"successful"`
	// Total Total number of nodes selected by the request.
	Total int `json:"total"`
}

NodeStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Node.ts#L28-L39

func NewNodeStatistics added in v8.5.0 

func NewNodeStatistics() *NodeStatistics

NewNodeStatistics returns a NodeStatistics.

func (*NodeStatistics) UnmarshalJSON added in v8.7.1 

func (s *NodeStatistics) UnmarshalJSON(data []byte) error

type NodeTasks 

type NodeTasks struct {
	Attributes       map[string]string   `json:"attributes,omitempty"`
	Host             *string             `json:"host,omitempty"`
	Ip               *string             `json:"ip,omitempty"`
	Name             *string             `json:"name,omitempty"`
	Roles            []string            `json:"roles,omitempty"`
	Tasks            map[string]TaskInfo `json:"tasks"`
	TransportAddress *string             `json:"transport_address,omitempty"`
}

NodeTasks type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/tasks/_types/TaskListResponseBase.ts#L49-L57

func NewNodeTasks added in v8.5.0 

func NewNodeTasks() *NodeTasks

NewNodeTasks returns a NodeTasks.

func (*NodeTasks) UnmarshalJSON added in v8.7.1 

func (s *NodeTasks) UnmarshalJSON(data []byte) error

type NodeThreadPoolInfo 

type NodeThreadPoolInfo struct {
	Core      *int     `json:"core,omitempty"`
	KeepAlive Duration `json:"keep_alive,omitempty"`
	Max       *int     `json:"max,omitempty"`
	QueueSize int      `json:"queue_size"`
	Size      *int     `json:"size,omitempty"`
	Type      string   `json:"type"`
}

NodeThreadPoolInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/info/types.ts#L302-L309

func NewNodeThreadPoolInfo added in v8.5.0 

func NewNodeThreadPoolInfo() *NodeThreadPoolInfo

NewNodeThreadPoolInfo returns a NodeThreadPoolInfo.

func (*NodeThreadPoolInfo) UnmarshalJSON added in v8.7.1 

func (s *NodeThreadPoolInfo) UnmarshalJSON(data []byte) error

type NodeUsage 

type NodeUsage struct {
	Aggregations map[string]json.RawMessage `json:"aggregations"`
	RestActions  map[string]int             `json:"rest_actions"`
	Since        int64                      `json:"since"`
	Timestamp    int64                      `json:"timestamp"`
}

NodeUsage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/usage/types.ts#L25-L30

func NewNodeUsage added in v8.5.0 

func NewNodeUsage() *NodeUsage

NewNodeUsage returns a NodeUsage.

func (*NodeUsage) UnmarshalJSON added in v8.7.1 

func (s *NodeUsage) UnmarshalJSON(data []byte) error

type NodesContext added in v8.5.0 

type NodesContext struct {
	CacheEvictions            *int64  `json:"cache_evictions,omitempty"`
	CompilationLimitTriggered *int64  `json:"compilation_limit_triggered,omitempty"`
	Compilations              *int64  `json:"compilations,omitempty"`
	Context                   *string `json:"context,omitempty"`
}

NodesContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1068-L1073

func NewNodesContext added in v8.5.0 

func NewNodesContext() *NodesContext

NewNodesContext returns a NodesContext.

func (*NodesContext) UnmarshalJSON added in v8.7.1 

func (s *NodesContext) UnmarshalJSON(data []byte) error

type NodesCredentials 

type NodesCredentials struct {
	// FileTokens File-backed tokens collected from all nodes
	FileTokens map[string]NodesCredentialsFileToken `json:"file_tokens"`
	// NodeStats General status showing how nodes respond to the above collection request
	NodeStats NodeStatistics `json:"_nodes"`
}

NodesCredentials type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_service_credentials/types.ts#L23-L28

func NewNodesCredentials added in v8.5.0 

func NewNodesCredentials() *NodesCredentials

NewNodesCredentials returns a NodesCredentials.

type NodesCredentialsFileToken 

type NodesCredentialsFileToken struct {
	Nodes []string `json:"nodes"`
}

NodesCredentialsFileToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_service_credentials/types.ts#L30-L32

func NewNodesCredentialsFileToken added in v8.5.0 

func NewNodesCredentialsFileToken() *NodesCredentialsFileToken

NewNodesCredentialsFileToken returns a NodesCredentialsFileToken.

type NodesIndexingPressure added in v8.5.0 

type NodesIndexingPressure struct {
	// Memory Contains statistics for memory consumption from indexing load.
	Memory *NodesIndexingPressureMemory `json:"memory,omitempty"`
}

NodesIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L116-L121

func NewNodesIndexingPressure added in v8.5.0 

func NewNodesIndexingPressure() *NodesIndexingPressure

NewNodesIndexingPressure returns a NodesIndexingPressure.

type NodesIndexingPressureMemory added in v8.5.0 

type NodesIndexingPressureMemory struct {
	// Current Contains statistics for current indexing load.
	Current *PressureMemory `json:"current,omitempty"`
	// Limit Configured memory limit for the indexing requests.
	// Replica requests have an automatic limit that is 1.5x this value.
	Limit ByteSize `json:"limit,omitempty"`
	// LimitInBytes Configured memory limit, in bytes, for the indexing requests.
	// Replica requests have an automatic limit that is 1.5x this value.
	LimitInBytes *int64 `json:"limit_in_bytes,omitempty"`
	// Total Contains statistics for the cumulative indexing load since the node started.
	Total *PressureMemory `json:"total,omitempty"`
}

NodesIndexingPressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L123-L142

func NewNodesIndexingPressureMemory added in v8.5.0 

func NewNodesIndexingPressureMemory() *NodesIndexingPressureMemory

NewNodesIndexingPressureMemory returns a NodesIndexingPressureMemory.

func (*NodesIndexingPressureMemory) UnmarshalJSON added in v8.7.1 

func (s *NodesIndexingPressureMemory) UnmarshalJSON(data []byte) error

type NodesIngest added in v8.5.0 

type NodesIngest struct {
	// Pipelines Contains statistics about ingest pipelines for the node.
	Pipelines map[string]IngestStats `json:"pipelines,omitempty"`
	// Total Contains statistics about ingest operations for the node.
	Total *IngestTotal `json:"total,omitempty"`
}

NodesIngest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L345-L354

func NewNodesIngest added in v8.5.0 

func NewNodesIngest() *NodesIngest

NewNodesIngest returns a NodesIngest.

type NodesRecord 

type NodesRecord struct {
	// Build The Elasticsearch build hash.
	Build *string `json:"build,omitempty"`
	// BulkAvgSizeInBytes The average size in bytes of shard bulk.
	BulkAvgSizeInBytes *string `json:"bulk.avg_size_in_bytes,omitempty"`
	// BulkAvgTime The average time spend in shard bulk.
	BulkAvgTime *string `json:"bulk.avg_time,omitempty"`
	// BulkTotalOperations The number of bulk shard operations.
	BulkTotalOperations *string `json:"bulk.total_operations,omitempty"`
	// BulkTotalSizeInBytes The total size in bytes of shard bulk.
	BulkTotalSizeInBytes *string `json:"bulk.total_size_in_bytes,omitempty"`
	// BulkTotalTime The time spend in shard bulk.
	BulkTotalTime *string `json:"bulk.total_time,omitempty"`
	// CompletionSize The size of completion.
	CompletionSize *string `json:"completion.size,omitempty"`
	// Cpu The recent system CPU usage as a percentage.
	Cpu *string `json:"cpu,omitempty"`
	// DiskAvail The available disk space.
	DiskAvail ByteSize `json:"disk.avail,omitempty"`
	// DiskTotal The total disk space.
	DiskTotal ByteSize `json:"disk.total,omitempty"`
	// DiskUsed The used disk space.
	DiskUsed ByteSize `json:"disk.used,omitempty"`
	// DiskUsedPercent The used disk space percentage.
	DiskUsedPercent Percentage `json:"disk.used_percent,omitempty"`
	// FielddataEvictions The fielddata evictions.
	FielddataEvictions *string `json:"fielddata.evictions,omitempty"`
	// FielddataMemorySize The used fielddata cache.
	FielddataMemorySize *string `json:"fielddata.memory_size,omitempty"`
	// FileDescCurrent The used file descriptors.
	FileDescCurrent *string `json:"file_desc.current,omitempty"`
	// FileDescMax The maximum number of file descriptors.
	FileDescMax *string `json:"file_desc.max,omitempty"`
	// FileDescPercent The used file descriptor ratio.
	FileDescPercent Percentage `json:"file_desc.percent,omitempty"`
	// Flavor The Elasticsearch distribution flavor.
	Flavor *string `json:"flavor,omitempty"`
	// FlushTotal The number of flushes.
	FlushTotal *string `json:"flush.total,omitempty"`
	// FlushTotalTime The time spent in flush.
	FlushTotalTime *string `json:"flush.total_time,omitempty"`
	// GetCurrent The number of current get ops.
	GetCurrent *string `json:"get.current,omitempty"`
	// GetExistsTime The time spent in successful gets.
	GetExistsTime *string `json:"get.exists_time,omitempty"`
	// GetExistsTotal The number of successful get operations.
	GetExistsTotal *string `json:"get.exists_total,omitempty"`
	// GetMissingTime The time spent in failed gets.
	GetMissingTime *string `json:"get.missing_time,omitempty"`
	// GetMissingTotal The number of failed gets.
	GetMissingTotal *string `json:"get.missing_total,omitempty"`
	// GetTime The time spent in get.
	GetTime *string `json:"get.time,omitempty"`
	// GetTotal The number of get ops.
	GetTotal *string `json:"get.total,omitempty"`
	// HeapCurrent The used heap.
	HeapCurrent *string `json:"heap.current,omitempty"`
	// HeapMax The maximum configured heap.
	HeapMax *string `json:"heap.max,omitempty"`
	// HeapPercent The used heap ratio.
	HeapPercent Percentage `json:"heap.percent,omitempty"`
	// HttpAddress The bound HTTP address.
	HttpAddress *string `json:"http_address,omitempty"`
	// Id The unique node identifier.
	Id *string `json:"id,omitempty"`
	// IndexingDeleteCurrent The number of current deletions.
	IndexingDeleteCurrent *string `json:"indexing.delete_current,omitempty"`
	// IndexingDeleteTime The time spent in deletions.
	IndexingDeleteTime *string `json:"indexing.delete_time,omitempty"`
	// IndexingDeleteTotal The number of delete operations.
	IndexingDeleteTotal *string `json:"indexing.delete_total,omitempty"`
	// IndexingIndexCurrent The number of current indexing operations.
	IndexingIndexCurrent *string `json:"indexing.index_current,omitempty"`
	// IndexingIndexFailed The number of failed indexing operations.
	IndexingIndexFailed *string `json:"indexing.index_failed,omitempty"`
	// IndexingIndexTime The time spent in indexing.
	IndexingIndexTime *string `json:"indexing.index_time,omitempty"`
	// IndexingIndexTotal The number of indexing operations.
	IndexingIndexTotal *string `json:"indexing.index_total,omitempty"`
	// Ip The IP address.
	Ip *string `json:"ip,omitempty"`
	// Jdk The Java version.
	Jdk *string `json:"jdk,omitempty"`
	// Load15M The load average for the last fifteen minutes.
	Load15M *string `json:"load_15m,omitempty"`
	// Load1M The load average for the most recent minute.
	Load1M *string `json:"load_1m,omitempty"`
	// Load5M The load average for the last five minutes.
	Load5M *string `json:"load_5m,omitempty"`
	// Master Indicates whether the node is the elected master node.
	// Returned values include `*`(elected master) and `-`(not elected master).
	Master *string `json:"master,omitempty"`
	// MergesCurrent The number of current merges.
	MergesCurrent *string `json:"merges.current,omitempty"`
	// MergesCurrentDocs The number of current merging docs.
	MergesCurrentDocs *string `json:"merges.current_docs,omitempty"`
	// MergesCurrentSize The size of current merges.
	MergesCurrentSize *string `json:"merges.current_size,omitempty"`
	// MergesTotal The number of completed merge operations.
	MergesTotal *string `json:"merges.total,omitempty"`
	// MergesTotalDocs The docs merged.
	MergesTotalDocs *string `json:"merges.total_docs,omitempty"`
	// MergesTotalSize The size merged.
	MergesTotalSize *string `json:"merges.total_size,omitempty"`
	// MergesTotalTime The time spent in merges.
	MergesTotalTime *string `json:"merges.total_time,omitempty"`
	// Name The node name.
	Name *string `json:"name,omitempty"`
	// NodeRole The roles of the node.
	// Returned values include `c`(cold node), `d`(data node), `f`(frozen node),
	// `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master
	// eligible node), `r`(remote cluster client node), `s`(content node),
	// `t`(transform node), `v`(voting-only node), `w`(warm node),and
	// `-`(coordinating node only).
	NodeRole *string `json:"node.role,omitempty"`
	// Pid The process identifier.
	Pid *string `json:"pid,omitempty"`
	// Port The bound transport port.
	Port *string `json:"port,omitempty"`
	// QueryCacheEvictions The query cache evictions.
	QueryCacheEvictions *string `json:"query_cache.evictions,omitempty"`
	// QueryCacheHitCount The query cache hit counts.
	QueryCacheHitCount *string `json:"query_cache.hit_count,omitempty"`
	// QueryCacheMemorySize The used query cache.
	QueryCacheMemorySize *string `json:"query_cache.memory_size,omitempty"`
	// QueryCacheMissCount The query cache miss counts.
	QueryCacheMissCount *string `json:"query_cache.miss_count,omitempty"`
	// RamCurrent The used machine memory.
	RamCurrent *string `json:"ram.current,omitempty"`
	// RamMax The total machine memory.
	RamMax *string `json:"ram.max,omitempty"`
	// RamPercent The used machine memory ratio.
	RamPercent Percentage `json:"ram.percent,omitempty"`
	// RefreshExternalTime The time spent in external refreshes.
	RefreshExternalTime *string `json:"refresh.external_time,omitempty"`
	// RefreshExternalTotal The total external refreshes.
	RefreshExternalTotal *string `json:"refresh.external_total,omitempty"`
	// RefreshListeners The number of pending refresh listeners.
	RefreshListeners *string `json:"refresh.listeners,omitempty"`
	// RefreshTime The time spent in refreshes.
	RefreshTime *string `json:"refresh.time,omitempty"`
	// RefreshTotal The total refreshes.
	RefreshTotal *string `json:"refresh.total,omitempty"`
	// RequestCacheEvictions The request cache evictions.
	RequestCacheEvictions *string `json:"request_cache.evictions,omitempty"`
	// RequestCacheHitCount The request cache hit counts.
	RequestCacheHitCount *string `json:"request_cache.hit_count,omitempty"`
	// RequestCacheMemorySize The used request cache.
	RequestCacheMemorySize *string `json:"request_cache.memory_size,omitempty"`
	// RequestCacheMissCount The request cache miss counts.
	RequestCacheMissCount *string `json:"request_cache.miss_count,omitempty"`
	// ScriptCacheEvictions The total compiled scripts evicted from the cache.
	ScriptCacheEvictions *string `json:"script.cache_evictions,omitempty"`
	// ScriptCompilationLimitTriggered The script cache compilation limit triggered.
	ScriptCompilationLimitTriggered *string `json:"script.compilation_limit_triggered,omitempty"`
	// ScriptCompilations The total script compilations.
	ScriptCompilations *string `json:"script.compilations,omitempty"`
	// SearchFetchCurrent The current fetch phase operations.
	SearchFetchCurrent *string `json:"search.fetch_current,omitempty"`
	// SearchFetchTime The time spent in fetch phase.
	SearchFetchTime *string `json:"search.fetch_time,omitempty"`
	// SearchFetchTotal The total fetch operations.
	SearchFetchTotal *string `json:"search.fetch_total,omitempty"`
	// SearchOpenContexts The open search contexts.
	SearchOpenContexts *string `json:"search.open_contexts,omitempty"`
	// SearchQueryCurrent The current query phase operations.
	SearchQueryCurrent *string `json:"search.query_current,omitempty"`
	// SearchQueryTime The time spent in query phase.
	SearchQueryTime *string `json:"search.query_time,omitempty"`
	// SearchQueryTotal The total query phase operations.
	SearchQueryTotal *string `json:"search.query_total,omitempty"`
	// SearchScrollCurrent The open scroll contexts.
	SearchScrollCurrent *string `json:"search.scroll_current,omitempty"`
	// SearchScrollTime The time scroll contexts held open.
	SearchScrollTime *string `json:"search.scroll_time,omitempty"`
	// SearchScrollTotal The completed scroll contexts.
	SearchScrollTotal *string `json:"search.scroll_total,omitempty"`
	// SegmentsCount The number of segments.
	SegmentsCount *string `json:"segments.count,omitempty"`
	// SegmentsFixedBitsetMemory The memory used by fixed bit sets for nested object field types and export
	// type filters for types referred in _parent fields.
	SegmentsFixedBitsetMemory *string `json:"segments.fixed_bitset_memory,omitempty"`
	// SegmentsIndexWriterMemory The memory used by the index writer.
	SegmentsIndexWriterMemory *string `json:"segments.index_writer_memory,omitempty"`
	// SegmentsMemory The memory used by segments.
	SegmentsMemory *string `json:"segments.memory,omitempty"`
	// SegmentsVersionMapMemory The memory used by the version map.
	SegmentsVersionMapMemory *string `json:"segments.version_map_memory,omitempty"`
	// SuggestCurrent The number of current suggest operations.
	SuggestCurrent *string `json:"suggest.current,omitempty"`
	// SuggestTime The time spend in suggest.
	SuggestTime *string `json:"suggest.time,omitempty"`
	// SuggestTotal The number of suggest operations.
	SuggestTotal *string `json:"suggest.total,omitempty"`
	// Type The Elasticsearch distribution type.
	Type *string `json:"type,omitempty"`
	// Uptime The node uptime.
	Uptime *string `json:"uptime,omitempty"`
	// Version The Elasticsearch version.
	Version *string `json:"version,omitempty"`
}

NodesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/nodes/types.ts#L23-L542

func NewNodesRecord added in v8.5.0 

func NewNodesRecord() *NodesRecord

NewNodesRecord returns a NodesRecord.

func (*NodesRecord) UnmarshalJSON added in v8.7.1 

func (s *NodesRecord) UnmarshalJSON(data []byte) error

type NoriAnalyzer 

type NoriAnalyzer struct {
	DecompoundMode *noridecompoundmode.NoriDecompoundMode `json:"decompound_mode,omitempty"`
	Stoptags       []string                               `json:"stoptags,omitempty"`
	Type           string                                 `json:"type,omitempty"`
	UserDictionary *string                                `json:"user_dictionary,omitempty"`
	Version        *string                                `json:"version,omitempty"`
}

NoriAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L303-L309

func NewNoriAnalyzer added in v8.5.0 

func NewNoriAnalyzer() *NoriAnalyzer

NewNoriAnalyzer returns a NoriAnalyzer.

func (NoriAnalyzer) MarshalJSON added in v8.9.0 

func (s NoriAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NoriAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *NoriAnalyzer) UnmarshalJSON(data []byte) error

type NoriPartOfSpeechTokenFilter 

type NoriPartOfSpeechTokenFilter struct {
	// Stoptags An array of part-of-speech tags that should be removed.
	Stoptags []string `json:"stoptags,omitempty"`
	Type     string   `json:"type,omitempty"`
	Version  *string  `json:"version,omitempty"`
}

NoriPartOfSpeechTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/nori-plugin.ts#L37-L41

func NewNoriPartOfSpeechTokenFilter added in v8.5.0 

func NewNoriPartOfSpeechTokenFilter() *NoriPartOfSpeechTokenFilter

NewNoriPartOfSpeechTokenFilter returns a NoriPartOfSpeechTokenFilter.

func (NoriPartOfSpeechTokenFilter) MarshalJSON added in v8.9.0 

func (s NoriPartOfSpeechTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NoriPartOfSpeechTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *NoriPartOfSpeechTokenFilter) UnmarshalJSON(data []byte) error

type NoriTokenizer 

type NoriTokenizer struct {
	DecompoundMode      *noridecompoundmode.NoriDecompoundMode `json:"decompound_mode,omitempty"`
	DiscardPunctuation  *bool                                  `json:"discard_punctuation,omitempty"`
	Type                string                                 `json:"type,omitempty"`
	UserDictionary      *string                                `json:"user_dictionary,omitempty"`
	UserDictionaryRules []string                               `json:"user_dictionary_rules,omitempty"`
	Version             *string                                `json:"version,omitempty"`
}

NoriTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/nori-plugin.ts#L29-L35

func NewNoriTokenizer added in v8.5.0 

func NewNoriTokenizer() *NoriTokenizer

NewNoriTokenizer returns a NoriTokenizer.

func (NoriTokenizer) MarshalJSON added in v8.9.0 

func (s NoriTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NoriTokenizer) UnmarshalJSON added in v8.7.1 

func (s *NoriTokenizer) UnmarshalJSON(data []byte) error

type NormalizeAggregation 

type NormalizeAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Method The specific method to apply.
	Method *normalizemethod.NormalizeMethod `json:"method,omitempty"`
}

NormalizeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L351-L359

func NewNormalizeAggregation added in v8.5.0 

func NewNormalizeAggregation() *NormalizeAggregation

NewNormalizeAggregation returns a NormalizeAggregation.

func (*NormalizeAggregation) UnmarshalJSON added in v8.7.0 

func (s *NormalizeAggregation) UnmarshalJSON(data []byte) error

type Normalizer 

type Normalizer any

Normalizer holds the union for the following types: 

LowercaseNormalizer
CustomNormalizer

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/normalizers.ts#L20-L24

type NorwegianAnalyzer added in v8.16.0 

type NorwegianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

NorwegianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L228-L233

func NewNorwegianAnalyzer added in v8.16.0 

func NewNorwegianAnalyzer() *NorwegianAnalyzer

NewNorwegianAnalyzer returns a NorwegianAnalyzer.

func (NorwegianAnalyzer) MarshalJSON added in v8.16.0 

func (s NorwegianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*NorwegianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *NorwegianAnalyzer) UnmarshalJSON(data []byte) error

type NullValue added in v8.14.0 

type NullValue struct{}

NullValue is a custom type used to represent the concept of a null or missing value. It can be used as a placeholder for variables or fields that are not initialized, or to indicate that a specific piece of data is intentionally absent.

func (NullValue) MarshalJSON added in v8.14.0 

func (n NullValue) MarshalJSON() ([]byte, error)

MarshalJSON converts the NullValue to JSON format. It always returns a "null" value as per JSON standard for null values.

type NumberRangeQuery 

type NumberRangeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	From  *Float64 `json:"from,omitempty"`
	// Gt Greater than.
	Gt *Float64 `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *Float64 `json:"gte,omitempty"`
	// Lt Less than.
	Lt *Float64 `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *Float64 `json:"lte,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	To       *Float64                     `json:"to,omitempty"`
}

NumberRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L172-L172

func NewNumberRangeQuery added in v8.5.0 

func NewNumberRangeQuery() *NumberRangeQuery

NewNumberRangeQuery returns a NumberRangeQuery.

func (*NumberRangeQuery) UnmarshalJSON added in v8.7.1 

func (s *NumberRangeQuery) UnmarshalJSON(data []byte) error

type NumericDecayFunction 

type NumericDecayFunction struct {
	DecayFunctionBasedoubledouble map[string]DecayPlacementdoubledouble `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

NumericDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L208-L208

func NewNumericDecayFunction added in v8.5.0 

func NewNumericDecayFunction() *NumericDecayFunction

NewNumericDecayFunction returns a NumericDecayFunction.

func (NumericDecayFunction) MarshalJSON 

func (s NumericDecayFunction) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type NumericFielddata 

type NumericFielddata struct {
	Format numericfielddataformat.NumericFielddataFormat `json:"format"`
}

NumericFielddata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/NumericFielddata.ts#L22-L24

func NewNumericFielddata added in v8.5.0 

func NewNumericFielddata() *NumericFielddata

NewNumericFielddata returns a NumericFielddata.

type ObjectProperty 

type ObjectProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Enabled     *bool                          `json:"enabled,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	Subobjects          *subobjects.Subobjects                           `json:"subobjects,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

ObjectProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/complex.ts#L46-L50

func NewObjectProperty added in v8.5.0 

func NewObjectProperty() *ObjectProperty

NewObjectProperty returns a ObjectProperty.

func (ObjectProperty) MarshalJSON added in v8.9.0 

func (s ObjectProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ObjectProperty) UnmarshalJSON added in v8.7.0 

func (s *ObjectProperty) UnmarshalJSON(data []byte) error

type OneHotEncodingPreprocessor 

type OneHotEncodingPreprocessor struct {
	Field  string            `json:"field"`
	HotMap map[string]string `json:"hot_map"`
}

OneHotEncodingPreprocessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L44-L47

func NewOneHotEncodingPreprocessor added in v8.5.0 

func NewOneHotEncodingPreprocessor() *OneHotEncodingPreprocessor

NewOneHotEncodingPreprocessor returns a OneHotEncodingPreprocessor.

func (*OneHotEncodingPreprocessor) UnmarshalJSON added in v8.9.0 

func (s *OneHotEncodingPreprocessor) UnmarshalJSON(data []byte) error

type OpenAIServiceSettings added in v8.18.0 

type OpenAIServiceSettings struct {
	// ApiKey A valid API key of your OpenAI account.
	// You can find your OpenAI API keys in your OpenAI account under the API keys
	// section.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// Dimensions The number of dimensions the resulting output embeddings should have.
	// It is supported only in `text-embedding-3` and later models.
	// If it is not set, the OpenAI defined default for the model is used.
	Dimensions *int `json:"dimensions,omitempty"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the OpenAI documentation for the list of available text embedding
	// models.
	ModelId string `json:"model_id"`
	// OrganizationId The unique identifier for your organization.
	// You can find the Organization ID in your OpenAI account under *Settings >
	// Organizations*.
	OrganizationId *string `json:"organization_id,omitempty"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// OpenAI.
	// The `openai` service sets a default number of requests allowed per minute
	// depending on the task type.
	// For `text_embedding`, it is set to `3000`.
	// For `completion`, it is set to `500`.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Url The URL endpoint to use for the requests.
	// It can be changed for testing purposes.
	Url *string `json:"url,omitempty"`
}

OpenAIServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1086-L1128

func NewOpenAIServiceSettings added in v8.18.0 

func NewOpenAIServiceSettings() *OpenAIServiceSettings

NewOpenAIServiceSettings returns a OpenAIServiceSettings.

func (*OpenAIServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *OpenAIServiceSettings) UnmarshalJSON(data []byte) error

type OpenAITaskSettings added in v8.18.0 

type OpenAITaskSettings struct {
	// User For a `completion` or `text_embedding` task, specify the user issuing the
	// request.
	// This information can be used for abuse detection.
	User *string `json:"user,omitempty"`
}

OpenAITaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1130-L1136

func NewOpenAITaskSettings added in v8.18.0 

func NewOpenAITaskSettings() *OpenAITaskSettings

NewOpenAITaskSettings returns a OpenAITaskSettings.

func (*OpenAITaskSettings) UnmarshalJSON added in v8.18.0 

func (s *OpenAITaskSettings) UnmarshalJSON(data []byte) error

type OperatingSystem 

type OperatingSystem struct {
	Cgroup    *Cgroup              `json:"cgroup,omitempty"`
	Cpu       *Cpu                 `json:"cpu,omitempty"`
	Mem       *ExtendedMemoryStats `json:"mem,omitempty"`
	Swap      *MemoryStats         `json:"swap,omitempty"`
	Timestamp *int64               `json:"timestamp,omitempty"`
}

OperatingSystem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1016-L1022

func NewOperatingSystem added in v8.5.0 

func NewOperatingSystem() *OperatingSystem

NewOperatingSystem returns a OperatingSystem.

func (*OperatingSystem) UnmarshalJSON added in v8.7.1 

func (s *OperatingSystem) UnmarshalJSON(data []byte) error

type OperatingSystemMemoryInfo 

type OperatingSystemMemoryInfo struct {
	// AdjustedTotalInBytes Total amount, in bytes, of memory across all selected nodes, but using the
	// value specified using the `es.total_memory_bytes` system property instead of
	// measured total memory for those nodes where that system property was set.
	AdjustedTotalInBytes *int64 `json:"adjusted_total_in_bytes,omitempty"`
	// FreeInBytes Amount, in bytes, of free physical memory across all selected nodes.
	FreeInBytes int64 `json:"free_in_bytes"`
	// FreePercent Percentage of free physical memory across all selected nodes.
	FreePercent int `json:"free_percent"`
	// TotalInBytes Total amount, in bytes, of physical memory across all selected nodes.
	TotalInBytes int64 `json:"total_in_bytes"`
	// UsedInBytes Amount, in bytes, of physical memory in use across all selected nodes.
	UsedInBytes int64 `json:"used_in_bytes"`
	// UsedPercent Percentage of physical memory in use across all selected nodes.
	UsedPercent int `json:"used_percent"`
}

OperatingSystemMemoryInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L541-L568

func NewOperatingSystemMemoryInfo added in v8.5.0 

func NewOperatingSystemMemoryInfo() *OperatingSystemMemoryInfo

NewOperatingSystemMemoryInfo returns a OperatingSystemMemoryInfo.

func (*OperatingSystemMemoryInfo) UnmarshalJSON added in v8.7.1 

func (s *OperatingSystemMemoryInfo) UnmarshalJSON(data []byte) error

type OperationContainer added in v8.9.0 

type OperationContainer struct {
	// Create Index the specified document if it does not already exist.
	// The following line must contain the source data to be indexed.
	Create *CreateOperation `json:"create,omitempty"`
	// Delete Remove the specified document from the index.
	Delete *DeleteOperation `json:"delete,omitempty"`
	// Index Index the specified document.
	// If the document exists, it replaces the document and increments the version.
	// The following line must contain the source data to be indexed.
	Index *IndexOperation `json:"index,omitempty"`
	// Update Perform a partial document update.
	// The following line must contain the partial document and update options.
	Update *UpdateOperation `json:"update,omitempty"`
}

OperationContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L158-L180

func NewOperationContainer added in v8.9.0 

func NewOperationContainer() *OperationContainer

NewOperationContainer returns a OperationContainer.

type OutlierDetectionParameters 

type OutlierDetectionParameters struct {
	// ComputeFeatureInfluence Specifies whether the feature influence calculation is enabled.
	ComputeFeatureInfluence *bool `json:"compute_feature_influence,omitempty"`
	// FeatureInfluenceThreshold The minimum outlier score that a document needs to have in order to calculate
	// its feature influence score.
	// Value range: 0-1
	FeatureInfluenceThreshold *Float64 `json:"feature_influence_threshold,omitempty"`
	// Method The method that outlier detection uses.
	// Available methods are `lof`, `ldof`, `distance_kth_nn`, `distance_knn`, and
	// `ensemble`.
	// The default value is ensemble, which means that outlier detection uses an
	// ensemble of different methods and normalises and combines their individual
	// outlier scores to obtain the overall outlier score.
	Method *string `json:"method,omitempty"`
	// NNeighbors Defines the value for how many nearest neighbors each method of outlier
	// detection uses to calculate its outlier score.
	// When the value is not set, different values are used for different ensemble
	// members.
	// This default behavior helps improve the diversity in the ensemble; only
	// override it if you are confident that the value you choose is appropriate for
	// the data set.
	NNeighbors *int `json:"n_neighbors,omitempty"`
	// OutlierFraction The proportion of the data set that is assumed to be outlying prior to
	// outlier detection.
	// For example, 0.05 means it is assumed that 5% of values are real outliers and
	// 95% are inliers.
	OutlierFraction *Float64 `json:"outlier_fraction,omitempty"`
	// StandardizationEnabled If `true`, the following operation is performed on the columns before
	// computing outlier scores: (x_i - mean(x_i)) / sd(x_i).
	StandardizationEnabled *bool `json:"standardization_enabled,omitempty"`
}

OutlierDetectionParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L528-L562

func NewOutlierDetectionParameters added in v8.5.0 

func NewOutlierDetectionParameters() *OutlierDetectionParameters

NewOutlierDetectionParameters returns a OutlierDetectionParameters.

func (*OutlierDetectionParameters) UnmarshalJSON added in v8.7.1 

func (s *OutlierDetectionParameters) UnmarshalJSON(data []byte) error

type OverallBucket 

type OverallBucket struct {
	// BucketSpan The length of the bucket in seconds. Matches the job with the longest
	// bucket_span value.
	BucketSpan int64 `json:"bucket_span"`
	// IsInterim If true, this is an interim result. In other words, the results are
	// calculated based on partial input data.
	IsInterim bool `json:"is_interim"`
	// Jobs An array of objects that contain the max_anomaly_score per job_id.
	Jobs []OverallBucketJob `json:"jobs"`
	// OverallScore The top_n average of the maximum bucket anomaly_score per job.
	OverallScore Float64 `json:"overall_score"`
	// ResultType Internal. This is always set to overall_bucket.
	ResultType string `json:"result_type"`
	// Timestamp The start time of the bucket for which these results were calculated.
	Timestamp int64 `json:"timestamp"`
	// TimestampString The start time of the bucket for which these results were calculated.
	TimestampString DateTime `json:"timestamp_string,omitempty"`
}

OverallBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Bucket.ts#L129-L144

func NewOverallBucket added in v8.5.0 

func NewOverallBucket() *OverallBucket

NewOverallBucket returns a OverallBucket.

func (*OverallBucket) UnmarshalJSON added in v8.7.1 

func (s *OverallBucket) UnmarshalJSON(data []byte) error

type OverallBucketJob 

type OverallBucketJob struct {
	JobId           string  `json:"job_id"`
	MaxAnomalyScore Float64 `json:"max_anomaly_score"`
}

OverallBucketJob type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Bucket.ts#L145-L148

func NewOverallBucketJob added in v8.5.0 

func NewOverallBucketJob() *OverallBucketJob

NewOverallBucketJob returns a OverallBucketJob.

func (*OverallBucketJob) UnmarshalJSON added in v8.7.1 

func (s *OverallBucketJob) UnmarshalJSON(data []byte) error

type Overlapping 

type Overlapping struct {
	IndexPatterns []string `json:"index_patterns"`
	Name          string   `json:"name"`
}

Overlapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts#L39-L42

func NewOverlapping added in v8.5.0 

func NewOverlapping() *Overlapping

NewOverlapping returns a Overlapping.

func (*Overlapping) UnmarshalJSON added in v8.7.1 

func (s *Overlapping) UnmarshalJSON(data []byte) error

type Page 

type Page struct {
	// From Skips the specified number of items.
	From *int `json:"from,omitempty"`
	// Size Specifies the maximum number of items to obtain.
	Size *int `json:"size,omitempty"`
}

Page type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Page.ts#L22-L33

func NewPage added in v8.5.0 

func NewPage() *Page

NewPage returns a Page.

func (*Page) UnmarshalJSON added in v8.7.1 

func (s *Page) UnmarshalJSON(data []byte) error

type PagerDutyAction 

type PagerDutyAction struct {
	Account       *string                                `json:"account,omitempty"`
	AttachPayload bool                                   `json:"attach_payload"`
	Client        *string                                `json:"client,omitempty"`
	ClientUrl     *string                                `json:"client_url,omitempty"`
	Contexts      []PagerDutyContext                     `json:"contexts,omitempty"`
	Description   string                                 `json:"description"`
	EventType     *pagerdutyeventtype.PagerDutyEventType `json:"event_type,omitempty"`
	IncidentKey   string                                 `json:"incident_key"`
	Proxy         *PagerDutyEventProxy                   `json:"proxy,omitempty"`
}

PagerDutyAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L54-L54

func NewPagerDutyAction added in v8.5.0 

func NewPagerDutyAction() *PagerDutyAction

NewPagerDutyAction returns a PagerDutyAction.

func (*PagerDutyAction) UnmarshalJSON added in v8.7.1 

func (s *PagerDutyAction) UnmarshalJSON(data []byte) error

type PagerDutyContext 

type PagerDutyContext struct {
	Href *string                                   `json:"href,omitempty"`
	Src  *string                                   `json:"src,omitempty"`
	Type pagerdutycontexttype.PagerDutyContextType `json:"type"`
}

PagerDutyContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L61-L65

func NewPagerDutyContext added in v8.5.0 

func NewPagerDutyContext() *PagerDutyContext

NewPagerDutyContext returns a PagerDutyContext.

func (*PagerDutyContext) UnmarshalJSON added in v8.9.0 

func (s *PagerDutyContext) UnmarshalJSON(data []byte) error

type PagerDutyEvent 

type PagerDutyEvent struct {
	Account       *string                                `json:"account,omitempty"`
	AttachPayload bool                                   `json:"attach_payload"`
	Client        *string                                `json:"client,omitempty"`
	ClientUrl     *string                                `json:"client_url,omitempty"`
	Contexts      []PagerDutyContext                     `json:"contexts,omitempty"`
	Description   string                                 `json:"description"`
	EventType     *pagerdutyeventtype.PagerDutyEventType `json:"event_type,omitempty"`
	IncidentKey   string                                 `json:"incident_key"`
	Proxy         *PagerDutyEventProxy                   `json:"proxy,omitempty"`
}

PagerDutyEvent type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L40-L52

func NewPagerDutyEvent added in v8.5.0 

func NewPagerDutyEvent() *PagerDutyEvent

NewPagerDutyEvent returns a PagerDutyEvent.

func (*PagerDutyEvent) UnmarshalJSON added in v8.7.1 

func (s *PagerDutyEvent) UnmarshalJSON(data []byte) error

type PagerDutyEventProxy 

type PagerDutyEventProxy struct {
	Host *string `json:"host,omitempty"`
	Port *int    `json:"port,omitempty"`
}

PagerDutyEventProxy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L56-L59

func NewPagerDutyEventProxy added in v8.5.0 

func NewPagerDutyEventProxy() *PagerDutyEventProxy

NewPagerDutyEventProxy returns a PagerDutyEventProxy.

func (*PagerDutyEventProxy) UnmarshalJSON added in v8.7.1 

func (s *PagerDutyEventProxy) UnmarshalJSON(data []byte) error

type PagerDutyResult 

type PagerDutyResult struct {
	Event    PagerDutyEvent           `json:"event"`
	Reason   *string                  `json:"reason,omitempty"`
	Request  *HttpInputRequestResult  `json:"request,omitempty"`
	Response *HttpInputResponseResult `json:"response,omitempty"`
}

PagerDutyResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L78-L83

func NewPagerDutyResult added in v8.5.0 

func NewPagerDutyResult() *PagerDutyResult

NewPagerDutyResult returns a PagerDutyResult.

func (*PagerDutyResult) UnmarshalJSON added in v8.9.0 

func (s *PagerDutyResult) UnmarshalJSON(data []byte) error

type PainlessContextSetup 

type PainlessContextSetup struct {
	// Document Document that's temporarily indexed in-memory and accessible from the script.
	Document json.RawMessage `json:"document,omitempty"`
	// Index Index containing a mapping that's compatible with the indexed document.
	// You may specify a remote index by prefixing the index with the remote cluster
	// alias.
	// For example, `remote1:my_index` indicates that you want to run the painless
	// script against the "my_index" index on the "remote1" cluster.
	// This request will be forwarded to the "remote1" cluster if you have
	// configured a connection to that remote cluster.
	//
	// NOTE: Wildcards are not accepted in the index expression for this endpoint.
	// The expression `*:myindex` will return the error "No such remote cluster" and
	// the expression `logs*` or `remote1:logs*` will return the error "index not
	// found".
	Index string `json:"index"`
	// Query Use this parameter to specify a query for computing a score.
	Query *Query `json:"query,omitempty"`
}

PainlessContextSetup type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/scripts_painless_execute/types.ts#L27-L46

func NewPainlessContextSetup added in v8.5.0 

func NewPainlessContextSetup() *PainlessContextSetup

NewPainlessContextSetup returns a PainlessContextSetup.

func (*PainlessContextSetup) UnmarshalJSON added in v8.7.1 

func (s *PainlessContextSetup) UnmarshalJSON(data []byte) error

type ParentAggregate 

type ParentAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

ParentAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L894-L898

func NewParentAggregate added in v8.5.0 

func NewParentAggregate() *ParentAggregate

NewParentAggregate returns a ParentAggregate.

func (ParentAggregate) MarshalJSON 

func (s ParentAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ParentAggregate) UnmarshalJSON added in v8.7.0 

func (s *ParentAggregate) UnmarshalJSON(data []byte) error

type ParentAggregation 

type ParentAggregation struct {
	// Type The child type that should be selected.
	Type *string `json:"type,omitempty"`
}

ParentAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L662-L667

func NewParentAggregation added in v8.5.0 

func NewParentAggregation() *ParentAggregation

NewParentAggregation returns a ParentAggregation.

func (*ParentAggregation) UnmarshalJSON added in v8.7.1 

func (s *ParentAggregation) UnmarshalJSON(data []byte) error

type ParentIdQuery 

type ParentIdQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Id ID of the parent document.
	Id *string `json:"id,omitempty"`
	// IgnoreUnmapped Indicates whether to ignore an unmapped `type` and not return any documents
	// instead of an error.
	IgnoreUnmapped *bool   `json:"ignore_unmapped,omitempty"`
	QueryName_     *string `json:"_name,omitempty"`
	// Type Name of the child relationship mapped for the `join` field.
	Type *string `json:"type,omitempty"`
}

ParentIdQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/joining.ts#L141-L158

func NewParentIdQuery added in v8.5.0 

func NewParentIdQuery() *ParentIdQuery

NewParentIdQuery returns a ParentIdQuery.

func (*ParentIdQuery) UnmarshalJSON added in v8.7.1 

func (s *ParentIdQuery) UnmarshalJSON(data []byte) error

type ParentTaskInfo 

type ParentTaskInfo struct {
	Action      string     `json:"action"`
	Cancellable bool       `json:"cancellable"`
	Cancelled   *bool      `json:"cancelled,omitempty"`
	Children    []TaskInfo `json:"children,omitempty"`
	// Description Human readable text that identifies the particular request that the task is
	// performing.
	// For example, it might identify the search request being performed by a search
	// task.
	// Other kinds of tasks have different descriptions, like `_reindex` which has
	// the source and the destination, or `_bulk` which just has the number of
	// requests and the destination indices.
	// Many requests will have only an empty description because more detailed
	// information about the request is not easily available or particularly helpful
	// in identifying the request.
	Description        *string           `json:"description,omitempty"`
	Headers            map[string]string `json:"headers"`
	Id                 int64             `json:"id"`
	Node               string            `json:"node"`
	ParentTaskId       TaskId            `json:"parent_task_id,omitempty"`
	RunningTime        Duration          `json:"running_time,omitempty"`
	RunningTimeInNanos int64             `json:"running_time_in_nanos"`
	StartTimeInMillis  int64             `json:"start_time_in_millis"`
	// Status The internal status of the task, which varies from task to task.
	// The format also varies.
	// While the goal is to keep the status for a particular task consistent from
	// version to version, this is not always possible because sometimes the
	// implementation changes.
	// Fields might be removed from the status for a particular request so any
	// parsing you do of the status might break in minor releases.
	Status json.RawMessage `json:"status,omitempty"`
	Type   string          `json:"type"`
}

ParentTaskInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/tasks/_types/TaskListResponseBase.ts#L45-L47

func NewParentTaskInfo added in v8.5.0 

func NewParentTaskInfo() *ParentTaskInfo

NewParentTaskInfo returns a ParentTaskInfo.

func (*ParentTaskInfo) UnmarshalJSON added in v8.7.1 

func (s *ParentTaskInfo) UnmarshalJSON(data []byte) error

type PassThroughInferenceOptions 

type PassThroughInferenceOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   *Vocabulary                  `json:"vocabulary,omitempty"`
}

PassThroughInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L239-L246

func NewPassThroughInferenceOptions added in v8.5.0 

func NewPassThroughInferenceOptions() *PassThroughInferenceOptions

NewPassThroughInferenceOptions returns a PassThroughInferenceOptions.

func (*PassThroughInferenceOptions) UnmarshalJSON added in v8.9.0 

func (s *PassThroughInferenceOptions) UnmarshalJSON(data []byte) error

type PassThroughInferenceUpdateOptions 

type PassThroughInferenceUpdateOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

PassThroughInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L404-L409

func NewPassThroughInferenceUpdateOptions added in v8.5.0 

func NewPassThroughInferenceUpdateOptions() *PassThroughInferenceUpdateOptions

NewPassThroughInferenceUpdateOptions returns a PassThroughInferenceUpdateOptions.

func (*PassThroughInferenceUpdateOptions) UnmarshalJSON added in v8.9.0 

func (s *PassThroughInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type PassthroughObjectProperty added in v8.18.0 

type PassthroughObjectProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Enabled     *bool                          `json:"enabled,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Priority            *int                                             `json:"priority,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	TimeSeriesDimension *bool                                            `json:"time_series_dimension,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

PassthroughObjectProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/complex.ts#L52-L57

func NewPassthroughObjectProperty added in v8.18.0 

func NewPassthroughObjectProperty() *PassthroughObjectProperty

NewPassthroughObjectProperty returns a PassthroughObjectProperty.

func (PassthroughObjectProperty) MarshalJSON added in v8.18.0 

func (s PassthroughObjectProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PassthroughObjectProperty) UnmarshalJSON added in v8.18.0 

func (s *PassthroughObjectProperty) UnmarshalJSON(data []byte) error

type PathHierarchyTokenizer 

type PathHierarchyTokenizer struct {
	BufferSize  Stringifiedinteger `json:"buffer_size,omitempty"`
	Delimiter   *string            `json:"delimiter,omitempty"`
	Replacement *string            `json:"replacement,omitempty"`
	Reverse     Stringifiedboolean `json:"reverse,omitempty"`
	Skip        Stringifiedinteger `json:"skip,omitempty"`
	Type        string             `json:"type,omitempty"`
	Version     *string            `json:"version,omitempty"`
}

PathHierarchyTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L95-L102

func NewPathHierarchyTokenizer added in v8.5.0 

func NewPathHierarchyTokenizer() *PathHierarchyTokenizer

NewPathHierarchyTokenizer returns a PathHierarchyTokenizer.

func (PathHierarchyTokenizer) MarshalJSON added in v8.9.0 

func (s PathHierarchyTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PathHierarchyTokenizer) UnmarshalJSON added in v8.7.1 

func (s *PathHierarchyTokenizer) UnmarshalJSON(data []byte) error

type PatternAnalyzer 

type PatternAnalyzer struct {
	Flags     *string   `json:"flags,omitempty"`
	Lowercase *bool     `json:"lowercase,omitempty"`
	Pattern   string    `json:"pattern"`
	Stopwords StopWords `json:"stopwords,omitempty"`
	Type      string    `json:"type,omitempty"`
	Version   *string   `json:"version,omitempty"`
}

PatternAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L311-L318

func NewPatternAnalyzer added in v8.5.0 

func NewPatternAnalyzer() *PatternAnalyzer

NewPatternAnalyzer returns a PatternAnalyzer.

func (PatternAnalyzer) MarshalJSON added in v8.9.0 

func (s PatternAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PatternAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *PatternAnalyzer) UnmarshalJSON(data []byte) error

type PatternCaptureTokenFilter 

type PatternCaptureTokenFilter struct {
	// Patterns A list of regular expressions to match.
	Patterns []string `json:"patterns"`
	// PreserveOriginal If set to `true` (the default) it will emit the original token.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	Type             string             `json:"type,omitempty"`
	Version          *string            `json:"version,omitempty"`
}

PatternCaptureTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L374-L380

func NewPatternCaptureTokenFilter added in v8.5.0 

func NewPatternCaptureTokenFilter() *PatternCaptureTokenFilter

NewPatternCaptureTokenFilter returns a PatternCaptureTokenFilter.

func (PatternCaptureTokenFilter) MarshalJSON added in v8.9.0 

func (s PatternCaptureTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PatternCaptureTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *PatternCaptureTokenFilter) UnmarshalJSON(data []byte) error

type PatternReplaceCharFilter 

type PatternReplaceCharFilter struct {
	Flags       *string `json:"flags,omitempty"`
	Pattern     string  `json:"pattern"`
	Replacement *string `json:"replacement,omitempty"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
}

PatternReplaceCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/char_filters.ts#L57-L62

func NewPatternReplaceCharFilter added in v8.5.0 

func NewPatternReplaceCharFilter() *PatternReplaceCharFilter

NewPatternReplaceCharFilter returns a PatternReplaceCharFilter.

func (PatternReplaceCharFilter) MarshalJSON added in v8.9.0 

func (s PatternReplaceCharFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PatternReplaceCharFilter) UnmarshalJSON added in v8.7.1 

func (s *PatternReplaceCharFilter) UnmarshalJSON(data []byte) error

type PatternReplaceTokenFilter 

type PatternReplaceTokenFilter struct {
	// All If `true`, all substrings matching the pattern parameter’s regular expression
	// are replaced. If `false`, the filter replaces only the first matching
	// substring in each token. Defaults to `true`.
	All *bool `json:"all,omitempty"`
	// Pattern Regular expression, written in Java’s regular expression syntax. The filter
	// replaces token substrings matching this pattern with the substring in the
	// `replacement` parameter.
	Pattern string `json:"pattern"`
	// Replacement Replacement substring. Defaults to an empty substring (`""`).
	Replacement *string `json:"replacement,omitempty"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
}

PatternReplaceTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L382-L390

func NewPatternReplaceTokenFilter added in v8.5.0 

func NewPatternReplaceTokenFilter() *PatternReplaceTokenFilter

NewPatternReplaceTokenFilter returns a PatternReplaceTokenFilter.

func (PatternReplaceTokenFilter) MarshalJSON added in v8.9.0 

func (s PatternReplaceTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PatternReplaceTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *PatternReplaceTokenFilter) UnmarshalJSON(data []byte) error

type PatternTokenizer 

type PatternTokenizer struct {
	Flags   *string `json:"flags,omitempty"`
	Group   *int    `json:"group,omitempty"`
	Pattern *string `json:"pattern,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PatternTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L104-L109

func NewPatternTokenizer added in v8.5.0 

func NewPatternTokenizer() *PatternTokenizer

NewPatternTokenizer returns a PatternTokenizer.

func (PatternTokenizer) MarshalJSON added in v8.9.0 

func (s PatternTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PatternTokenizer) UnmarshalJSON added in v8.7.1 

func (s *PatternTokenizer) UnmarshalJSON(data []byte) error

type PendingTask 

type PendingTask struct {
	// Executing Indicates whether the pending tasks are currently executing or not.
	Executing bool `json:"executing"`
	// InsertOrder The number that represents when the task has been inserted into the task
	// queue.
	InsertOrder int `json:"insert_order"`
	// Priority The priority of the pending task.
	// The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT`
	// > `HIGH` > `NORMAL` > `LOW` > `LANGUID`.
	Priority string `json:"priority"`
	// Source A general description of the cluster task that may include a reason and
	// origin.
	Source string `json:"source"`
	// TimeInQueue The time since the task is waiting for being performed.
	TimeInQueue Duration `json:"time_in_queue,omitempty"`
	// TimeInQueueMillis The time expressed in milliseconds since the task is waiting for being
	// performed.
	TimeInQueueMillis int64 `json:"time_in_queue_millis"`
}

PendingTask type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/pending_tasks/types.ts#L23-L47

func NewPendingTask added in v8.5.0 

func NewPendingTask() *PendingTask

NewPendingTask returns a PendingTask.

func (*PendingTask) UnmarshalJSON added in v8.7.1 

func (s *PendingTask) UnmarshalJSON(data []byte) error

type PendingTasksRecord 

type PendingTasksRecord struct {
	// InsertOrder The task insertion order.
	InsertOrder *string `json:"insertOrder,omitempty"`
	// Priority The task priority.
	Priority *string `json:"priority,omitempty"`
	// Source The task source.
	Source *string `json:"source,omitempty"`
	// TimeInQueue Indicates how long the task has been in queue.
	TimeInQueue *string `json:"timeInQueue,omitempty"`
}

PendingTasksRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/pending_tasks/types.ts#L20-L41

func NewPendingTasksRecord added in v8.5.0 

func NewPendingTasksRecord() *PendingTasksRecord

NewPendingTasksRecord returns a PendingTasksRecord.

func (*PendingTasksRecord) UnmarshalJSON added in v8.9.0 

func (s *PendingTasksRecord) UnmarshalJSON(data []byte) error

type PerPartitionCategorization 

type PerPartitionCategorization struct {
	// Enabled To enable this setting, you must also set the `partition_field_name` property
	// to the same value in every detector that uses the keyword `mlcategory`.
	// Otherwise, job creation fails.
	Enabled *bool `json:"enabled,omitempty"`
	// StopOnWarn This setting can be set to true only if per-partition categorization is
	// enabled. If true, both categorization and subsequent anomaly detection stops
	// for partitions where the categorization status changes to warn. This setting
	// makes it viable to have a job where it is expected that categorization works
	// well for some partitions but not others; you do not pay the cost of bad
	// categorization forever in the partitions where it works badly.
	StopOnWarn *bool `json:"stop_on_warn,omitempty"`
}

PerPartitionCategorization type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Analysis.ts#L150-L159

func NewPerPartitionCategorization added in v8.5.0 

func NewPerPartitionCategorization() *PerPartitionCategorization

NewPerPartitionCategorization returns a PerPartitionCategorization.

func (*PerPartitionCategorization) UnmarshalJSON added in v8.7.1 

func (s *PerPartitionCategorization) UnmarshalJSON(data []byte) error

type Percentage 

type Percentage any

Percentage holds the union for the following types: 

string
float32

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Numeric.ts#L28-L28

type PercentageScoreHeuristic 

type PercentageScoreHeuristic struct {
}

PercentageScoreHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L811-L811

func NewPercentageScoreHeuristic added in v8.5.0 

func NewPercentageScoreHeuristic() *PercentageScoreHeuristic

NewPercentageScoreHeuristic returns a PercentageScoreHeuristic.

type PercentileRanksAggregation 

type PercentileRanksAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Hdr Uses the alternative High Dynamic Range Histogram algorithm to calculate
	// percentile ranks.
	Hdr *HdrMethod `json:"hdr,omitempty"`
	// Keyed By default, the aggregation associates a unique string key with each bucket
	// and returns the ranges as a hash rather than an array.
	// Set to `false` to disable this behavior.
	Keyed *bool `json:"keyed,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// Tdigest Sets parameters for the default TDigest algorithm used to calculate
	// percentile ranks.
	Tdigest *TDigest `json:"tdigest,omitempty"`
	// Values An array of values for which to calculate the percentile ranks.
	Values *[]Float64 `json:"values,omitempty"`
}

PercentileRanksAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L180-L202

func NewPercentileRanksAggregation added in v8.5.0 

func NewPercentileRanksAggregation() *PercentileRanksAggregation

NewPercentileRanksAggregation returns a PercentileRanksAggregation.

func (*PercentileRanksAggregation) UnmarshalJSON added in v8.7.1 

func (s *PercentileRanksAggregation) UnmarshalJSON(data []byte) error

type Percentiles 

type Percentiles any

Percentiles holds the union for the following types: 

KeyedPercentiles
[]ArrayPercentilesItem

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L152-L153

type PercentilesAggregation 

type PercentilesAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Hdr Uses the alternative High Dynamic Range Histogram algorithm to calculate
	// percentiles.
	Hdr *HdrMethod `json:"hdr,omitempty"`
	// Keyed By default, the aggregation associates a unique string key with each bucket
	// and returns the ranges as a hash rather than an array.
	// Set to `false` to disable this behavior.
	Keyed *bool `json:"keyed,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// Percents The percentiles to calculate.
	Percents []Float64 `json:"percents,omitempty"`
	Script   *Script   `json:"script,omitempty"`
	// Tdigest Sets parameters for the default TDigest algorithm used to calculate
	// percentiles.
	Tdigest *TDigest `json:"tdigest,omitempty"`
}

PercentilesAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L204-L223

func NewPercentilesAggregation added in v8.5.0 

func NewPercentilesAggregation() *PercentilesAggregation

NewPercentilesAggregation returns a PercentilesAggregation.

func (*PercentilesAggregation) UnmarshalJSON added in v8.7.1 

func (s *PercentilesAggregation) UnmarshalJSON(data []byte) error

type PercentilesBucketAggregate 

type PercentilesBucketAggregate struct {
	Meta   Metadata    `json:"meta,omitempty"`
	Values Percentiles `json:"values"`
}

PercentilesBucketAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L180-L181

func NewPercentilesBucketAggregate added in v8.5.0 

func NewPercentilesBucketAggregate() *PercentilesBucketAggregate

NewPercentilesBucketAggregate returns a PercentilesBucketAggregate.

func (*PercentilesBucketAggregate) UnmarshalJSON added in v8.7.1 

func (s *PercentilesBucketAggregate) UnmarshalJSON(data []byte) error

type PercentilesBucketAggregation 

type PercentilesBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Percents The list of percentiles to calculate.
	Percents []Float64 `json:"percents,omitempty"`
}

PercentilesBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L389-L397

func NewPercentilesBucketAggregation added in v8.5.0 

func NewPercentilesBucketAggregation() *PercentilesBucketAggregation

NewPercentilesBucketAggregation returns a PercentilesBucketAggregation.

func (*PercentilesBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *PercentilesBucketAggregation) UnmarshalJSON(data []byte) error

type PercolateQuery 

type PercolateQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Document The source of the document being percolated.
	Document json.RawMessage `json:"document,omitempty"`
	// Documents An array of sources of the documents being percolated.
	Documents []json.RawMessage `json:"documents,omitempty"`
	// Field Field that holds the indexed queries. The field must use the `percolator`
	// mapping type.
	Field string `json:"field"`
	// Id The ID of a stored document to percolate.
	Id *string `json:"id,omitempty"`
	// Index The index of a stored document to percolate.
	Index *string `json:"index,omitempty"`
	// Name The suffix used for the `_percolator_document_slot` field when multiple
	// `percolate` queries are specified.
	Name *string `json:"name,omitempty"`
	// Preference Preference used to fetch document to percolate.
	Preference *string `json:"preference,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Routing Routing used to fetch document to percolate.
	Routing *string `json:"routing,omitempty"`
	// Version The expected version of a stored document to percolate.
	Version *int64 `json:"version,omitempty"`
}

PercolateQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L205-L245

func NewPercolateQuery added in v8.5.0 

func NewPercolateQuery() *PercolateQuery

NewPercolateQuery returns a PercolateQuery.

func (*PercolateQuery) UnmarshalJSON added in v8.7.1 

func (s *PercolateQuery) UnmarshalJSON(data []byte) error

type PercolatorProperty 

type PercolatorProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

PercolatorProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L201-L203

func NewPercolatorProperty added in v8.5.0 

func NewPercolatorProperty() *PercolatorProperty

NewPercolatorProperty returns a PercolatorProperty.

func (PercolatorProperty) MarshalJSON added in v8.9.0 

func (s PercolatorProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PercolatorProperty) UnmarshalJSON added in v8.7.0 

func (s *PercolatorProperty) UnmarshalJSON(data []byte) error

type PersianAnalyzer added in v8.16.0 

type PersianAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

PersianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L235-L239

func NewPersianAnalyzer added in v8.16.0 

func NewPersianAnalyzer() *PersianAnalyzer

NewPersianAnalyzer returns a PersianAnalyzer.

func (PersianAnalyzer) MarshalJSON added in v8.16.0 

func (s PersianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PersianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *PersianAnalyzer) UnmarshalJSON(data []byte) error

type PersianNormalizationTokenFilter added in v8.18.1 

type PersianNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PersianNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L518-L520

func NewPersianNormalizationTokenFilter added in v8.18.1 

func NewPersianNormalizationTokenFilter() *PersianNormalizationTokenFilter

NewPersianNormalizationTokenFilter returns a PersianNormalizationTokenFilter.

func (PersianNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s PersianNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PersianNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *PersianNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type PersistentTaskStatus 

type PersistentTaskStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

PersistentTaskStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L56-L58

func NewPersistentTaskStatus added in v8.5.0 

func NewPersistentTaskStatus() *PersistentTaskStatus

NewPersistentTaskStatus returns a PersistentTaskStatus.

type Phase 

type Phase struct {
	Actions *IlmActions `json:"actions,omitempty"`
	MinAge  Duration    `json:"min_age,omitempty"`
}

Phase type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L26-L29

func NewPhase added in v8.5.0 

func NewPhase() *Phase

NewPhase returns a Phase.

func (*Phase) UnmarshalJSON added in v8.7.1 

func (s *Phase) UnmarshalJSON(data []byte) error

type Phases 

type Phases struct {
	Cold   *Phase `json:"cold,omitempty"`
	Delete *Phase `json:"delete,omitempty"`
	Frozen *Phase `json:"frozen,omitempty"`
	Hot    *Phase `json:"hot,omitempty"`
	Warm   *Phase `json:"warm,omitempty"`
}

Phases type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L31-L37

func NewPhases added in v8.5.0 

func NewPhases() *Phases

NewPhases returns a Phases.

type PhoneticTokenFilter 

type PhoneticTokenFilter struct {
	Encoder     phoneticencoder.PhoneticEncoder     `json:"encoder"`
	Languageset []phoneticlanguage.PhoneticLanguage `json:"languageset,omitempty"`
	MaxCodeLen  *int                                `json:"max_code_len,omitempty"`
	NameType    *phoneticnametype.PhoneticNameType  `json:"name_type,omitempty"`
	Replace     *bool                               `json:"replace,omitempty"`
	RuleType    *phoneticruletype.PhoneticRuleType  `json:"rule_type,omitempty"`
	Type        string                              `json:"type,omitempty"`
	Version     *string                             `json:"version,omitempty"`
}

PhoneticTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/phonetic-plugin.ts#L64-L72

func NewPhoneticTokenFilter added in v8.5.0 

func NewPhoneticTokenFilter() *PhoneticTokenFilter

NewPhoneticTokenFilter returns a PhoneticTokenFilter.

func (PhoneticTokenFilter) MarshalJSON added in v8.9.0 

func (s PhoneticTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PhoneticTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *PhoneticTokenFilter) UnmarshalJSON(data []byte) error

type PhraseSuggest 

type PhraseSuggest struct {
	Length  int                   `json:"length"`
	Offset  int                   `json:"offset"`
	Options []PhraseSuggestOption `json:"options"`
	Text    string                `json:"text"`
}

PhraseSuggest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L57-L62

func NewPhraseSuggest added in v8.5.0 

func NewPhraseSuggest() *PhraseSuggest

NewPhraseSuggest returns a PhraseSuggest.

func (*PhraseSuggest) UnmarshalJSON added in v8.7.1 

func (s *PhraseSuggest) UnmarshalJSON(data []byte) error

type PhraseSuggestCollate 

type PhraseSuggestCollate struct {
	// Params Parameters to use if the query is templated.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// Prune Returns all suggestions with an extra `collate_match` option indicating
	// whether the generated phrase matched any document.
	Prune *bool `json:"prune,omitempty"`
	// Query A collate query that is run once for every suggestion.
	Query PhraseSuggestCollateQuery `json:"query"`
}

PhraseSuggestCollate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L333-L346

func NewPhraseSuggestCollate added in v8.5.0 

func NewPhraseSuggestCollate() *PhraseSuggestCollate

NewPhraseSuggestCollate returns a PhraseSuggestCollate.

func (*PhraseSuggestCollate) UnmarshalJSON added in v8.7.1 

func (s *PhraseSuggestCollate) UnmarshalJSON(data []byte) error

type PhraseSuggestCollateQuery 

type PhraseSuggestCollateQuery struct {
	// Id The search template ID.
	Id *string `json:"id,omitempty"`
	// Source The query source.
	Source *string `json:"source,omitempty"`
}

PhraseSuggestCollateQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L348-L357

func NewPhraseSuggestCollateQuery added in v8.5.0 

func NewPhraseSuggestCollateQuery() *PhraseSuggestCollateQuery

NewPhraseSuggestCollateQuery returns a PhraseSuggestCollateQuery.

func (*PhraseSuggestCollateQuery) UnmarshalJSON added in v8.7.1 

func (s *PhraseSuggestCollateQuery) UnmarshalJSON(data []byte) error

type PhraseSuggestHighlight 

type PhraseSuggestHighlight struct {
	// PostTag Use in conjunction with `pre_tag` to define the HTML tags to use for the
	// highlighted text.
	PostTag string `json:"post_tag"`
	// PreTag Use in conjunction with `post_tag` to define the HTML tags to use for the
	// highlighted text.
	PreTag string `json:"pre_tag"`
}

PhraseSuggestHighlight type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L419-L428

func NewPhraseSuggestHighlight added in v8.5.0 

func NewPhraseSuggestHighlight() *PhraseSuggestHighlight

NewPhraseSuggestHighlight returns a PhraseSuggestHighlight.

func (*PhraseSuggestHighlight) UnmarshalJSON added in v8.9.0 

func (s *PhraseSuggestHighlight) UnmarshalJSON(data []byte) error

type PhraseSuggestOption 

type PhraseSuggestOption struct {
	CollateMatch *bool   `json:"collate_match,omitempty"`
	Highlighted  *string `json:"highlighted,omitempty"`
	Score        Float64 `json:"score"`
	Text         string  `json:"text"`
}

PhraseSuggestOption type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L86-L91

func NewPhraseSuggestOption added in v8.5.0 

func NewPhraseSuggestOption() *PhraseSuggestOption

NewPhraseSuggestOption returns a PhraseSuggestOption.

func (*PhraseSuggestOption) UnmarshalJSON added in v8.7.1 

func (s *PhraseSuggestOption) UnmarshalJSON(data []byte) error

type PhraseSuggester 

type PhraseSuggester struct {
	// Analyzer The analyzer to analyze the suggest text with.
	// Defaults to the search analyzer of the suggest field.
	Analyzer *string `json:"analyzer,omitempty"`
	// Collate Checks each suggestion against the specified query to prune suggestions for
	// which no matching docs exist in the index.
	Collate *PhraseSuggestCollate `json:"collate,omitempty"`
	// Confidence Defines a factor applied to the input phrases score, which is used as a
	// threshold for other suggest candidates.
	// Only candidates that score higher than the threshold will be included in the
	// result.
	Confidence *Float64 `json:"confidence,omitempty"`
	// DirectGenerator A list of candidate generators that produce a list of possible terms per term
	// in the given text.
	DirectGenerator []DirectGenerator `json:"direct_generator,omitempty"`
	// Field The field to fetch the candidate suggestions from.
	// Needs to be set globally or per suggestion.
	Field         string `json:"field"`
	ForceUnigrams *bool  `json:"force_unigrams,omitempty"`
	// GramSize Sets max size of the n-grams (shingles) in the field.
	// If the field doesn’t contain n-grams (shingles), this should be omitted or
	// set to `1`.
	// If the field uses a shingle filter, the `gram_size` is set to the
	// `max_shingle_size` if not explicitly set.
	GramSize *int `json:"gram_size,omitempty"`
	// Highlight Sets up suggestion highlighting.
	// If not provided, no highlighted field is returned.
	Highlight *PhraseSuggestHighlight `json:"highlight,omitempty"`
	// MaxErrors The maximum percentage of the terms considered to be misspellings in order to
	// form a correction.
	// This method accepts a float value in the range `[0..1)` as a fraction of the
	// actual query terms or a number `>=1` as an absolute number of query terms.
	MaxErrors *Float64 `json:"max_errors,omitempty"`
	// RealWordErrorLikelihood The likelihood of a term being misspelled even if the term exists in the
	// dictionary.
	RealWordErrorLikelihood *Float64 `json:"real_word_error_likelihood,omitempty"`
	// Separator The separator that is used to separate terms in the bigram field.
	// If not set, the whitespace character is used as a separator.
	Separator *string `json:"separator,omitempty"`
	// ShardSize Sets the maximum number of suggested terms to be retrieved from each
	// individual shard.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The maximum corrections to be returned per suggest text token.
	Size *int `json:"size,omitempty"`
	// Smoothing The smoothing model used to balance weight between infrequent grams (grams
	// (shingles) are not existing in the index) and frequent grams (appear at least
	// once in the index).
	// The default model is Stupid Backoff.
	Smoothing *SmoothingModelContainer `json:"smoothing,omitempty"`
	// Text The text/query to provide suggestions for.
	Text       *string `json:"text,omitempty"`
	TokenLimit *int    `json:"token_limit,omitempty"`
}

PhraseSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L359-L417

func NewPhraseSuggester added in v8.5.0 

func NewPhraseSuggester() *PhraseSuggester

NewPhraseSuggester returns a PhraseSuggester.

func (*PhraseSuggester) UnmarshalJSON added in v8.7.1 

func (s *PhraseSuggester) UnmarshalJSON(data []byte) error

type PinnedDoc 

type PinnedDoc struct {
	// Id_ The unique document ID.
	Id_ string `json:"_id"`
	// Index_ The index that contains the document.
	Index_ string `json:"_index"`
}

PinnedDoc type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L269-L278

func NewPinnedDoc added in v8.5.0 

func NewPinnedDoc() *PinnedDoc

NewPinnedDoc returns a PinnedDoc.

func (*PinnedDoc) UnmarshalJSON added in v8.7.1 

func (s *PinnedDoc) UnmarshalJSON(data []byte) error

type PinnedQuery 

type PinnedQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Docs Documents listed in the order they are to appear in results.
	// Required if `ids` is not specified.
	Docs []PinnedDoc `json:"docs,omitempty"`
	// Ids Document IDs listed in the order they are to appear in results.
	// Required if `docs` is not specified.
	Ids []string `json:"ids,omitempty"`
	// Organic Any choice of query used to rank documents which will be ranked below the
	// "pinned" documents.
	Organic    *Query  `json:"organic,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
}

PinnedQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L247-L267

func NewPinnedQuery added in v8.5.0 

func NewPinnedQuery() *PinnedQuery

NewPinnedQuery returns a PinnedQuery.

func (*PinnedQuery) UnmarshalJSON added in v8.7.1 

func (s *PinnedQuery) UnmarshalJSON(data []byte) error

type PinnedRetriever added in v8.18.1 

type PinnedRetriever struct {
	Docs []SpecifiedDocument `json:"docs,omitempty"`
	// Filter Query to filter the documents that can match.
	Filter []Query  `json:"filter,omitempty"`
	Ids    []string `json:"ids,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_          *string `json:"_name,omitempty"`
	RankWindowSize int     `json:"rank_window_size"`
	// Retriever Inner retriever.
	Retriever *RetrieverContainer `json:"retriever,omitempty"`
}

PinnedRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L74-L80

func NewPinnedRetriever added in v8.18.1 

func NewPinnedRetriever() *PinnedRetriever

NewPinnedRetriever returns a PinnedRetriever.

func (*PinnedRetriever) UnmarshalJSON added in v8.18.1 

func (s *PinnedRetriever) UnmarshalJSON(data []byte) error

type PipeSeparatedFlagsSimpleQueryStringFlag added in v8.10.0 

type PipeSeparatedFlagsSimpleQueryStringFlag any

PipeSeparatedFlagsSimpleQueryStringFlag holds the union for the following types: 

simplequerystringflag.SimpleQueryStringFlag
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/PipeSeparatedFlags.ts#L20-L27

type PipelineConfig 

type PipelineConfig struct {
	// Description Description of the ingest pipeline.
	Description *string `json:"description,omitempty"`
	// Processors Processors used to perform transformations on documents before indexing.
	// Processors run sequentially in the order specified.
	Processors []ProcessorContainer `json:"processors"`
	// Version Version number used by external systems to track ingest pipelines.
	Version *int64 `json:"version,omitempty"`
}

PipelineConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Pipeline.ts#L67-L81

func NewPipelineConfig added in v8.5.0 

func NewPipelineConfig() *PipelineConfig

NewPipelineConfig returns a PipelineConfig.

func (*PipelineConfig) UnmarshalJSON added in v8.7.1 

func (s *PipelineConfig) UnmarshalJSON(data []byte) error

type PipelineMetadata 

type PipelineMetadata struct {
	Type    string `json:"type"`
	Version string `json:"version"`
}

PipelineMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/logstash/_types/Pipeline.ts#L23-L26

func NewPipelineMetadata added in v8.5.0 

func NewPipelineMetadata() *PipelineMetadata

NewPipelineMetadata returns a PipelineMetadata.

func (*PipelineMetadata) UnmarshalJSON added in v8.9.0 

func (s *PipelineMetadata) UnmarshalJSON(data []byte) error

type PipelineProcessor 

type PipelineProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissingPipeline Whether to ignore missing pipelines instead of failing.
	IgnoreMissingPipeline *bool `json:"ignore_missing_pipeline,omitempty"`
	// Name The name of the pipeline to execute.
	// Supports template snippets.
	Name string `json:"name"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

PipelineProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1284-L1295

func NewPipelineProcessor added in v8.5.0 

func NewPipelineProcessor() *PipelineProcessor

NewPipelineProcessor returns a PipelineProcessor.

func (*PipelineProcessor) UnmarshalJSON added in v8.7.1 

func (s *PipelineProcessor) UnmarshalJSON(data []byte) error

type PipelineProcessorResult added in v8.18.1 

type PipelineProcessorResult struct {
	Description   *string                                                          `json:"description,omitempty"`
	Doc           *DocumentSimulation                                              `json:"doc,omitempty"`
	Error         *ErrorCause                                                      `json:"error,omitempty"`
	IgnoredError  *ErrorCause                                                      `json:"ignored_error,omitempty"`
	ProcessorType *string                                                          `json:"processor_type,omitempty"`
	Status        *pipelinesimulationstatusoptions.PipelineSimulationStatusOptions `json:"status,omitempty"`
	Tag           *string                                                          `json:"tag,omitempty"`
}

PipelineProcessorResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L59-L67

func NewPipelineProcessorResult added in v8.18.1 

func NewPipelineProcessorResult() *PipelineProcessorResult

NewPipelineProcessorResult returns a PipelineProcessorResult.

func (*PipelineProcessorResult) UnmarshalJSON added in v8.18.1 

func (s *PipelineProcessorResult) UnmarshalJSON(data []byte) error

type PipelineSettings 

type PipelineSettings struct {
	// PipelineBatchDelay When creating pipeline event batches, how long in milliseconds to wait for
	// each event before dispatching an undersized batch to pipeline workers.
	PipelineBatchDelay int `json:"pipeline.batch.delay"`
	// PipelineBatchSize The maximum number of events an individual worker thread will collect from
	// inputs before attempting to execute its filters and outputs.
	PipelineBatchSize int `json:"pipeline.batch.size"`
	// PipelineWorkers The number of workers that will, in parallel, execute the filter and output
	// stages of the pipeline.
	PipelineWorkers int `json:"pipeline.workers"`
	// QueueCheckpointWrites The maximum number of written events before forcing a checkpoint when
	// persistent queues are enabled (`queue.type: persisted`).
	QueueCheckpointWrites int `json:"queue.checkpoint.writes"`
	// QueueMaxBytesNumber The total capacity of the queue (`queue.type: persisted`) in number of bytes.
	QueueMaxBytesNumber int `json:"queue.max_bytes.number"`
	// QueueMaxBytesUnits The total capacity of the queue (`queue.type: persisted`) in terms of units
	// of bytes.
	QueueMaxBytesUnits string `json:"queue.max_bytes.units"`
	// QueueType The internal queuing model to use for event buffering.
	QueueType string `json:"queue.type"`
}

PipelineSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/logstash/_types/Pipeline.ts#L28-L59

func NewPipelineSettings added in v8.5.0 

func NewPipelineSettings() *PipelineSettings

NewPipelineSettings returns a PipelineSettings.

func (*PipelineSettings) UnmarshalJSON added in v8.7.1 

func (s *PipelineSettings) UnmarshalJSON(data []byte) error

type Pivot 

type Pivot struct {
	// Aggregations Defines how to aggregate the grouped data. The following aggregations are
	// currently supported: average, bucket
	// script, bucket selector, cardinality, filter, geo bounds, geo centroid, geo
	// line, max, median absolute deviation,
	// min, missing, percentiles, rare terms, scripted metric, stats, sum, terms,
	// top metrics, value count, weighted
	// average.
	Aggregations map[string]Aggregations `json:"aggregations,omitempty"`
	// GroupBy Defines how to group the data. More than one grouping can be defined per
	// pivot. The following groupings are
	// currently supported: date histogram, geotile grid, histogram, terms.
	GroupBy map[string]PivotGroupByContainer `json:"group_by,omitempty"`
}

Pivot type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L54-L68

func NewPivot added in v8.5.0 

func NewPivot() *Pivot

NewPivot returns a Pivot.

type PivotGroupByContainer 

type PivotGroupByContainer struct {
	DateHistogram *DateHistogramAggregation `json:"date_histogram,omitempty"`
	GeotileGrid   *GeoTileGridAggregation   `json:"geotile_grid,omitempty"`
	Histogram     *HistogramAggregation     `json:"histogram,omitempty"`
	Terms         *TermsAggregation         `json:"terms,omitempty"`
}

PivotGroupByContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L70-L78

func NewPivotGroupByContainer added in v8.5.0 

func NewPivotGroupByContainer() *PivotGroupByContainer

NewPivotGroupByContainer returns a PivotGroupByContainer.

type PluginStats 

type PluginStats struct {
	Classname            string   `json:"classname"`
	Description          string   `json:"description"`
	ElasticsearchVersion string   `json:"elasticsearch_version"`
	ExtendedPlugins      []string `json:"extended_plugins"`
	HasNativeController  bool     `json:"has_native_controller"`
	JavaVersion          string   `json:"java_version"`
	Licensed             bool     `json:"licensed"`
	Name                 string   `json:"name"`
	Version              string   `json:"version"`
}

PluginStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L183-L193

func NewPluginStats added in v8.5.0 

func NewPluginStats() *PluginStats

NewPluginStats returns a PluginStats.

func (*PluginStats) UnmarshalJSON added in v8.7.1 

func (s *PluginStats) UnmarshalJSON(data []byte) error

type PluginsRecord 

type PluginsRecord struct {
	// Component The component name.
	Component *string `json:"component,omitempty"`
	// Description The plugin details.
	Description *string `json:"description,omitempty"`
	// Id The unique node identifier.
	Id *string `json:"id,omitempty"`
	// Name The node name.
	Name *string `json:"name,omitempty"`
	// Type The plugin type.
	Type *string `json:"type,omitempty"`
	// Version The component version.
	Version *string `json:"version,omitempty"`
}

PluginsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/plugins/types.ts#L22-L52

func NewPluginsRecord added in v8.5.0 

func NewPluginsRecord() *PluginsRecord

NewPluginsRecord returns a PluginsRecord.

func (*PluginsRecord) UnmarshalJSON added in v8.7.1 

func (s *PluginsRecord) UnmarshalJSON(data []byte) error

type PluginsStatus 

type PluginsStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

PluginsStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L60-L62

func NewPluginsStatus added in v8.5.0 

func NewPluginsStatus() *PluginsStatus

NewPluginsStatus returns a PluginsStatus.

type PointInTimeReference 

type PointInTimeReference struct {
	Id        string   `json:"id"`
	KeepAlive Duration `json:"keep_alive,omitempty"`
}

PointInTimeReference type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/PointInTimeReference.ts#L23-L26

func NewPointInTimeReference added in v8.5.0 

func NewPointInTimeReference() *PointInTimeReference

NewPointInTimeReference returns a PointInTimeReference.

func (*PointInTimeReference) UnmarshalJSON added in v8.7.1 

func (s *PointInTimeReference) UnmarshalJSON(data []byte) error

type PointProperty 

type PointProperty struct {
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	IgnoreZValue    *bool                          `json:"ignore_z_value,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *string                                          `json:"null_value,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

PointProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/geo.ts#L67-L72

func NewPointProperty added in v8.5.0 

func NewPointProperty() *PointProperty

NewPointProperty returns a PointProperty.

func (PointProperty) MarshalJSON added in v8.9.0 

func (s PointProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PointProperty) UnmarshalJSON added in v8.7.0 

func (s *PointProperty) UnmarshalJSON(data []byte) error

type Pool 

type Pool struct {
	// MaxInBytes Maximum amount of memory, in bytes, available for use by the heap.
	MaxInBytes *int64 `json:"max_in_bytes,omitempty"`
	// PeakMaxInBytes Largest amount of memory, in bytes, historically used by the heap.
	PeakMaxInBytes *int64 `json:"peak_max_in_bytes,omitempty"`
	// PeakUsedInBytes Largest amount of memory, in bytes, historically used by the heap.
	PeakUsedInBytes *int64 `json:"peak_used_in_bytes,omitempty"`
	// UsedInBytes Memory, in bytes, used by the heap.
	UsedInBytes *int64 `json:"used_in_bytes,omitempty"`
}

Pool type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L949-L966

func NewPool added in v8.5.0 

func NewPool() *Pool

NewPool returns a Pool.

func (*Pool) UnmarshalJSON added in v8.7.1 

func (s *Pool) UnmarshalJSON(data []byte) error

type PorterStemTokenFilter 

type PorterStemTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PorterStemTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L392-L394

func NewPorterStemTokenFilter added in v8.5.0 

func NewPorterStemTokenFilter() *PorterStemTokenFilter

NewPorterStemTokenFilter returns a PorterStemTokenFilter.

func (PorterStemTokenFilter) MarshalJSON added in v8.9.0 

func (s PorterStemTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PorterStemTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *PorterStemTokenFilter) UnmarshalJSON(data []byte) error

type PortugueseAnalyzer added in v8.16.0 

type PortugueseAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

PortugueseAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L241-L246

func NewPortugueseAnalyzer added in v8.16.0 

func NewPortugueseAnalyzer() *PortugueseAnalyzer

NewPortugueseAnalyzer returns a PortugueseAnalyzer.

func (PortugueseAnalyzer) MarshalJSON added in v8.16.0 

func (s PortugueseAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PortugueseAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *PortugueseAnalyzer) UnmarshalJSON(data []byte) error

type PostMigrationFeature added in v8.5.0 

type PostMigrationFeature struct {
	FeatureName string `json:"feature_name"`
}

PostMigrationFeature type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts#L27-L29

func NewPostMigrationFeature added in v8.5.0 

func NewPostMigrationFeature() *PostMigrationFeature

NewPostMigrationFeature returns a PostMigrationFeature.

func (*PostMigrationFeature) UnmarshalJSON added in v8.9.0 

func (s *PostMigrationFeature) UnmarshalJSON(data []byte) error

type PredicateTokenFilter 

type PredicateTokenFilter struct {
	// Script Script containing a condition used to filter incoming tokens. Only tokens
	// that match this script are included in the output.
	Script  Script  `json:"script"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PredicateTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L396-L400

func NewPredicateTokenFilter added in v8.5.0 

func NewPredicateTokenFilter() *PredicateTokenFilter

NewPredicateTokenFilter returns a PredicateTokenFilter.

func (PredicateTokenFilter) MarshalJSON added in v8.9.0 

func (s PredicateTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*PredicateTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *PredicateTokenFilter) UnmarshalJSON(data []byte) error

type PredictedValue 

type PredictedValue []ScalarValue

PredictedValue type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L476-L476

type PrefixQuery 

type PrefixQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// CaseInsensitive Allows ASCII case insensitive matching of the value with the indexed field
	// values when set to `true`.
	// Default is `false` which means the case sensitivity of matching depends on
	// the underlying field’s mapping.
	CaseInsensitive *bool   `json:"case_insensitive,omitempty"`
	QueryName_      *string `json:"_name,omitempty"`
	// Rewrite Method used to rewrite the query.
	Rewrite *string `json:"rewrite,omitempty"`
	// Value Beginning characters of terms you wish to find in the provided field.
	Value string `json:"value"`
}

PrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L98-L120

func NewPrefixQuery added in v8.5.0 

func NewPrefixQuery() *PrefixQuery

NewPrefixQuery returns a PrefixQuery.

func (*PrefixQuery) UnmarshalJSON added in v8.7.1 

func (s *PrefixQuery) UnmarshalJSON(data []byte) error

type Preprocessor 

type Preprocessor struct {
	FrequencyEncoding  *FrequencyEncodingPreprocessor  `json:"frequency_encoding,omitempty"`
	OneHotEncoding     *OneHotEncodingPreprocessor     `json:"one_hot_encoding,omitempty"`
	TargetMeanEncoding *TargetMeanEncodingPreprocessor `json:"target_mean_encoding,omitempty"`
}

Preprocessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L31-L36

func NewPreprocessor added in v8.5.0 

func NewPreprocessor() *Preprocessor

NewPreprocessor returns a Preprocessor.

type PressureMemory 

type PressureMemory struct {
	// All Memory consumed by indexing requests in the coordinating, primary, or replica
	// stage.
	All ByteSize `json:"all,omitempty"`
	// AllInBytes Memory consumed, in bytes, by indexing requests in the coordinating, primary,
	// or replica stage.
	AllInBytes *int64 `json:"all_in_bytes,omitempty"`
	// CombinedCoordinatingAndPrimary Memory consumed by indexing requests in the coordinating or primary stage.
	// This value is not the sum of coordinating and primary as a node can reuse the
	// coordinating memory if the primary stage is executed locally.
	CombinedCoordinatingAndPrimary ByteSize `json:"combined_coordinating_and_primary,omitempty"`
	// CombinedCoordinatingAndPrimaryInBytes Memory consumed, in bytes, by indexing requests in the coordinating or
	// primary stage.
	// This value is not the sum of coordinating and primary as a node can reuse the
	// coordinating memory if the primary stage is executed locally.
	CombinedCoordinatingAndPrimaryInBytes *int64 `json:"combined_coordinating_and_primary_in_bytes,omitempty"`
	// Coordinating Memory consumed by indexing requests in the coordinating stage.
	Coordinating ByteSize `json:"coordinating,omitempty"`
	// CoordinatingInBytes Memory consumed, in bytes, by indexing requests in the coordinating stage.
	CoordinatingInBytes *int64 `json:"coordinating_in_bytes,omitempty"`
	// CoordinatingRejections Number of indexing requests rejected in the coordinating stage.
	CoordinatingRejections *int64 `json:"coordinating_rejections,omitempty"`
	// Primary Memory consumed by indexing requests in the primary stage.
	Primary ByteSize `json:"primary,omitempty"`
	// PrimaryInBytes Memory consumed, in bytes, by indexing requests in the primary stage.
	PrimaryInBytes *int64 `json:"primary_in_bytes,omitempty"`
	// PrimaryRejections Number of indexing requests rejected in the primary stage.
	PrimaryRejections *int64 `json:"primary_rejections,omitempty"`
	// Replica Memory consumed by indexing requests in the replica stage.
	Replica ByteSize `json:"replica,omitempty"`
	// ReplicaInBytes Memory consumed, in bytes, by indexing requests in the replica stage.
	ReplicaInBytes *int64 `json:"replica_in_bytes,omitempty"`
	// ReplicaRejections Number of indexing requests rejected in the replica stage.
	ReplicaRejections *int64 `json:"replica_rejections,omitempty"`
}

PressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L144-L199

func NewPressureMemory added in v8.5.0 

func NewPressureMemory() *PressureMemory

NewPressureMemory returns a PressureMemory.

func (*PressureMemory) UnmarshalJSON added in v8.7.1 

func (s *PressureMemory) UnmarshalJSON(data []byte) error

type Privileges 

type Privileges map[string]bool

Privileges type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges/types.ts#L49-L49

type PrivilegesActions added in v8.5.0 

type PrivilegesActions struct {
	Actions     []string `json:"actions"`
	Application *string  `json:"application,omitempty"`
	Metadata    Metadata `json:"metadata,omitempty"`
	Name        *string  `json:"name,omitempty"`
}

PrivilegesActions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/put_privileges/types.ts#L22-L27

func NewPrivilegesActions added in v8.5.0 

func NewPrivilegesActions() *PrivilegesActions

NewPrivilegesActions returns a PrivilegesActions.

func (*PrivilegesActions) UnmarshalJSON added in v8.7.1 

func (s *PrivilegesActions) UnmarshalJSON(data []byte) error

type PrivilegesCheck 

type PrivilegesCheck struct {
	Application []ApplicationPrivilegesCheck `json:"application,omitempty"`
	// Cluster A list of the cluster privileges that you want to check.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster,omitempty"`
	Index   []IndexPrivilegesCheck              `json:"index,omitempty"`
}

PrivilegesCheck type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges_user_profile/types.ts#L30-L37

func NewPrivilegesCheck added in v8.5.0 

func NewPrivilegesCheck() *PrivilegesCheck

NewPrivilegesCheck returns a PrivilegesCheck.

type Process 

type Process struct {
	// Cpu Contains CPU statistics for the node.
	Cpu *Cpu `json:"cpu,omitempty"`
	// MaxFileDescriptors Maximum number of file descriptors allowed on the system, or `-1` if not
	// supported.
	MaxFileDescriptors *int `json:"max_file_descriptors,omitempty"`
	// Mem Contains virtual memory statistics for the node.
	Mem *MemoryStats `json:"mem,omitempty"`
	// OpenFileDescriptors Number of opened file descriptors associated with the current or `-1` if not
	// supported.
	OpenFileDescriptors *int `json:"open_file_descriptors,omitempty"`
	// Timestamp Last time the statistics were refreshed.
	// Recorded in milliseconds since the Unix Epoch.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

Process type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1024-L1046

func NewProcess added in v8.5.0 

func NewProcess() *Process

NewProcess returns a Process.

func (*Process) UnmarshalJSON added in v8.7.1 

func (s *Process) UnmarshalJSON(data []byte) error

type Processor 

type Processor struct {
	// Count Number of documents transformed by the processor.
	Count *int64 `json:"count,omitempty"`
	// Current Number of documents currently being transformed by the processor.
	Current *int64 `json:"current,omitempty"`
	// Failed Number of failed operations for the processor.
	Failed *int64 `json:"failed,omitempty"`
	// TimeInMillis Time, in milliseconds, spent by the processor transforming documents.
	TimeInMillis *int64 `json:"time_in_millis,omitempty"`
}

Processor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L420-L437

func NewProcessor added in v8.5.0 

func NewProcessor() *Processor

NewProcessor returns a Processor.

func (*Processor) UnmarshalJSON added in v8.7.1 

func (s *Processor) UnmarshalJSON(data []byte) error

type ProcessorContainer 

type ProcessorContainer struct {
	// Append Appends one or more values to an existing array if the field already exists
	// and it is an array.
	// Converts a scalar to an array and appends one or more values to it if the
	// field exists and it is a scalar.
	// Creates an array containing the provided values if the field doesn’t exist.
	// Accepts a single value or an array of values.
	Append *AppendProcessor `json:"append,omitempty"`
	// Attachment The attachment processor lets Elasticsearch extract file attachments in
	// common formats (such as PPT, XLS, and PDF) by using the Apache text
	// extraction library Tika.
	Attachment *AttachmentProcessor `json:"attachment,omitempty"`
	// Bytes Converts a human readable byte value (for example `1kb`) to its value in
	// bytes (for example `1024`).
	// If the field is an array of strings, all members of the array will be
	// converted.
	// Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case
	// insensitive.
	// An error will occur if the field is not a supported format or resultant value
	// exceeds 2^63.
	Bytes *BytesProcessor `json:"bytes,omitempty"`
	// Circle Converts circle definitions of shapes to regular polygons which approximate
	// them.
	Circle *CircleProcessor `json:"circle,omitempty"`
	// CommunityId Computes the Community ID for network flow data as defined in the
	// Community ID Specification. You can use a community ID to correlate network
	// events related to a single flow.
	CommunityId *CommunityIDProcessor `json:"community_id,omitempty"`
	// Convert Converts a field in the currently ingested document to a different type, such
	// as converting a string to an integer.
	// If the field value is an array, all members will be converted.
	Convert *ConvertProcessor `json:"convert,omitempty"`
	// Csv Extracts fields from CSV line out of a single text field within a document.
	// Any empty field in CSV will be skipped.
	Csv *CsvProcessor `json:"csv,omitempty"`
	// Date Parses dates from fields, and then uses the date or timestamp as the
	// timestamp for the document.
	Date *DateProcessor `json:"date,omitempty"`
	// DateIndexName The purpose of this processor is to point documents to the right time based
	// index based on a date or timestamp field in a document by using the date math
	// index name support.
	DateIndexName *DateIndexNameProcessor `json:"date_index_name,omitempty"`
	// Dissect Extracts structured fields out of a single text field by matching the text
	// field against a delimiter-based pattern.
	Dissect *DissectProcessor `json:"dissect,omitempty"`
	// DotExpander Expands a field with dots into an object field.
	// This processor allows fields with dots in the name to be accessible by other
	// processors in the pipeline.
	// Otherwise these fields can’t be accessed by any processor.
	DotExpander *DotExpanderProcessor `json:"dot_expander,omitempty"`
	// Drop Drops the document without raising any errors.
	// This is useful to prevent the document from getting indexed based on some
	// condition.
	Drop *DropProcessor `json:"drop,omitempty"`
	// Enrich The `enrich` processor can enrich documents with data from another index.
	Enrich *EnrichProcessor `json:"enrich,omitempty"`
	// Fail Raises an exception.
	// This is useful for when you expect a pipeline to fail and want to relay a
	// specific message to the requester.
	Fail *FailProcessor `json:"fail,omitempty"`
	// Fingerprint Computes a hash of the document’s content. You can use this hash for
	// content fingerprinting.
	Fingerprint *FingerprintProcessor `json:"fingerprint,omitempty"`
	// Foreach Runs an ingest processor on each element of an array or object.
	Foreach *ForeachProcessor `json:"foreach,omitempty"`
	// GeoGrid Converts geo-grid definitions of grid tiles or cells to regular bounding
	// boxes or polygons which describe their shape.
	// This is useful if there is a need to interact with the tile shapes as
	// spatially indexable fields.
	GeoGrid *GeoGridProcessor `json:"geo_grid,omitempty"`
	// Geoip The `geoip` processor adds information about the geographical location of an
	// IPv4 or IPv6 address.
	Geoip *GeoIpProcessor `json:"geoip,omitempty"`
	// Grok Extracts structured fields out of a single text field within a document.
	// You choose which field to extract matched fields from, as well as the grok
	// pattern you expect will match.
	// A grok pattern is like a regular expression that supports aliased expressions
	// that can be reused.
	Grok *GrokProcessor `json:"grok,omitempty"`
	// Gsub Converts a string field by applying a regular expression and a replacement.
	// If the field is an array of string, all members of the array will be
	// converted.
	// If any non-string values are encountered, the processor will throw an
	// exception.
	Gsub *GsubProcessor `json:"gsub,omitempty"`
	// HtmlStrip Removes HTML tags from the field.
	// If the field is an array of strings, HTML tags will be removed from all
	// members of the array.
	HtmlStrip *HtmlStripProcessor `json:"html_strip,omitempty"`
	// Inference Uses a pre-trained data frame analytics model or a model deployed for natural
	// language processing tasks to infer against the data that is being ingested in
	// the pipeline.
	Inference *InferenceProcessor `json:"inference,omitempty"`
	// IpLocation Currently an undocumented alias for GeoIP Processor.
	IpLocation *IpLocationProcessor `json:"ip_location,omitempty"`
	// Join Joins each element of an array into a single string using a separator
	// character between each element.
	// Throws an error when the field is not an array.
	Join *JoinProcessor `json:"join,omitempty"`
	// Json Converts a JSON string into a structured JSON object.
	Json *JsonProcessor `json:"json,omitempty"`
	// Kv This processor helps automatically parse messages (or specific event fields)
	// which are of the `foo=bar` variety.
	Kv *KeyValueProcessor `json:"kv,omitempty"`
	// Lowercase Converts a string to its lowercase equivalent.
	// If the field is an array of strings, all members of the array will be
	// converted.
	Lowercase *LowercaseProcessor `json:"lowercase,omitempty"`
	// NetworkDirection Calculates the network direction given a source IP address, destination IP
	// address, and a list of internal networks.
	NetworkDirection *NetworkDirectionProcessor `json:"network_direction,omitempty"`
	// Pipeline Executes another pipeline.
	Pipeline *PipelineProcessor `json:"pipeline,omitempty"`
	// Redact The Redact processor uses the Grok rules engine to obscure text in the input
	// document matching the given Grok patterns.
	// The processor can be used to obscure Personal Identifying Information (PII)
	// by configuring it to detect known patterns such as email or IP addresses.
	// Text that matches a Grok pattern is replaced with a configurable string such
	// as `<EMAIL>` where an email address is matched or simply replace all matches
	// with the text `<REDACTED>` if preferred.
	Redact *RedactProcessor `json:"redact,omitempty"`
	// RegisteredDomain Extracts the registered domain (also known as the effective top-level
	// domain or eTLD), sub-domain, and top-level domain from a fully qualified
	// domain name (FQDN). Uses the registered domains defined in the Mozilla
	// Public Suffix List.
	RegisteredDomain *RegisteredDomainProcessor `json:"registered_domain,omitempty"`
	// Remove Removes existing fields.
	// If one field doesn’t exist, an exception will be thrown.
	Remove *RemoveProcessor `json:"remove,omitempty"`
	// Rename Renames an existing field.
	// If the field doesn’t exist or the new name is already used, an exception will
	// be thrown.
	Rename *RenameProcessor `json:"rename,omitempty"`
	// Reroute Routes a document to another target index or data stream.
	// When setting the `destination` option, the target is explicitly specified and
	// the dataset and namespace options can’t be set.
	// When the `destination` option is not set, this processor is in a data stream
	// mode. Note that in this mode, the reroute processor can only be used on data
	// streams that follow the data stream naming scheme.
	Reroute *RerouteProcessor `json:"reroute,omitempty"`
	// Script Runs an inline or stored script on incoming documents.
	// The script runs in the `ingest` context.
	Script *ScriptProcessor `json:"script,omitempty"`
	// Set Adds a field with the specified value.
	// If the field already exists, its value will be replaced with the provided
	// one.
	Set *SetProcessor `json:"set,omitempty"`
	// SetSecurityUser Sets user-related details (such as `username`, `roles`, `email`, `full_name`,
	// `metadata`, `api_key`, `realm` and `authentication_type`) from the current
	// authenticated user to the current document by pre-processing the ingest.
	SetSecurityUser *SetSecurityUserProcessor `json:"set_security_user,omitempty"`
	// Sort Sorts the elements of an array ascending or descending.
	// Homogeneous arrays of numbers will be sorted numerically, while arrays of
	// strings or heterogeneous arrays of strings + numbers will be sorted
	// lexicographically.
	// Throws an error when the field is not an array.
	Sort *SortProcessor `json:"sort,omitempty"`
	// Split Splits a field into an array using a separator character.
	// Only works on string fields.
	Split *SplitProcessor `json:"split,omitempty"`
	// Terminate Terminates the current ingest pipeline, causing no further processors to be
	// run.
	// This will normally be executed conditionally, using the `if` option.
	Terminate *TerminateProcessor `json:"terminate,omitempty"`
	// Trim Trims whitespace from a field.
	// If the field is an array of strings, all members of the array will be
	// trimmed.
	// This only works on leading and trailing whitespace.
	Trim *TrimProcessor `json:"trim,omitempty"`
	// Uppercase Converts a string to its uppercase equivalent.
	// If the field is an array of strings, all members of the array will be
	// converted.
	Uppercase *UppercaseProcessor `json:"uppercase,omitempty"`
	// UriParts Parses a Uniform Resource Identifier (URI) string and extracts its components
	// as an object.
	// This URI object includes properties for the URI’s domain, path, fragment,
	// port, query, scheme, user info, username, and password.
	UriParts *UriPartsProcessor `json:"uri_parts,omitempty"`
	// Urldecode URL-decodes a string.
	// If the field is an array of strings, all members of the array will be
	// decoded.
	Urldecode *UrlDecodeProcessor `json:"urldecode,omitempty"`
	// UserAgent The `user_agent` processor extracts details from the user agent string a
	// browser sends with its web requests.
	// This processor adds this information by default under the `user_agent` field.
	UserAgent *UserAgentProcessor `json:"user_agent,omitempty"`
}

ProcessorContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L27-L301

func NewProcessorContainer added in v8.5.0 

func NewProcessorContainer() *ProcessorContainer

NewProcessorContainer returns a ProcessorContainer.

type Profile 

type Profile struct {
	Shards []ShardProfile `json:"shards"`
}

Profile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L101-L103

func NewProfile added in v8.5.0 

func NewProfile() *Profile

NewProfile returns a Profile.

type Property 

type Property any

Property holds the union for the following types: 

BinaryProperty
BooleanProperty
DynamicProperty
JoinProperty
KeywordProperty
MatchOnlyTextProperty
PercolatorProperty
RankFeatureProperty
RankFeaturesProperty
SearchAsYouTypeProperty
TextProperty
VersionProperty
WildcardProperty
DateNanosProperty
DateProperty
AggregateMetricDoubleProperty
DenseVectorProperty
FlattenedProperty
NestedProperty
ObjectProperty
PassthroughObjectProperty
SemanticTextProperty
SparseVectorProperty
CompletionProperty
ConstantKeywordProperty
CountedKeywordProperty
FieldAliasProperty
HistogramProperty
IpProperty
Murmur3HashProperty
TokenCountProperty
GeoPointProperty
GeoShapeProperty
PointProperty
ShapeProperty
ByteNumberProperty
DoubleNumberProperty
FloatNumberProperty
HalfFloatNumberProperty
IntegerNumberProperty
LongNumberProperty
ScaledFloatNumberProperty
ShortNumberProperty
UnsignedLongNumberProperty
DateRangeProperty
DoubleRangeProperty
FloatRangeProperty
IntegerRangeProperty
IpRangeProperty
LongRangeProperty
IcuCollationProperty

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/Property.ts#L119-L189

type PublishedClusterStates 

type PublishedClusterStates struct {
	// CompatibleDiffs Number of compatible differences between published cluster states.
	CompatibleDiffs *int64 `json:"compatible_diffs,omitempty"`
	// FullStates Number of published cluster states.
	FullStates *int64 `json:"full_states,omitempty"`
	// IncompatibleDiffs Number of incompatible differences between published cluster states.
	IncompatibleDiffs *int64 `json:"incompatible_diffs,omitempty"`
}

PublishedClusterStates type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L263-L276

func NewPublishedClusterStates added in v8.5.0 

func NewPublishedClusterStates() *PublishedClusterStates

NewPublishedClusterStates returns a PublishedClusterStates.

func (*PublishedClusterStates) UnmarshalJSON added in v8.7.1 

func (s *PublishedClusterStates) UnmarshalJSON(data []byte) error

type Queries 

type Queries struct {
	Cache *CacheQueries `json:"cache,omitempty"`
}

Queries type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L417-L419

func NewQueries added in v8.5.0 

func NewQueries() *Queries

NewQueries returns a Queries.

type Query 

type Query struct {
	// Bool matches documents matching boolean combinations of other queries.
	Bool *BoolQuery `json:"bool,omitempty"`
	// Boosting Returns documents matching a `positive` query while reducing the relevance
	// score of documents that also match a `negative` query.
	Boosting *BoostingQuery `json:"boosting,omitempty"`
	// CombinedFields The `combined_fields` query supports searching multiple text fields as if
	// their contents had been indexed into one combined field.
	CombinedFields *CombinedFieldsQuery        `json:"combined_fields,omitempty"`
	Common         map[string]CommonTermsQuery `json:"common,omitempty"`
	// ConstantScore Wraps a filter query and returns every matching document with a relevance
	// score equal to the `boost` parameter value.
	ConstantScore *ConstantScoreQuery `json:"constant_score,omitempty"`
	// DisMax Returns documents matching one or more wrapped queries, called query clauses
	// or clauses.
	// If a returned document matches multiple query clauses, the `dis_max` query
	// assigns the document the highest relevance score from any matching clause,
	// plus a tie breaking increment for any additional matching subqueries.
	DisMax *DisMaxQuery `json:"dis_max,omitempty"`
	// DistanceFeature Boosts the relevance score of documents closer to a provided origin date or
	// point.
	// For example, you can use this query to give more weight to documents closer
	// to a certain date or location.
	DistanceFeature DistanceFeatureQuery `json:"distance_feature,omitempty"`
	// Exists Returns documents that contain an indexed value for a field.
	Exists *ExistsQuery `json:"exists,omitempty"`
	// FunctionScore The `function_score` enables you to modify the score of documents that are
	// retrieved by a query.
	FunctionScore *FunctionScoreQuery `json:"function_score,omitempty"`
	// Fuzzy Returns documents that contain terms similar to the search term, as measured
	// by a Levenshtein edit distance.
	Fuzzy map[string]FuzzyQuery `json:"fuzzy,omitempty"`
	// GeoBoundingBox Matches geo_point and geo_shape values that intersect a bounding box.
	GeoBoundingBox *GeoBoundingBoxQuery `json:"geo_bounding_box,omitempty"`
	// GeoDistance Matches `geo_point` and `geo_shape` values within a given distance of a
	// geopoint.
	GeoDistance *GeoDistanceQuery `json:"geo_distance,omitempty"`
	// GeoGrid Matches `geo_point` and `geo_shape` values that intersect a grid cell from a
	// GeoGrid aggregation.
	GeoGrid    map[string]GeoGridQuery `json:"geo_grid,omitempty"`
	GeoPolygon *GeoPolygonQuery        `json:"geo_polygon,omitempty"`
	// GeoShape Filter documents indexed using either the `geo_shape` or the `geo_point`
	// type.
	GeoShape *GeoShapeQuery `json:"geo_shape,omitempty"`
	// HasChild Returns parent documents whose joined child documents match a provided query.
	HasChild *HasChildQuery `json:"has_child,omitempty"`
	// HasParent Returns child documents whose joined parent document matches a provided
	// query.
	HasParent *HasParentQuery `json:"has_parent,omitempty"`
	// Ids Returns documents based on their IDs.
	// This query uses document IDs stored in the `_id` field.
	Ids *IdsQuery `json:"ids,omitempty"`
	// Intervals Returns documents based on the order and proximity of matching terms.
	Intervals map[string]IntervalsQuery `json:"intervals,omitempty"`
	// Knn Finds the k nearest vectors to a query vector, as measured by a similarity
	// metric. knn query finds nearest vectors through approximate search on indexed
	// dense_vectors.
	Knn *KnnQuery `json:"knn,omitempty"`
	// Match Returns documents that match a provided text, number, date or boolean value.
	// The provided text is analyzed before matching.
	Match map[string]MatchQuery `json:"match,omitempty"`
	// MatchAll Matches all documents, giving them all a `_score` of 1.0.
	MatchAll *MatchAllQuery `json:"match_all,omitempty"`
	// MatchBoolPrefix Analyzes its input and constructs a `bool` query from the terms.
	// Each term except the last is used in a `term` query.
	// The last term is used in a prefix query.
	MatchBoolPrefix map[string]MatchBoolPrefixQuery `json:"match_bool_prefix,omitempty"`
	// MatchNone Matches no documents.
	MatchNone *MatchNoneQuery `json:"match_none,omitempty"`
	// MatchPhrase Analyzes the text and creates a phrase query out of the analyzed text.
	MatchPhrase map[string]MatchPhraseQuery `json:"match_phrase,omitempty"`
	// MatchPhrasePrefix Returns documents that contain the words of a provided text, in the same
	// order as provided.
	// The last term of the provided text is treated as a prefix, matching any words
	// that begin with that term.
	MatchPhrasePrefix map[string]MatchPhrasePrefixQuery `json:"match_phrase_prefix,omitempty"`
	// MoreLikeThis Returns documents that are "like" a given set of documents.
	MoreLikeThis *MoreLikeThisQuery `json:"more_like_this,omitempty"`
	// MultiMatch Enables you to search for a provided text, number, date or boolean value
	// across multiple fields.
	// The provided text is analyzed before matching.
	MultiMatch *MultiMatchQuery `json:"multi_match,omitempty"`
	// Nested Wraps another query to search nested fields.
	// If an object matches the search, the nested query returns the root parent
	// document.
	Nested *NestedQuery `json:"nested,omitempty"`
	// ParentId Returns child documents joined to a specific parent document.
	ParentId *ParentIdQuery `json:"parent_id,omitempty"`
	// Percolate Matches queries stored in an index.
	Percolate *PercolateQuery `json:"percolate,omitempty"`
	// Pinned Promotes selected documents to rank higher than those matching a given query.
	Pinned *PinnedQuery `json:"pinned,omitempty"`
	// Prefix Returns documents that contain a specific prefix in a provided field.
	Prefix map[string]PrefixQuery `json:"prefix,omitempty"`
	// QueryString Returns documents based on a provided query string, using a parser with a
	// strict syntax.
	QueryString *QueryStringQuery `json:"query_string,omitempty"`
	// Range Returns documents that contain terms within a provided range.
	Range map[string]RangeQuery `json:"range,omitempty"`
	// RankFeature Boosts the relevance score of documents based on the numeric value of a
	// `rank_feature` or `rank_features` field.
	RankFeature *RankFeatureQuery `json:"rank_feature,omitempty"`
	// Regexp Returns documents that contain terms matching a regular expression.
	Regexp map[string]RegexpQuery `json:"regexp,omitempty"`
	Rule   *RuleQuery             `json:"rule,omitempty"`
	// Script Filters documents based on a provided script.
	// The script query is typically used in a filter context.
	Script *ScriptQuery `json:"script,omitempty"`
	// ScriptScore Uses a script to provide a custom score for returned documents.
	ScriptScore *ScriptScoreQuery `json:"script_score,omitempty"`
	// Semantic A semantic query to semantic_text field types
	Semantic *SemanticQuery `json:"semantic,omitempty"`
	// Shape Queries documents that contain fields indexed using the `shape` type.
	Shape *ShapeQuery `json:"shape,omitempty"`
	// SimpleQueryString Returns documents based on a provided query string, using a parser with a
	// limited but fault-tolerant syntax.
	SimpleQueryString *SimpleQueryStringQuery `json:"simple_query_string,omitempty"`
	// SpanContaining Returns matches which enclose another span query.
	SpanContaining *SpanContainingQuery `json:"span_containing,omitempty"`
	// SpanFieldMasking Wrapper to allow span queries to participate in composite single-field span
	// queries by _lying_ about their search field.
	SpanFieldMasking *SpanFieldMaskingQuery `json:"span_field_masking,omitempty"`
	// SpanFirst Matches spans near the beginning of a field.
	SpanFirst *SpanFirstQuery `json:"span_first,omitempty"`
	// SpanMulti Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`,
	// `range`, or `regexp` query) as a `span` query, so it can be nested.
	SpanMulti *SpanMultiTermQuery `json:"span_multi,omitempty"`
	// SpanNear Matches spans which are near one another.
	// You can specify `slop`, the maximum number of intervening unmatched
	// positions, as well as whether matches are required to be in-order.
	SpanNear *SpanNearQuery `json:"span_near,omitempty"`
	// SpanNot Removes matches which overlap with another span query or which are within x
	// tokens before (controlled by the parameter `pre`) or y tokens after
	// (controlled by the parameter `post`) another span query.
	SpanNot *SpanNotQuery `json:"span_not,omitempty"`
	// SpanOr Matches the union of its span clauses.
	SpanOr *SpanOrQuery `json:"span_or,omitempty"`
	// SpanTerm Matches spans containing a term.
	SpanTerm map[string]SpanTermQuery `json:"span_term,omitempty"`
	// SpanWithin Returns matches which are enclosed inside another span query.
	SpanWithin *SpanWithinQuery `json:"span_within,omitempty"`
	// SparseVector Using input query vectors or a natural language processing model to convert a
	// query into a list of token-weight pairs, queries against a sparse vector
	// field.
	SparseVector *SparseVectorQuery `json:"sparse_vector,omitempty"`
	// Term Returns documents that contain an exact term in a provided field.
	// To return a document, the query term must exactly match the queried field's
	// value, including whitespace and capitalization.
	Term map[string]TermQuery `json:"term,omitempty"`
	// Terms Returns documents that contain one or more exact terms in a provided field.
	// To return a document, one or more terms must exactly match a field value,
	// including whitespace and capitalization.
	Terms *TermsQuery `json:"terms,omitempty"`
	// TermsSet Returns documents that contain a minimum number of exact terms in a provided
	// field.
	// To return a document, a required number of terms must exactly match the field
	// values, including whitespace and capitalization.
	TermsSet map[string]TermsSetQuery `json:"terms_set,omitempty"`
	// TextExpansion Uses a natural language processing model to convert the query text into a
	// list of token-weight pairs which are then used in a query against a sparse
	// vector or rank features field.
	TextExpansion map[string]TextExpansionQuery `json:"text_expansion,omitempty"`
	Type          *TypeQuery                    `json:"type,omitempty"`
	// WeightedTokens Supports returning text_expansion query results by sending in precomputed
	// tokens with the query.
	WeightedTokens map[string]WeightedTokensQuery `json:"weighted_tokens,omitempty"`
	// Wildcard Returns documents that contain terms matching a wildcard pattern.
	Wildcard map[string]WildcardQuery `json:"wildcard,omitempty"`
	// Wrapper A query that accepts any other query as base64 encoded string.
	Wrapper *WrapperQuery `json:"wrapper,omitempty"`
}

Query type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/abstractions.ts#L103-L434

func NewQuery added in v8.5.0 

func NewQuery() *Query

NewQuery returns a Query.

func (*Query) UnmarshalJSON added in v8.7.1 

func (s *Query) UnmarshalJSON(data []byte) error

type QueryBreakdown 

type QueryBreakdown struct {
	Advance                     int64 `json:"advance"`
	AdvanceCount                int64 `json:"advance_count"`
	BuildScorer                 int64 `json:"build_scorer"`
	BuildScorerCount            int64 `json:"build_scorer_count"`
	ComputeMaxScore             int64 `json:"compute_max_score"`
	ComputeMaxScoreCount        int64 `json:"compute_max_score_count"`
	CountWeight                 int64 `json:"count_weight"`
	CountWeightCount            int64 `json:"count_weight_count"`
	CreateWeight                int64 `json:"create_weight"`
	CreateWeightCount           int64 `json:"create_weight_count"`
	Match                       int64 `json:"match"`
	MatchCount                  int64 `json:"match_count"`
	NextDoc                     int64 `json:"next_doc"`
	NextDocCount                int64 `json:"next_doc_count"`
	Score                       int64 `json:"score"`
	ScoreCount                  int64 `json:"score_count"`
	SetMinCompetitiveScore      int64 `json:"set_min_competitive_score"`
	SetMinCompetitiveScoreCount int64 `json:"set_min_competitive_score_count"`
	ShallowAdvance              int64 `json:"shallow_advance"`
	ShallowAdvanceCount         int64 `json:"shallow_advance_count"`
}

QueryBreakdown type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L105-L126

func NewQueryBreakdown added in v8.5.0 

func NewQueryBreakdown() *QueryBreakdown

NewQueryBreakdown returns a QueryBreakdown.

func (*QueryBreakdown) UnmarshalJSON added in v8.7.1 

func (s *QueryBreakdown) UnmarshalJSON(data []byte) error

type QueryCacheStats 

type QueryCacheStats struct {
	// CacheCount Total number of entries added to the query cache across all shards assigned
	// to selected nodes.
	// This number includes current and evicted entries.
	CacheCount int64 `json:"cache_count"`
	// CacheSize Total number of entries currently in the query cache across all shards
	// assigned to selected nodes.
	CacheSize int64 `json:"cache_size"`
	// Evictions Total number of query cache evictions across all shards assigned to selected
	// nodes.
	Evictions int64 `json:"evictions"`
	// HitCount Total count of query cache hits across all shards assigned to selected nodes.
	HitCount int64 `json:"hit_count"`
	// MemorySize Total amount of memory used for the query cache across all shards assigned to
	// selected nodes.
	MemorySize ByteSize `json:"memory_size,omitempty"`
	// MemorySizeInBytes Total amount, in bytes, of memory used for the query cache across all shards
	// assigned to selected nodes.
	MemorySizeInBytes int64 `json:"memory_size_in_bytes"`
	// MissCount Total count of query cache misses across all shards assigned to selected
	// nodes.
	MissCount int64 `json:"miss_count"`
	// TotalCount Total count of hits and misses in the query cache across all shards assigned
	// to selected nodes.
	TotalCount int64 `json:"total_count"`
}

QueryCacheStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L195-L229

func NewQueryCacheStats added in v8.5.0 

func NewQueryCacheStats() *QueryCacheStats

NewQueryCacheStats returns a QueryCacheStats.

func (*QueryCacheStats) UnmarshalJSON added in v8.7.1 

func (s *QueryCacheStats) UnmarshalJSON(data []byte) error

type QueryFeatureExtractor added in v8.18.0 

type QueryFeatureExtractor struct {
	DefaultScore *float32 `json:"default_score,omitempty"`
	FeatureName  string   `json:"feature_name"`
	Query        Query    `json:"query"`
}

QueryFeatureExtractor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L98-L105

func NewQueryFeatureExtractor added in v8.18.0 

func NewQueryFeatureExtractor() *QueryFeatureExtractor

NewQueryFeatureExtractor returns a QueryFeatureExtractor.

func (*QueryFeatureExtractor) UnmarshalJSON added in v8.18.0 

func (s *QueryFeatureExtractor) UnmarshalJSON(data []byte) error

type QueryProfile 

type QueryProfile struct {
	Breakdown   QueryBreakdown `json:"breakdown"`
	Children    []QueryProfile `json:"children,omitempty"`
	Description string         `json:"description"`
	TimeInNanos int64          `json:"time_in_nanos"`
	Type        string         `json:"type"`
}

QueryProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L128-L134

func NewQueryProfile added in v8.5.0 

func NewQueryProfile() *QueryProfile

NewQueryProfile returns a QueryProfile.

func (*QueryProfile) UnmarshalJSON added in v8.7.1 

func (s *QueryProfile) UnmarshalJSON(data []byte) error

type QueryRole added in v8.15.0 

type QueryRole struct {
	// Applications A list of application privilege entries
	Applications []ApplicationPrivileges `json:"applications,omitempty"`
	// Cluster A list of cluster privileges. These privileges define the cluster level
	// actions that API keys are able to execute.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster,omitempty"`
	// Description Optional description of the role descriptor
	Description *string `json:"description,omitempty"`
	// Global An object defining global privileges. A global privilege is a form of cluster
	// privilege that is request-aware. Support for global privileges is currently
	// limited to the management of application privileges.
	Global []GlobalPrivilege `json:"global,omitempty"`
	// Indices A list of indices permissions entries.
	Indices []IndicesPrivileges `json:"indices,omitempty"`
	// Metadata Optional meta-data. Within the metadata object, keys that begin with `_` are
	// reserved for system usage.
	Metadata Metadata `json:"metadata,omitempty"`
	// Name Name of the role.
	Name string `json:"name"`
	// RemoteCluster A list of cluster permissions for remote clusters.
	// NOTE: This is limited a subset of the cluster permissions.
	RemoteCluster []RemoteClusterPrivileges `json:"remote_cluster,omitempty"`
	// RemoteIndices A list of indices permissions for remote clusters.
	RemoteIndices []RemoteIndicesPrivileges `json:"remote_indices,omitempty"`
	// Restriction Restriction for when the role descriptor is allowed to be effective.
	Restriction *Restriction `json:"restriction,omitempty"`
	// RunAs A list of users that the API keys can impersonate.
	// NOTE: In Elastic Cloud Serverless, the run-as feature is disabled.
	// For API compatibility, you can still specify an empty `run_as` field, but a
	// non-empty list will be rejected.
	RunAs             []string                   `json:"run_as,omitempty"`
	Sort_             []FieldValue               `json:"_sort,omitempty"`
	TransientMetadata map[string]json.RawMessage `json:"transient_metadata,omitempty"`
}

QueryRole type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_role/types.ts#L103-L109

func NewQueryRole added in v8.15.0 

func NewQueryRole() *QueryRole

NewQueryRole returns a QueryRole.

func (*QueryRole) UnmarshalJSON added in v8.15.0 

func (s *QueryRole) UnmarshalJSON(data []byte) error

type QueryRule added in v8.10.0 

type QueryRule struct {
	// Actions The actions to take when the rule is matched.
	// The format of this action depends on the rule type.
	Actions QueryRuleActions `json:"actions"`
	// Criteria The criteria that must be met for the rule to be applied.
	// If multiple criteria are specified for a rule, all criteria must be met for
	// the rule to be applied.
	Criteria []QueryRuleCriteria `json:"criteria"`
	Priority *int                `json:"priority,omitempty"`
	// RuleId A unique identifier for the rule.
	RuleId string `json:"rule_id"`
	// Type The type of rule.
	// `pinned` will identify and pin specific documents to the top of search
	// results.
	// `exclude` will exclude specific documents from search results.
	Type queryruletype.QueryRuleType `json:"type"`
}

QueryRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/_types/QueryRuleset.ts#L36-L58

func NewQueryRule added in v8.10.0 

func NewQueryRule() *QueryRule

NewQueryRule returns a QueryRule.

func (*QueryRule) UnmarshalJSON added in v8.10.0 

func (s *QueryRule) UnmarshalJSON(data []byte) error

type QueryRuleActions added in v8.10.0 

type QueryRuleActions struct {
	// Docs The documents to apply the rule to.
	// Only one of `ids` or `docs` may be specified and at least one must be
	// specified.
	// There is a maximum value of 100 documents in a rule.
	// You can specify the following attributes for each document:
	//
	// * `_index`: The index of the document to pin.
	// * `_id`: The unique document ID.
	Docs []PinnedDoc `json:"docs,omitempty"`
	// Ids The unique document IDs of the documents to apply the rule to.
	// Only one of `ids` or `docs` may be specified and at least one must be
	// specified.
	Ids []string `json:"ids,omitempty"`
}

QueryRuleActions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/_types/QueryRuleset.ts#L110-L126

func NewQueryRuleActions added in v8.10.0 

func NewQueryRuleActions() *QueryRuleActions

NewQueryRuleActions returns a QueryRuleActions.

type QueryRuleCriteria added in v8.10.0 

type QueryRuleCriteria struct {
	// Metadata The metadata field to match against.
	// This metadata will be used to match against `match_criteria` sent in the
	// rule.
	// It is required for all criteria types except `always`.
	Metadata *string `json:"metadata,omitempty"`
	// Type The type of criteria. The following criteria types are supported:
	//
	// * `always`: Matches all queries, regardless of input.
	// * `contains`: Matches that contain this value anywhere in the field meet the
	// criteria defined by the rule. Only applicable for string values.
	// * `exact`: Only exact matches meet the criteria defined by the rule.
	// Applicable for string or numerical values.
	// * `fuzzy`: Exact matches or matches within the allowed Levenshtein Edit
	// Distance meet the criteria defined by the rule. Only applicable for string
	// values.
	// * `gt`: Matches with a value greater than this value meet the criteria
	// defined by the rule. Only applicable for numerical values.
	// * `gte`: Matches with a value greater than or equal to this value meet the
	// criteria defined by the rule. Only applicable for numerical values.
	// * `lt`: Matches with a value less than this value meet the criteria defined
	// by the rule. Only applicable for numerical values.
	// * `lte`: Matches with a value less than or equal to this value meet the
	// criteria defined by the rule. Only applicable for numerical values.
	// * `prefix`: Matches that start with this value meet the criteria defined by
	// the rule. Only applicable for string values.
	// * `suffix`: Matches that end with this value meet the criteria defined by the
	// rule. Only applicable for string values.
	Type queryrulecriteriatype.QueryRuleCriteriaType `json:"type"`
	// Values The values to match against the `metadata` field.
	// Only one value must match for the criteria to be met.
	// It is required for all criteria types except `always`.
	Values []json.RawMessage `json:"values,omitempty"`
}

QueryRuleCriteria type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/_types/QueryRuleset.ts#L65-L93

func NewQueryRuleCriteria added in v8.10.0 

func NewQueryRuleCriteria() *QueryRuleCriteria

NewQueryRuleCriteria returns a QueryRuleCriteria.

func (*QueryRuleCriteria) UnmarshalJSON added in v8.10.0 

func (s *QueryRuleCriteria) UnmarshalJSON(data []byte) error

type QueryRuleset added in v8.10.0 

type QueryRuleset struct {
	// Rules Rules associated with the query ruleset.
	Rules []QueryRule `json:"rules"`
	// RulesetId A unique identifier for the ruleset.
	RulesetId string `json:"ruleset_id"`
}

QueryRuleset type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/_types/QueryRuleset.ts#L25-L34

func NewQueryRuleset added in v8.10.0 

func NewQueryRuleset() *QueryRuleset

NewQueryRuleset returns a QueryRuleset.

func (*QueryRuleset) UnmarshalJSON added in v8.10.0 

func (s *QueryRuleset) UnmarshalJSON(data []byte) error

type QueryRulesetListItem added in v8.10.0 

type QueryRulesetListItem struct {
	// RuleCriteriaTypesCounts A map of criteria type (for example, `exact`) to the number of rules of that
	// type.
	//
	// NOTE: The counts in `rule_criteria_types_counts` may be larger than the value
	// of `rule_total_count` because a rule may have multiple criteria.
	RuleCriteriaTypesCounts map[string]int `json:"rule_criteria_types_counts"`
	// RuleTotalCount The number of rules associated with the ruleset.
	RuleTotalCount int `json:"rule_total_count"`
	// RuleTypeCounts A map of rule type (for example, `pinned`) to the number of rules of that
	// type.
	RuleTypeCounts map[string]int `json:"rule_type_counts"`
	// RulesetId A unique identifier for the ruleset.
	RulesetId string `json:"ruleset_id"`
}

QueryRulesetListItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/list_rulesets/types.ts#L23-L44

func NewQueryRulesetListItem added in v8.10.0 

func NewQueryRulesetListItem() *QueryRulesetListItem

NewQueryRulesetListItem returns a QueryRulesetListItem.

func (*QueryRulesetListItem) UnmarshalJSON added in v8.10.0 

func (s *QueryRulesetListItem) UnmarshalJSON(data []byte) error

type QueryRulesetMatchedRule added in v8.16.0 

type QueryRulesetMatchedRule struct {
	// RuleId Rule unique identifier within that ruleset
	RuleId string `json:"rule_id"`
	// RulesetId Ruleset unique identifier
	RulesetId string `json:"ruleset_id"`
}

QueryRulesetMatchedRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/query_rules/test/QueryRulesetTestResponse.ts#L30-L39

func NewQueryRulesetMatchedRule added in v8.16.0 

func NewQueryRulesetMatchedRule() *QueryRulesetMatchedRule

NewQueryRulesetMatchedRule returns a QueryRulesetMatchedRule.

func (*QueryRulesetMatchedRule) UnmarshalJSON added in v8.16.0 

func (s *QueryRulesetMatchedRule) UnmarshalJSON(data []byte) error

type QueryStringQuery 

type QueryStringQuery struct {
	// AllowLeadingWildcard If `true`, the wildcard characters `*` and `?` are allowed as the first
	// character of the query string.
	AllowLeadingWildcard *bool `json:"allow_leading_wildcard,omitempty"`
	// AnalyzeWildcard If `true`, the query attempts to analyze wildcard terms in the query string.
	AnalyzeWildcard *bool `json:"analyze_wildcard,omitempty"`
	// Analyzer Analyzer used to convert text in the query string into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// AutoGenerateSynonymsPhraseQuery If `true`, match phrase queries are automatically created for multi-term
	// synonyms.
	AutoGenerateSynonymsPhraseQuery *bool `json:"auto_generate_synonyms_phrase_query,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// DefaultField Default field to search if no field is provided in the query string.
	// Supports wildcards (`*`).
	// Defaults to the `index.query.default_field` index setting, which has a
	// default value of `*`.
	DefaultField *string `json:"default_field,omitempty"`
	// DefaultOperator Default boolean logic used to interpret text in the query string if no
	// operators are specified.
	DefaultOperator *operator.Operator `json:"default_operator,omitempty"`
	// EnablePositionIncrements If `true`, enable position increments in queries constructed from a
	// `query_string` search.
	EnablePositionIncrements *bool `json:"enable_position_increments,omitempty"`
	Escape                   *bool `json:"escape,omitempty"`
	// Fields Array of fields to search. Supports wildcards (`*`).
	Fields []string `json:"fields,omitempty"`
	// Fuzziness Maximum edit distance allowed for fuzzy matching.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// FuzzyMaxExpansions Maximum number of terms to which the query expands for fuzzy matching.
	FuzzyMaxExpansions *int `json:"fuzzy_max_expansions,omitempty"`
	// FuzzyPrefixLength Number of beginning characters left unchanged for fuzzy matching.
	FuzzyPrefixLength *int `json:"fuzzy_prefix_length,omitempty"`
	// FuzzyRewrite Method used to rewrite the query.
	FuzzyRewrite *string `json:"fuzzy_rewrite,omitempty"`
	// FuzzyTranspositions If `true`, edits for fuzzy matching include transpositions of two adjacent
	// characters (for example, `ab` to `ba`).
	FuzzyTranspositions *bool `json:"fuzzy_transpositions,omitempty"`
	// Lenient If `true`, format-based errors, such as providing a text value for a numeric
	// field, are ignored.
	Lenient *bool `json:"lenient,omitempty"`
	// MaxDeterminizedStates Maximum number of automaton states required for the query.
	MaxDeterminizedStates *int `json:"max_determinized_states,omitempty"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// PhraseSlop Maximum number of positions allowed between matching tokens for phrases.
	PhraseSlop *Float64 `json:"phrase_slop,omitempty"`
	// Query Query string you wish to parse and use for search.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// QuoteAnalyzer Analyzer used to convert quoted text in the query string into tokens.
	// For quoted text, this parameter overrides the analyzer specified in the
	// `analyzer` parameter.
	QuoteAnalyzer *string `json:"quote_analyzer,omitempty"`
	// QuoteFieldSuffix Suffix appended to quoted text in the query string.
	// You can use this suffix to use a different analysis method for exact matches.
	QuoteFieldSuffix *string `json:"quote_field_suffix,omitempty"`
	// Rewrite Method used to rewrite the query.
	Rewrite *string `json:"rewrite,omitempty"`
	// TieBreaker How to combine the queries generated from the individual search terms in the
	// resulting `dis_max` query.
	TieBreaker *Float64 `json:"tie_breaker,omitempty"`
	// TimeZone Coordinated Universal Time (UTC) offset or IANA time zone used to convert
	// date values in the query string to UTC.
	TimeZone *string `json:"time_zone,omitempty"`
	// Type Determines how the query matches and scores documents.
	Type *textquerytype.TextQueryType `json:"type,omitempty"`
}

QueryStringQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L649-L772

func NewQueryStringQuery added in v8.5.0 

func NewQueryStringQuery() *QueryStringQuery

NewQueryStringQuery returns a QueryStringQuery.

func (*QueryStringQuery) UnmarshalJSON added in v8.7.1 

func (s *QueryStringQuery) UnmarshalJSON(data []byte) error

type QueryUser added in v8.15.0 

type QueryUser struct {
	Email      *string      `json:"email,omitempty"`
	Enabled    bool         `json:"enabled"`
	FullName   *string      `json:"full_name,omitempty"`
	Metadata   Metadata     `json:"metadata"`
	ProfileUid *string      `json:"profile_uid,omitempty"`
	Roles      []string     `json:"roles"`
	Sort_      []FieldValue `json:"_sort,omitempty"`
	Username   string       `json:"username"`
}

QueryUser type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_user/types.ts#L103-L105

func NewQueryUser added in v8.15.0 

func NewQueryUser() *QueryUser

NewQueryUser returns a QueryUser.

func (*QueryUser) UnmarshalJSON added in v8.15.0 

func (s *QueryUser) UnmarshalJSON(data []byte) error

type QueryVectorBuilder 

type QueryVectorBuilder struct {
	TextEmbedding *TextEmbedding `json:"text_embedding,omitempty"`
}

QueryVectorBuilder type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Knn.ts#L89-L92

func NewQueryVectorBuilder 

func NewQueryVectorBuilder() *QueryVectorBuilder

NewQueryVectorBuilder returns a QueryVectorBuilder.

type QueryWatch 

type QueryWatch struct {
	Id_          string       `json:"_id"`
	PrimaryTerm_ *int         `json:"_primary_term,omitempty"`
	SeqNo_       *int64       `json:"_seq_no,omitempty"`
	Status       *WatchStatus `json:"status,omitempty"`
	Watch        *Watch       `json:"watch,omitempty"`
}

QueryWatch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Watch.ts#L58-L64

func NewQueryWatch added in v8.5.0 

func NewQueryWatch() *QueryWatch

NewQueryWatch returns a QueryWatch.

func (*QueryWatch) UnmarshalJSON added in v8.7.1 

func (s *QueryWatch) UnmarshalJSON(data []byte) error

type QuestionAnsweringInferenceOptions 

type QuestionAnsweringInferenceOptions struct {
	// MaxAnswerLength The maximum answer length to consider
	MaxAnswerLength *int `json:"max_answer_length,omitempty"`
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
}

QuestionAnsweringInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L301-L311

func NewQuestionAnsweringInferenceOptions added in v8.5.0 

func NewQuestionAnsweringInferenceOptions() *QuestionAnsweringInferenceOptions

NewQuestionAnsweringInferenceOptions returns a QuestionAnsweringInferenceOptions.

func (*QuestionAnsweringInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *QuestionAnsweringInferenceOptions) UnmarshalJSON(data []byte) error

type QuestionAnsweringInferenceUpdateOptions 

type QuestionAnsweringInferenceUpdateOptions struct {
	// MaxAnswerLength The maximum answer length to consider for extraction
	MaxAnswerLength *int `json:"max_answer_length,omitempty"`
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// Question The question to answer given the inference context
	Question string `json:"question"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

QuestionAnsweringInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L439-L450

func NewQuestionAnsweringInferenceUpdateOptions added in v8.5.0 

func NewQuestionAnsweringInferenceUpdateOptions() *QuestionAnsweringInferenceUpdateOptions

NewQuestionAnsweringInferenceUpdateOptions returns a QuestionAnsweringInferenceUpdateOptions.

func (*QuestionAnsweringInferenceUpdateOptions) UnmarshalJSON added in v8.7.1 

func (s *QuestionAnsweringInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type RRFRetriever added in v8.14.0 

type RRFRetriever struct {
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_ *string `json:"_name,omitempty"`
	// RankConstant This value determines how much influence documents in individual result sets
	// per query have over the final ranked result set.
	RankConstant *int `json:"rank_constant,omitempty"`
	// RankWindowSize This value determines the size of the individual result sets per query.
	RankWindowSize *int `json:"rank_window_size,omitempty"`
	// Retrievers A list of child retrievers to specify which sets of returned top documents
	// will have the RRF formula applied to them.
	Retrievers []RetrieverContainer `json:"retrievers"`
}

RRFRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L131-L138

func NewRRFRetriever added in v8.14.0 

func NewRRFRetriever() *RRFRetriever

NewRRFRetriever returns a RRFRetriever.

func (*RRFRetriever) UnmarshalJSON added in v8.14.0 

func (s *RRFRetriever) UnmarshalJSON(data []byte) error

type RandomSamplerAggregation added in v8.16.0 

type RandomSamplerAggregation struct {
	// Probability The probability that a document will be included in the aggregated data.
	// Must be greater than 0, less than 0.5, or exactly 1.
	// The lower the probability, the fewer documents are matched.
	Probability Float64 `json:"probability"`
	// Seed The seed to generate the random sampling of documents.
	// When a seed is provided, the random subset of documents is the same between
	// calls.
	Seed *int `json:"seed,omitempty"`
	// ShardSeed When combined with seed, setting shard_seed ensures 100% consistent sampling
	// over shards where data is exactly the same.
	ShardSeed *int `json:"shard_seed,omitempty"`
}

RandomSamplerAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L749-L769

func NewRandomSamplerAggregation added in v8.16.0 

func NewRandomSamplerAggregation() *RandomSamplerAggregation

NewRandomSamplerAggregation returns a RandomSamplerAggregation.

func (*RandomSamplerAggregation) UnmarshalJSON added in v8.16.0 

func (s *RandomSamplerAggregation) UnmarshalJSON(data []byte) error

type RandomScoreFunction 

type RandomScoreFunction struct {
	Field *string `json:"field,omitempty"`
	Seed  string  `json:"seed,omitempty"`
}

RandomScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L144-L147

func NewRandomScoreFunction added in v8.5.0 

func NewRandomScoreFunction() *RandomScoreFunction

NewRandomScoreFunction returns a RandomScoreFunction.

func (*RandomScoreFunction) UnmarshalJSON added in v8.7.1 

func (s *RandomScoreFunction) UnmarshalJSON(data []byte) error

type RangeAggregate 

type RangeAggregate struct {
	Buckets BucketsRangeBucket `json:"buckets"`
	Meta    Metadata           `json:"meta,omitempty"`
}

RangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L594-L598

func NewRangeAggregate added in v8.5.0 

func NewRangeAggregate() *RangeAggregate

NewRangeAggregate returns a RangeAggregate.

func (*RangeAggregate) UnmarshalJSON added in v8.7.0 

func (s *RangeAggregate) UnmarshalJSON(data []byte) error

type RangeAggregation 

type RangeAggregation struct {
	// Field The date field whose values are use to build ranges.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Keyed Set to `true` to associate a unique string key with each bucket and return
	// the ranges as a hash rather than an array.
	Keyed *bool `json:"keyed,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing *int `json:"missing,omitempty"`
	// Ranges An array of ranges used to bucket documents.
	Ranges []AggregationRange `json:"ranges,omitempty"`
	Script *Script            `json:"script,omitempty"`
}

RangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L669-L689

func NewRangeAggregation added in v8.5.0 

func NewRangeAggregation() *RangeAggregation

NewRangeAggregation returns a RangeAggregation.

func (*RangeAggregation) UnmarshalJSON added in v8.7.1 

func (s *RangeAggregation) UnmarshalJSON(data []byte) error

type RangeBucket 

type RangeBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	From         *Float64             `json:"from,omitempty"`
	FromAsString *string              `json:"from_as_string,omitempty"`
	// Key The bucket key. Present if the aggregation is _not_ keyed
	Key        *string  `json:"key,omitempty"`
	To         *Float64 `json:"to,omitempty"`
	ToAsString *string  `json:"to_as_string,omitempty"`
}

RangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L600-L607

func NewRangeBucket added in v8.5.0 

func NewRangeBucket() *RangeBucket

NewRangeBucket returns a RangeBucket.

func (RangeBucket) MarshalJSON 

func (s RangeBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*RangeBucket) UnmarshalJSON added in v8.7.0 

func (s *RangeBucket) UnmarshalJSON(data []byte) error

type RangeQuery 

type RangeQuery any

RangeQuery holds the union for the following types: 

UntypedRangeQuery
DateRangeQuery
NumberRangeQuery
TermRangeQuery

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L176-L186

type RangeQueryBaseDateMath added in v8.15.0 

type RangeQueryBaseDateMath struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	From  *string  `json:"from,omitempty"`
	// Gt Greater than.
	Gt *string `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *string `json:"gte,omitempty"`
	// Lt Less than.
	Lt *string `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *string `json:"lte,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	To       *string                      `json:"to,omitempty"`
}

RangeQueryBaseDateMath type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L122-L148

func NewRangeQueryBaseDateMath added in v8.15.0 

func NewRangeQueryBaseDateMath() *RangeQueryBaseDateMath

NewRangeQueryBaseDateMath returns a RangeQueryBaseDateMath.

func (*RangeQueryBaseDateMath) UnmarshalJSON added in v8.15.0 

func (s *RangeQueryBaseDateMath) UnmarshalJSON(data []byte) error

type RangeQueryBasedouble added in v8.15.0 

type RangeQueryBasedouble struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	From  *Float64 `json:"from,omitempty"`
	// Gt Greater than.
	Gt *Float64 `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *Float64 `json:"gte,omitempty"`
	// Lt Less than.
	Lt *Float64 `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *Float64 `json:"lte,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	To       *Float64                     `json:"to,omitempty"`
}

RangeQueryBasedouble type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L122-L148

func NewRangeQueryBasedouble added in v8.15.0 

func NewRangeQueryBasedouble() *RangeQueryBasedouble

NewRangeQueryBasedouble returns a RangeQueryBasedouble.

func (*RangeQueryBasedouble) UnmarshalJSON added in v8.15.0 

func (s *RangeQueryBasedouble) UnmarshalJSON(data []byte) error

type RangeQueryBasestring added in v8.15.0 

type RangeQueryBasestring struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	From  *string  `json:"from,omitempty"`
	// Gt Greater than.
	Gt *string `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *string `json:"gte,omitempty"`
	// Lt Less than.
	Lt *string `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *string `json:"lte,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	To       *string                      `json:"to,omitempty"`
}

RangeQueryBasestring type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L122-L148

func NewRangeQueryBasestring added in v8.15.0 

func NewRangeQueryBasestring() *RangeQueryBasestring

NewRangeQueryBasestring returns a RangeQueryBasestring.

func (*RangeQueryBasestring) UnmarshalJSON added in v8.15.0 

func (s *RangeQueryBasestring) UnmarshalJSON(data []byte) error

type RankContainer added in v8.8.1 

type RankContainer struct {
	// Rrf The reciprocal rank fusion parameters
	Rrf *RrfRank `json:"rrf,omitempty"`
}

RankContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Rank.ts#L22-L28

func NewRankContainer added in v8.8.1 

func NewRankContainer() *RankContainer

NewRankContainer returns a RankContainer.

type RankEvalHit 

type RankEvalHit struct {
	Id_    string  `json:"_id"`
	Index_ string  `json:"_index"`
	Score_ Float64 `json:"_score"`
}

RankEvalHit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L144-L148

func NewRankEvalHit added in v8.5.0 

func NewRankEvalHit() *RankEvalHit

NewRankEvalHit returns a RankEvalHit.

func (*RankEvalHit) UnmarshalJSON added in v8.7.1 

func (s *RankEvalHit) UnmarshalJSON(data []byte) error

type RankEvalHitItem 

type RankEvalHitItem struct {
	Hit    RankEvalHit `json:"hit"`
	Rating *Float64    `json:"rating,omitempty"`
}

RankEvalHitItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L139-L142

func NewRankEvalHitItem added in v8.5.0 

func NewRankEvalHitItem() *RankEvalHitItem

NewRankEvalHitItem returns a RankEvalHitItem.

func (*RankEvalHitItem) UnmarshalJSON added in v8.7.1 

func (s *RankEvalHitItem) UnmarshalJSON(data []byte) error

type RankEvalMetric 

type RankEvalMetric struct {
	Dcg                    *RankEvalMetricDiscountedCumulativeGain `json:"dcg,omitempty"`
	ExpectedReciprocalRank *RankEvalMetricExpectedReciprocalRank   `json:"expected_reciprocal_rank,omitempty"`
	MeanReciprocalRank     *RankEvalMetricMeanReciprocalRank       `json:"mean_reciprocal_rank,omitempty"`
	Precision              *RankEvalMetricPrecision                `json:"precision,omitempty"`
	Recall                 *RankEvalMetricRecall                   `json:"recall,omitempty"`
}

RankEvalMetric type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L90-L96

func NewRankEvalMetric added in v8.5.0 

func NewRankEvalMetric() *RankEvalMetric

NewRankEvalMetric returns a RankEvalMetric.

type RankEvalMetricDetail 

type RankEvalMetricDetail struct {
	// Hits The hits section shows a grouping of the search results with their supplied
	// ratings
	Hits []RankEvalHitItem `json:"hits"`
	// MetricDetails The metric_details give additional information about the calculated quality
	// metric (e.g. how many of the retrieved documents were relevant). The content
	// varies for each metric but allows for better interpretation of the results
	MetricDetails map[string]map[string]json.RawMessage `json:"metric_details"`
	// MetricScore The metric_score in the details section shows the contribution of this query
	// to the global quality metric score
	MetricScore Float64 `json:"metric_score"`
	// UnratedDocs The unrated_docs section contains an _index and _id entry for each document
	// in the search result for this query that didn’t have a ratings value. This
	// can be used to ask the user to supply ratings for these documents
	UnratedDocs []UnratedDocument `json:"unrated_docs"`
}

RankEvalMetricDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L128-L137

func NewRankEvalMetricDetail added in v8.5.0 

func NewRankEvalMetricDetail() *RankEvalMetricDetail

NewRankEvalMetricDetail returns a RankEvalMetricDetail.

func (*RankEvalMetricDetail) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricDetail) UnmarshalJSON(data []byte) error

type RankEvalMetricDiscountedCumulativeGain 

type RankEvalMetricDiscountedCumulativeGain struct {
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// Normalize If set to true, this metric will calculate the Normalized DCG.
	Normalize *bool `json:"normalize,omitempty"`
}

RankEvalMetricDiscountedCumulativeGain type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L66-L77

func NewRankEvalMetricDiscountedCumulativeGain added in v8.5.0 

func NewRankEvalMetricDiscountedCumulativeGain() *RankEvalMetricDiscountedCumulativeGain

NewRankEvalMetricDiscountedCumulativeGain returns a RankEvalMetricDiscountedCumulativeGain.

func (*RankEvalMetricDiscountedCumulativeGain) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricDiscountedCumulativeGain) UnmarshalJSON(data []byte) error

type RankEvalMetricExpectedReciprocalRank 

type RankEvalMetricExpectedReciprocalRank struct {
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// MaximumRelevance The highest relevance grade used in the user-supplied relevance judgments.
	MaximumRelevance int `json:"maximum_relevance"`
}

RankEvalMetricExpectedReciprocalRank type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L79-L88

func NewRankEvalMetricExpectedReciprocalRank added in v8.5.0 

func NewRankEvalMetricExpectedReciprocalRank() *RankEvalMetricExpectedReciprocalRank

NewRankEvalMetricExpectedReciprocalRank returns a RankEvalMetricExpectedReciprocalRank.

func (*RankEvalMetricExpectedReciprocalRank) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricExpectedReciprocalRank) UnmarshalJSON(data []byte) error

type RankEvalMetricMeanReciprocalRank 

type RankEvalMetricMeanReciprocalRank struct {
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// RelevantRatingThreshold Sets the rating threshold above which documents are considered to be
	// "relevant".
	RelevantRatingThreshold *int `json:"relevant_rating_threshold,omitempty"`
}

RankEvalMetricMeanReciprocalRank type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L60-L64

func NewRankEvalMetricMeanReciprocalRank added in v8.5.0 

func NewRankEvalMetricMeanReciprocalRank() *RankEvalMetricMeanReciprocalRank

NewRankEvalMetricMeanReciprocalRank returns a RankEvalMetricMeanReciprocalRank.

func (*RankEvalMetricMeanReciprocalRank) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricMeanReciprocalRank) UnmarshalJSON(data []byte) error

type RankEvalMetricPrecision 

type RankEvalMetricPrecision struct {
	// IgnoreUnlabeled Controls how unlabeled documents in the search results are counted. If set to
	// true, unlabeled documents are ignored and neither count as relevant or
	// irrelevant. Set to false (the default), they are treated as irrelevant.
	IgnoreUnlabeled *bool `json:"ignore_unlabeled,omitempty"`
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// RelevantRatingThreshold Sets the rating threshold above which documents are considered to be
	// "relevant".
	RelevantRatingThreshold *int `json:"relevant_rating_threshold,omitempty"`
}

RankEvalMetricPrecision type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L42-L52

func NewRankEvalMetricPrecision added in v8.5.0 

func NewRankEvalMetricPrecision() *RankEvalMetricPrecision

NewRankEvalMetricPrecision returns a RankEvalMetricPrecision.

func (*RankEvalMetricPrecision) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricPrecision) UnmarshalJSON(data []byte) error

type RankEvalMetricRatingTreshold 

type RankEvalMetricRatingTreshold struct {
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// RelevantRatingThreshold Sets the rating threshold above which documents are considered to be
	// "relevant".
	RelevantRatingThreshold *int `json:"relevant_rating_threshold,omitempty"`
}

RankEvalMetricRatingTreshold type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L34-L40

func NewRankEvalMetricRatingTreshold added in v8.5.0 

func NewRankEvalMetricRatingTreshold() *RankEvalMetricRatingTreshold

NewRankEvalMetricRatingTreshold returns a RankEvalMetricRatingTreshold.

func (*RankEvalMetricRatingTreshold) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricRatingTreshold) UnmarshalJSON(data []byte) error

type RankEvalMetricRecall 

type RankEvalMetricRecall struct {
	// K Sets the maximum number of documents retrieved per query. This value will act
	// in place of the usual size parameter in the query.
	K *int `json:"k,omitempty"`
	// RelevantRatingThreshold Sets the rating threshold above which documents are considered to be
	// "relevant".
	RelevantRatingThreshold *int `json:"relevant_rating_threshold,omitempty"`
}

RankEvalMetricRecall type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L54-L58

func NewRankEvalMetricRecall added in v8.5.0 

func NewRankEvalMetricRecall() *RankEvalMetricRecall

NewRankEvalMetricRecall returns a RankEvalMetricRecall.

func (*RankEvalMetricRecall) UnmarshalJSON added in v8.7.1 

func (s *RankEvalMetricRecall) UnmarshalJSON(data []byte) error

type RankEvalQuery 

type RankEvalQuery struct {
	Query Query `json:"query"`
	Size  *int  `json:"size,omitempty"`
}

RankEvalQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L111-L117

func NewRankEvalQuery added in v8.5.0 

func NewRankEvalQuery() *RankEvalQuery

NewRankEvalQuery returns a RankEvalQuery.

func (*RankEvalQuery) UnmarshalJSON added in v8.7.1 

func (s *RankEvalQuery) UnmarshalJSON(data []byte) error

type RankEvalRequestItem 

type RankEvalRequestItem struct {
	// Id The search request’s ID, used to group result details later.
	Id string `json:"id"`
	// Params The search template parameters.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// Ratings List of document ratings
	Ratings []DocumentRating `json:"ratings"`
	// Request The query being evaluated.
	Request *RankEvalQuery `json:"request,omitempty"`
	// TemplateId The search template Id
	TemplateId *string `json:"template_id,omitempty"`
}

RankEvalRequestItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L98-L109

func NewRankEvalRequestItem added in v8.5.0 

func NewRankEvalRequestItem() *RankEvalRequestItem

NewRankEvalRequestItem returns a RankEvalRequestItem.

func (*RankEvalRequestItem) UnmarshalJSON added in v8.7.1 

func (s *RankEvalRequestItem) UnmarshalJSON(data []byte) error

type RankFeatureFunction 

type RankFeatureFunction struct {
}

RankFeatureFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L280-L280

func NewRankFeatureFunction added in v8.5.0 

func NewRankFeatureFunction() *RankFeatureFunction

NewRankFeatureFunction returns a RankFeatureFunction.

type RankFeatureFunctionLinear 

type RankFeatureFunctionLinear struct {
}

RankFeatureFunctionLinear type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L282-L282

func NewRankFeatureFunctionLinear added in v8.5.0 

func NewRankFeatureFunctionLinear() *RankFeatureFunctionLinear

NewRankFeatureFunctionLinear returns a RankFeatureFunctionLinear.

type RankFeatureFunctionLogarithm 

type RankFeatureFunctionLogarithm struct {
	// ScalingFactor Configurable scaling factor.
	ScalingFactor float32 `json:"scaling_factor"`
}

RankFeatureFunctionLogarithm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L284-L289

func NewRankFeatureFunctionLogarithm added in v8.5.0 

func NewRankFeatureFunctionLogarithm() *RankFeatureFunctionLogarithm

NewRankFeatureFunctionLogarithm returns a RankFeatureFunctionLogarithm.

func (*RankFeatureFunctionLogarithm) UnmarshalJSON added in v8.7.1 

func (s *RankFeatureFunctionLogarithm) UnmarshalJSON(data []byte) error

type RankFeatureFunctionSaturation 

type RankFeatureFunctionSaturation struct {
	// Pivot Configurable pivot value so that the result will be less than 0.5.
	Pivot *float32 `json:"pivot,omitempty"`
}

RankFeatureFunctionSaturation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L291-L296

func NewRankFeatureFunctionSaturation added in v8.5.0 

func NewRankFeatureFunctionSaturation() *RankFeatureFunctionSaturation

NewRankFeatureFunctionSaturation returns a RankFeatureFunctionSaturation.

func (*RankFeatureFunctionSaturation) UnmarshalJSON added in v8.7.1 

func (s *RankFeatureFunctionSaturation) UnmarshalJSON(data []byte) error

type RankFeatureFunctionSigmoid 

type RankFeatureFunctionSigmoid struct {
	// Exponent Configurable Exponent.
	Exponent float32 `json:"exponent"`
	// Pivot Configurable pivot value so that the result will be less than 0.5.
	Pivot float32 `json:"pivot"`
}

RankFeatureFunctionSigmoid type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L298-L307

func NewRankFeatureFunctionSigmoid added in v8.5.0 

func NewRankFeatureFunctionSigmoid() *RankFeatureFunctionSigmoid

NewRankFeatureFunctionSigmoid returns a RankFeatureFunctionSigmoid.

func (*RankFeatureFunctionSigmoid) UnmarshalJSON added in v8.7.1 

func (s *RankFeatureFunctionSigmoid) UnmarshalJSON(data []byte) error

type RankFeatureProperty 

type RankFeatureProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	PositiveScoreImpact *bool                                            `json:"positive_score_impact,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

RankFeatureProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L205-L208

func NewRankFeatureProperty added in v8.5.0 

func NewRankFeatureProperty() *RankFeatureProperty

NewRankFeatureProperty returns a RankFeatureProperty.

func (RankFeatureProperty) MarshalJSON added in v8.9.0 

func (s RankFeatureProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RankFeatureProperty) UnmarshalJSON added in v8.7.0 

func (s *RankFeatureProperty) UnmarshalJSON(data []byte) error

type RankFeatureQuery 

type RankFeatureQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field `rank_feature` or `rank_features` field used to boost relevance scores.
	Field string `json:"field"`
	// Linear Linear function used to boost relevance scores based on the value of the rank
	// feature `field`.
	Linear *RankFeatureFunctionLinear `json:"linear,omitempty"`
	// Log Logarithmic function used to boost relevance scores based on the value of the
	// rank feature `field`.
	Log        *RankFeatureFunctionLogarithm `json:"log,omitempty"`
	QueryName_ *string                       `json:"_name,omitempty"`
	// Saturation Saturation function used to boost relevance scores based on the value of the
	// rank feature `field`.
	Saturation *RankFeatureFunctionSaturation `json:"saturation,omitempty"`
	// Sigmoid Sigmoid function used to boost relevance scores based on the value of the
	// rank feature `field`.
	Sigmoid *RankFeatureFunctionSigmoid `json:"sigmoid,omitempty"`
}

RankFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L309-L335

func NewRankFeatureQuery added in v8.5.0 

func NewRankFeatureQuery() *RankFeatureQuery

NewRankFeatureQuery returns a RankFeatureQuery.

func (*RankFeatureQuery) UnmarshalJSON added in v8.7.1 

func (s *RankFeatureQuery) UnmarshalJSON(data []byte) error

type RankFeaturesProperty 

type RankFeaturesProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	PositiveScoreImpact *bool                                            `json:"positive_score_impact,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

RankFeaturesProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L210-L213

func NewRankFeaturesProperty added in v8.5.0 

func NewRankFeaturesProperty() *RankFeaturesProperty

NewRankFeaturesProperty returns a RankFeaturesProperty.

func (RankFeaturesProperty) MarshalJSON added in v8.9.0 

func (s RankFeaturesProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RankFeaturesProperty) UnmarshalJSON added in v8.7.0 

func (s *RankFeaturesProperty) UnmarshalJSON(data []byte) error

type RankedDocument added in v8.14.0 

type RankedDocument struct {
	Index          int     `json:"index"`
	RelevanceScore float32 `json:"relevance_score"`
	Text           *string `json:"text,omitempty"`
}

RankedDocument type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L90-L100

func NewRankedDocument added in v8.14.0 

func NewRankedDocument() *RankedDocument

NewRankedDocument returns a RankedDocument.

func (*RankedDocument) UnmarshalJSON added in v8.14.0 

func (s *RankedDocument) UnmarshalJSON(data []byte) error

type RareTermsAggregation 

type RareTermsAggregation struct {
	// Exclude Terms that should be excluded from the aggregation.
	Exclude []string `json:"exclude,omitempty"`
	// Field The field from which to return rare terms.
	Field *string `json:"field,omitempty"`
	// Include Terms that should be included in the aggregation.
	Include TermsInclude `json:"include,omitempty"`
	// MaxDocCount The maximum number of documents a term should appear in.
	MaxDocCount *int64 `json:"max_doc_count,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// Precision The precision of the internal CuckooFilters.
	// Smaller precision leads to better approximation, but higher memory usage.
	Precision *Float64 `json:"precision,omitempty"`
	ValueType *string  `json:"value_type,omitempty"`
}

RareTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L706-L739

func NewRareTermsAggregation added in v8.5.0 

func NewRareTermsAggregation() *RareTermsAggregation

NewRareTermsAggregation returns a RareTermsAggregation.

func (*RareTermsAggregation) UnmarshalJSON added in v8.7.1 

func (s *RareTermsAggregation) UnmarshalJSON(data []byte) error

type RateAggregate 

type RateAggregate struct {
	Meta          Metadata `json:"meta,omitempty"`
	Value         Float64  `json:"value"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

RateAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L847-L854

func NewRateAggregate added in v8.5.0 

func NewRateAggregate() *RateAggregate

NewRateAggregate returns a RateAggregate.

func (*RateAggregate) UnmarshalJSON added in v8.7.1 

func (s *RateAggregate) UnmarshalJSON(data []byte) error

type RateAggregation 

type RateAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// Mode How the rate is calculated.
	Mode   *ratemode.RateMode `json:"mode,omitempty"`
	Script *Script            `json:"script,omitempty"`
	// Unit The interval used to calculate the rate.
	// By default, the interval of the `date_histogram` is used.
	Unit *calendarinterval.CalendarInterval `json:"unit,omitempty"`
}

RateAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L239-L250

func NewRateAggregation added in v8.5.0 

func NewRateAggregation() *RateAggregation

NewRateAggregation returns a RateAggregation.

func (*RateAggregation) UnmarshalJSON added in v8.7.1 

func (s *RateAggregation) UnmarshalJSON(data []byte) error

type RateLimitSetting added in v8.18.0 

type RateLimitSetting struct {
	// RequestsPerMinute The number of requests allowed per minute.
	RequestsPerMinute *int `json:"requests_per_minute,omitempty"`
}

RateLimitSetting type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Services.ts#L289-L294

func NewRateLimitSetting added in v8.18.0 

func NewRateLimitSetting() *RateLimitSetting

NewRateLimitSetting returns a RateLimitSetting.

func (*RateLimitSetting) UnmarshalJSON added in v8.18.0 

func (s *RateLimitSetting) UnmarshalJSON(data []byte) error

type ReadBlobDetails added in v8.18.0 

type ReadBlobDetails struct {
	// BeforeWriteComplete Indicates whether the read operation may have started before the write
	// operation was complete.
	BeforeWriteComplete *bool `json:"before_write_complete,omitempty"`
	// Elapsed The length of time spent reading the blob.
	// If the blob was not found, this detail is omitted.
	Elapsed Duration `json:"elapsed,omitempty"`
	// ElapsedNanos The length of time spent reading the blob, in nanoseconds.
	// If the blob was not found, this detail is omitted.
	ElapsedNanos *int64 `json:"elapsed_nanos,omitempty"`
	// FirstByteTime The length of time waiting for the first byte of the read operation to be
	// received.
	// If the blob was not found, this detail is omitted.
	FirstByteTime Duration `json:"first_byte_time,omitempty"`
	// FirstByteTimeNanos The length of time waiting for the first byte of the read operation to be
	// received, in nanoseconds.
	// If the blob was not found, this detail is omitted.
	FirstByteTimeNanos int64 `json:"first_byte_time_nanos"`
	// Found Indicates whether the blob was found by the read operation.
	// If the read was started before the write completed or the write was ended
	// before completion, it might be false.
	Found bool `json:"found"`
	// Node The node that performed the read operation.
	Node SnapshotNodeInfo `json:"node"`
	// Throttled The length of time spent waiting due to the `max_restore_bytes_per_sec` or
	// `indices.recovery.max_bytes_per_sec` throttles during the read of the blob.
	// If the blob was not found, this detail is omitted.
	Throttled Duration `json:"throttled,omitempty"`
	// ThrottledNanos The length of time spent waiting due to the `max_restore_bytes_per_sec` or
	// `indices.recovery.max_bytes_per_sec` throttles during the read of the blob,
	// in nanoseconds.
	// If the blob was not found, this detail is omitted.
	ThrottledNanos *int64 `json:"throttled_nanos,omitempty"`
}

ReadBlobDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L204-L248

func NewReadBlobDetails added in v8.18.0 

func NewReadBlobDetails() *ReadBlobDetails

NewReadBlobDetails returns a ReadBlobDetails.

func (*ReadBlobDetails) UnmarshalJSON added in v8.18.0 

func (s *ReadBlobDetails) UnmarshalJSON(data []byte) error

type ReadException 

type ReadException struct {
	// Exception The exception that caused the read to fail.
	Exception ErrorCause `json:"exception"`
	// FromSeqNo The starting sequence number of the batch requested from the leader.
	FromSeqNo int64 `json:"from_seq_no"`
	// Retries The number of times the batch has been retried.
	Retries int `json:"retries"`
}

ReadException type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ccr/_types/FollowIndexStats.ts#L111-L118

func NewReadException added in v8.5.0 

func NewReadException() *ReadException

NewReadException returns a ReadException.

func (*ReadException) UnmarshalJSON added in v8.7.1 

func (s *ReadException) UnmarshalJSON(data []byte) error

type ReadOnlyUrlRepository added in v8.13.0 

type ReadOnlyUrlRepository struct {
	Settings ReadOnlyUrlRepositorySettings `json:"settings"`
	Type     string                        `json:"type,omitempty"`
	Uuid     *string                       `json:"uuid,omitempty"`
}

ReadOnlyUrlRepository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L60-L63

func NewReadOnlyUrlRepository added in v8.13.0 

func NewReadOnlyUrlRepository() *ReadOnlyUrlRepository

NewReadOnlyUrlRepository returns a ReadOnlyUrlRepository.

func (ReadOnlyUrlRepository) MarshalJSON added in v8.13.0 

func (s ReadOnlyUrlRepository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ReadOnlyUrlRepository) UnmarshalJSON added in v8.13.0 

func (s *ReadOnlyUrlRepository) UnmarshalJSON(data []byte) error

type ReadOnlyUrlRepositorySettings added in v8.13.0 

type ReadOnlyUrlRepositorySettings struct {
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	HttpMaxRetries         *int     `json:"http_max_retries,omitempty"`
	HttpSocketTimeout      Duration `json:"http_socket_timeout,omitempty"`
	MaxNumberOfSnapshots   *int     `json:"max_number_of_snapshots,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	Url                    string   `json:"url"`
}

ReadOnlyUrlRepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L110-L115

func NewReadOnlyUrlRepositorySettings added in v8.13.0 

func NewReadOnlyUrlRepositorySettings() *ReadOnlyUrlRepositorySettings

NewReadOnlyUrlRepositorySettings returns a ReadOnlyUrlRepositorySettings.

func (*ReadOnlyUrlRepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *ReadOnlyUrlRepositorySettings) UnmarshalJSON(data []byte) error

type ReadSummaryInfo added in v8.18.0 

type ReadSummaryInfo struct {
	// Count The number of read operations performed in the test.
	Count int `json:"count"`
	// MaxWait The maximum time spent waiting for the first byte of any read request to be
	// received.
	MaxWait Duration `json:"max_wait"`
	// MaxWaitNanos The maximum time spent waiting for the first byte of any read request to be
	// received, in nanoseconds.
	MaxWaitNanos int64 `json:"max_wait_nanos"`
	// TotalElapsed The total elapsed time spent on reading blobs in the test.
	TotalElapsed Duration `json:"total_elapsed"`
	// TotalElapsedNanos The total elapsed time spent on reading blobs in the test, in nanoseconds.
	TotalElapsedNanos int64 `json:"total_elapsed_nanos"`
	// TotalSize The total size of all the blobs or partial blobs read in the test.
	TotalSize ByteSize `json:"total_size"`
	// TotalSizeBytes The total size of all the blobs or partial blobs read in the test, in bytes.
	TotalSizeBytes int64 `json:"total_size_bytes"`
	// TotalThrottled The total time spent waiting due to the `max_restore_bytes_per_sec` or
	// `indices.recovery.max_bytes_per_sec` throttles.
	TotalThrottled Duration `json:"total_throttled"`
	// TotalThrottledNanos The total time spent waiting due to the `max_restore_bytes_per_sec` or
	// `indices.recovery.max_bytes_per_sec` throttles, in nanoseconds.
	TotalThrottledNanos int64 `json:"total_throttled_nanos"`
	// TotalWait The total time spent waiting for the first byte of each read request to be
	// received.
	TotalWait Duration `json:"total_wait"`
	// TotalWaitNanos The total time spent waiting for the first byte of each read request to be
	// received, in nanoseconds.
	TotalWaitNanos int64 `json:"total_wait_nanos"`
}

ReadSummaryInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L115-L160

func NewReadSummaryInfo added in v8.18.0 

func NewReadSummaryInfo() *ReadSummaryInfo

NewReadSummaryInfo returns a ReadSummaryInfo.

func (*ReadSummaryInfo) UnmarshalJSON added in v8.18.0 

func (s *ReadSummaryInfo) UnmarshalJSON(data []byte) error

type RealmCache 

type RealmCache struct {
	Size int64 `json:"size"`
}

RealmCache type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L276-L278

func NewRealmCache added in v8.5.0 

func NewRealmCache() *RealmCache

NewRealmCache returns a RealmCache.

func (*RealmCache) UnmarshalJSON added in v8.7.1 

func (s *RealmCache) UnmarshalJSON(data []byte) error

type RealmInfo 

type RealmInfo struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

RealmInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RealmInfo.ts#L22-L25

func NewRealmInfo added in v8.5.0 

func NewRealmInfo() *RealmInfo

NewRealmInfo returns a RealmInfo.

func (*RealmInfo) UnmarshalJSON added in v8.7.1 

func (s *RealmInfo) UnmarshalJSON(data []byte) error

type Recording 

type Recording struct {
	CumulativeExecutionCount      *int64   `json:"cumulative_execution_count,omitempty"`
	CumulativeExecutionTime       Duration `json:"cumulative_execution_time,omitempty"`
	CumulativeExecutionTimeMillis *int64   `json:"cumulative_execution_time_millis,omitempty"`
	Name                          *string  `json:"name,omitempty"`
}

Recording type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L225-L230

func NewRecording added in v8.5.0 

func NewRecording() *Recording

NewRecording returns a Recording.

func (*Recording) UnmarshalJSON added in v8.7.1 

func (s *Recording) UnmarshalJSON(data []byte) error

type RecoveryBytes 

type RecoveryBytes struct {
	Percent                      Percentage `json:"percent"`
	Recovered                    ByteSize   `json:"recovered,omitempty"`
	RecoveredFromSnapshot        ByteSize   `json:"recovered_from_snapshot,omitempty"`
	RecoveredFromSnapshotInBytes ByteSize   `json:"recovered_from_snapshot_in_bytes,omitempty"`
	RecoveredInBytes             ByteSize   `json:"recovered_in_bytes"`
	Reused                       ByteSize   `json:"reused,omitempty"`
	ReusedInBytes                ByteSize   `json:"reused_in_bytes"`
	Total                        ByteSize   `json:"total,omitempty"`
	TotalInBytes                 ByteSize   `json:"total_in_bytes"`
}

RecoveryBytes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L38-L48

func NewRecoveryBytes added in v8.5.0 

func NewRecoveryBytes() *RecoveryBytes

NewRecoveryBytes returns a RecoveryBytes.

func (*RecoveryBytes) UnmarshalJSON added in v8.7.1 

func (s *RecoveryBytes) UnmarshalJSON(data []byte) error

type RecoveryFiles 

type RecoveryFiles struct {
	Details   []FileDetails `json:"details,omitempty"`
	Percent   Percentage    `json:"percent"`
	Recovered int64         `json:"recovered"`
	Reused    int64         `json:"reused"`
	Total     int64         `json:"total"`
}

RecoveryFiles type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L56-L62

func NewRecoveryFiles added in v8.5.0 

func NewRecoveryFiles() *RecoveryFiles

NewRecoveryFiles returns a RecoveryFiles.

func (*RecoveryFiles) UnmarshalJSON added in v8.7.1 

func (s *RecoveryFiles) UnmarshalJSON(data []byte) error

type RecoveryIndexStatus 

type RecoveryIndexStatus struct {
	Bytes                      *RecoveryBytes `json:"bytes,omitempty"`
	Files                      RecoveryFiles  `json:"files"`
	Size                       RecoveryBytes  `json:"size"`
	SourceThrottleTime         Duration       `json:"source_throttle_time,omitempty"`
	SourceThrottleTimeInMillis int64          `json:"source_throttle_time_in_millis"`
	TargetThrottleTime         Duration       `json:"target_throttle_time,omitempty"`
	TargetThrottleTimeInMillis int64          `json:"target_throttle_time_in_millis"`
	TotalTime                  Duration       `json:"total_time,omitempty"`
	TotalTimeInMillis          int64          `json:"total_time_in_millis"`
}

RecoveryIndexStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L64-L74

func NewRecoveryIndexStatus added in v8.5.0 

func NewRecoveryIndexStatus() *RecoveryIndexStatus

NewRecoveryIndexStatus returns a RecoveryIndexStatus.

func (*RecoveryIndexStatus) UnmarshalJSON added in v8.7.1 

func (s *RecoveryIndexStatus) UnmarshalJSON(data []byte) error

type RecoveryOrigin 

type RecoveryOrigin struct {
	BootstrapNewHistoryUuid *bool   `json:"bootstrap_new_history_uuid,omitempty"`
	Host                    *string `json:"host,omitempty"`
	Hostname                *string `json:"hostname,omitempty"`
	Id                      *string `json:"id,omitempty"`
	Index                   *string `json:"index,omitempty"`
	Ip                      *string `json:"ip,omitempty"`
	Name                    *string `json:"name,omitempty"`
	Repository              *string `json:"repository,omitempty"`
	RestoreUUID             *string `json:"restoreUUID,omitempty"`
	Snapshot                *string `json:"snapshot,omitempty"`
	TransportAddress        *string `json:"transport_address,omitempty"`
	Version                 *string `json:"version,omitempty"`
}

RecoveryOrigin type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L76-L89

func NewRecoveryOrigin added in v8.5.0 

func NewRecoveryOrigin() *RecoveryOrigin

NewRecoveryOrigin returns a RecoveryOrigin.

func (*RecoveryOrigin) UnmarshalJSON added in v8.7.1 

func (s *RecoveryOrigin) UnmarshalJSON(data []byte) error

type RecoveryRecord 

type RecoveryRecord struct {
	// Bytes The number of bytes to recover.
	Bytes *string `json:"bytes,omitempty"`
	// BytesPercent The ratio of bytes recovered.
	BytesPercent Percentage `json:"bytes_percent,omitempty"`
	// BytesRecovered The bytes recovered.
	BytesRecovered *string `json:"bytes_recovered,omitempty"`
	// BytesTotal The total number of bytes.
	BytesTotal *string `json:"bytes_total,omitempty"`
	// Files The number of files to recover.
	Files *string `json:"files,omitempty"`
	// FilesPercent The ratio of files recovered.
	FilesPercent Percentage `json:"files_percent,omitempty"`
	// FilesRecovered The files recovered.
	FilesRecovered *string `json:"files_recovered,omitempty"`
	// FilesTotal The total number of files.
	FilesTotal *string `json:"files_total,omitempty"`
	// Index The index name.
	Index *string `json:"index,omitempty"`
	// Repository The repository name.
	Repository *string `json:"repository,omitempty"`
	// Shard The shard name.
	Shard *string `json:"shard,omitempty"`
	// Snapshot The snapshot name.
	Snapshot *string `json:"snapshot,omitempty"`
	// SourceHost The source host.
	SourceHost *string `json:"source_host,omitempty"`
	// SourceNode The source node name.
	SourceNode *string `json:"source_node,omitempty"`
	// Stage The recovery stage.
	Stage *string `json:"stage,omitempty"`
	// StartTime The recovery start time.
	StartTime DateTime `json:"start_time,omitempty"`
	// StartTimeMillis The recovery start time in epoch milliseconds.
	StartTimeMillis *int64 `json:"start_time_millis,omitempty"`
	// StopTime The recovery stop time.
	StopTime DateTime `json:"stop_time,omitempty"`
	// StopTimeMillis The recovery stop time in epoch milliseconds.
	StopTimeMillis *int64 `json:"stop_time_millis,omitempty"`
	// TargetHost The target host.
	TargetHost *string `json:"target_host,omitempty"`
	// TargetNode The target node name.
	TargetNode *string `json:"target_node,omitempty"`
	// Time The recovery time.
	Time Duration `json:"time,omitempty"`
	// TranslogOps The number of translog operations to recover.
	TranslogOps *string `json:"translog_ops,omitempty"`
	// TranslogOpsPercent The ratio of translog operations recovered.
	TranslogOpsPercent Percentage `json:"translog_ops_percent,omitempty"`
	// TranslogOpsRecovered The translog operations recovered.
	TranslogOpsRecovered *string `json:"translog_ops_recovered,omitempty"`
	// Type The recovery type.
	Type *string `json:"type,omitempty"`
}

RecoveryRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/recovery/types.ts#L24-L155

func NewRecoveryRecord added in v8.5.0 

func NewRecoveryRecord() *RecoveryRecord

NewRecoveryRecord returns a RecoveryRecord.

func (*RecoveryRecord) UnmarshalJSON added in v8.7.1 

func (s *RecoveryRecord) UnmarshalJSON(data []byte) error

type RecoveryStartStatus 

type RecoveryStartStatus struct {
	CheckIndexTime         Duration `json:"check_index_time,omitempty"`
	CheckIndexTimeInMillis int64    `json:"check_index_time_in_millis"`
	TotalTime              Duration `json:"total_time,omitempty"`
	TotalTimeInMillis      int64    `json:"total_time_in_millis"`
}

RecoveryStartStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L91-L96

func NewRecoveryStartStatus added in v8.5.0 

func NewRecoveryStartStatus() *RecoveryStartStatus

NewRecoveryStartStatus returns a RecoveryStartStatus.

func (*RecoveryStartStatus) UnmarshalJSON added in v8.7.1 

func (s *RecoveryStartStatus) UnmarshalJSON(data []byte) error

type RecoveryStats 

type RecoveryStats struct {
	CurrentAsSource      int64    `json:"current_as_source"`
	CurrentAsTarget      int64    `json:"current_as_target"`
	ThrottleTime         Duration `json:"throttle_time,omitempty"`
	ThrottleTimeInMillis int64    `json:"throttle_time_in_millis"`
}

RecoveryStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L231-L236

func NewRecoveryStats added in v8.5.0 

func NewRecoveryStats() *RecoveryStats

NewRecoveryStats returns a RecoveryStats.

func (*RecoveryStats) UnmarshalJSON added in v8.7.1 

func (s *RecoveryStats) UnmarshalJSON(data []byte) error

type RecoveryStatus 

type RecoveryStatus struct {
	Shards []ShardRecovery `json:"shards"`
}

RecoveryStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L98-L100

func NewRecoveryStatus added in v8.5.0 

func NewRecoveryStatus() *RecoveryStatus

NewRecoveryStatus returns a RecoveryStatus.

type Redact added in v8.16.0 

type Redact struct {
	// IsRedacted_ indicates if document has been redacted
	IsRedacted_ bool `json:"_is_redacted"`
}

Redact type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L38-L43

func NewRedact added in v8.16.0 

func NewRedact() *Redact

NewRedact returns a Redact.

func (*Redact) UnmarshalJSON added in v8.16.0 

func (s *Redact) UnmarshalJSON(data []byte) error

type RedactProcessor added in v8.16.0 

type RedactProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to be redacted
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure          []ProcessorContainer `json:"on_failure,omitempty"`
	PatternDefinitions map[string]string    `json:"pattern_definitions,omitempty"`
	// Patterns A list of grok expressions to match and redact named captures with
	Patterns []string `json:"patterns"`
	// Prefix Start a redacted section with this token
	Prefix *string `json:"prefix,omitempty"`
	// SkipIfUnlicensed If `true` and the current license does not support running redact processors,
	// then the processor quietly exits without modifying the document
	SkipIfUnlicensed *bool `json:"skip_if_unlicensed,omitempty"`
	// Suffix End a redacted section with this token
	Suffix *string `json:"suffix,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TraceRedact If `true` then ingest metadata `_ingest._redact._is_redacted` is set to
	// `true` if the document has been redacted
	TraceRedact *bool `json:"trace_redact,omitempty"`
}

RedactProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1297-L1338

func NewRedactProcessor added in v8.16.0 

func NewRedactProcessor() *RedactProcessor

NewRedactProcessor returns a RedactProcessor.

func (*RedactProcessor) UnmarshalJSON added in v8.16.0 

func (s *RedactProcessor) UnmarshalJSON(data []byte) error

type RefreshStats 

type RefreshStats struct {
	ExternalTotal             int64    `json:"external_total"`
	ExternalTotalTimeInMillis int64    `json:"external_total_time_in_millis"`
	Listeners                 int64    `json:"listeners"`
	Total                     int64    `json:"total"`
	TotalTime                 Duration `json:"total_time,omitempty"`
	TotalTimeInMillis         int64    `json:"total_time_in_millis"`
}

RefreshStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L238-L245

func NewRefreshStats added in v8.5.0 

func NewRefreshStats() *RefreshStats

NewRefreshStats returns a RefreshStats.

func (*RefreshStats) UnmarshalJSON added in v8.7.1 

func (s *RefreshStats) UnmarshalJSON(data []byte) error

type RegexOptions added in v8.7.1 

type RegexOptions struct {
	// Flags Optional operators for the regular expression.
	Flags string `json:"flags,omitempty"`
	// MaxDeterminizedStates Maximum number of automaton states required for the query.
	MaxDeterminizedStates *int `json:"max_determinized_states,omitempty"`
}

RegexOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L183-L194

func NewRegexOptions added in v8.7.1 

func NewRegexOptions() *RegexOptions

NewRegexOptions returns a RegexOptions.

func (*RegexOptions) UnmarshalJSON added in v8.7.1 

func (s *RegexOptions) UnmarshalJSON(data []byte) error

type RegexValidation added in v8.15.0 

type RegexValidation struct {
	Constraint string `json:"constraint"`
	Type       string `json:"type,omitempty"`
}

RegexValidation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L78-L81

func NewRegexValidation added in v8.15.0 

func NewRegexValidation() *RegexValidation

NewRegexValidation returns a RegexValidation.

func (RegexValidation) MarshalJSON added in v8.15.0 

func (s RegexValidation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RegexValidation) UnmarshalJSON added in v8.15.0 

func (s *RegexValidation) UnmarshalJSON(data []byte) error

type RegexpQuery 

type RegexpQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// CaseInsensitive Allows case insensitive matching of the regular expression value with the
	// indexed field values when set to `true`.
	// When `false`, case sensitivity of matching depends on the underlying field’s
	// mapping.
	CaseInsensitive *bool `json:"case_insensitive,omitempty"`
	// Flags Enables optional operators for the regular expression.
	Flags *string `json:"flags,omitempty"`
	// MaxDeterminizedStates Maximum number of automaton states required for the query.
	MaxDeterminizedStates *int    `json:"max_determinized_states,omitempty"`
	QueryName_            *string `json:"_name,omitempty"`
	// Rewrite Method used to rewrite the query.
	Rewrite *string `json:"rewrite,omitempty"`
	// Value Regular expression for terms you wish to find in the provided field.
	Value string `json:"value"`
}

RegexpQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L203-L236

func NewRegexpQuery added in v8.5.0 

func NewRegexpQuery() *RegexpQuery

NewRegexpQuery returns a RegexpQuery.

func (*RegexpQuery) UnmarshalJSON added in v8.7.1 

func (s *RegexpQuery) UnmarshalJSON(data []byte) error

type RegisteredDomainProcessor added in v8.16.0 

type RegisteredDomainProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field Field containing the source FQDN.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If true and any required fields are missing, the processor quietly exits
	// without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Object field containing extracted domain components. If an empty string,
	// the processor adds components to the document’s root.
	TargetField *string `json:"target_field,omitempty"`
}

RegisteredDomainProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1340-L1356

func NewRegisteredDomainProcessor added in v8.16.0 

func NewRegisteredDomainProcessor() *RegisteredDomainProcessor

NewRegisteredDomainProcessor returns a RegisteredDomainProcessor.

func (*RegisteredDomainProcessor) UnmarshalJSON added in v8.16.0 

func (s *RegisteredDomainProcessor) UnmarshalJSON(data []byte) error

type RegressionInferenceOptions 

type RegressionInferenceOptions struct {
	// NumTopFeatureImportanceValues Specifies the maximum number of feature importance values per document.
	NumTopFeatureImportanceValues *int `json:"num_top_feature_importance_values,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
}

RegressionInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L107-L116

func NewRegressionInferenceOptions added in v8.5.0 

func NewRegressionInferenceOptions() *RegressionInferenceOptions

NewRegressionInferenceOptions returns a RegressionInferenceOptions.

func (*RegressionInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *RegressionInferenceOptions) UnmarshalJSON(data []byte) error

type ReindexDestination added in v8.5.0 

type ReindexDestination struct {
	// Index The name of the data stream, index, or index alias you are copying to.
	Index string `json:"index"`
	// OpType If it is `create`, the operation will only index documents that do not
	// already exist (also known as "put if absent").
	//
	// IMPORTANT: To reindex to a data stream destination, this argument must be
	// `create`.
	OpType *optype.OpType `json:"op_type,omitempty"`
	// Pipeline The name of the pipeline to use.
	Pipeline *string `json:"pipeline,omitempty"`
	// Routing By default, a document's routing is preserved unless it's changed by the
	// script.
	// If it is `keep`, the routing on the bulk request sent for each match is set
	// to the routing on the match.
	// If it is `discard`, the routing on the bulk request sent for each match is
	// set to `null`.
	// If it is `=value`, the routing on the bulk request sent for each match is set
	// to all value specified after the equals sign (`=`).
	Routing *string `json:"routing,omitempty"`
	// VersionType The versioning to use for the indexing operation.
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

ReindexDestination type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex/types.ts#L39-L67

func NewReindexDestination added in v8.5.0 

func NewReindexDestination() *ReindexDestination

NewReindexDestination returns a ReindexDestination.

func (*ReindexDestination) UnmarshalJSON added in v8.7.1 

func (s *ReindexDestination) UnmarshalJSON(data []byte) error

type ReindexNode 

type ReindexNode struct {
	Attributes       map[string]string      `json:"attributes"`
	Host             string                 `json:"host"`
	Ip               string                 `json:"ip"`
	Name             string                 `json:"name"`
	Roles            []noderole.NodeRole    `json:"roles,omitempty"`
	Tasks            map[string]ReindexTask `json:"tasks"`
	TransportAddress string                 `json:"transport_address"`
}

ReindexNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex_rethrottle/types.ts#L33-L35

func NewReindexNode added in v8.5.0 

func NewReindexNode() *ReindexNode

NewReindexNode returns a ReindexNode.

func (*ReindexNode) UnmarshalJSON added in v8.7.1 

func (s *ReindexNode) UnmarshalJSON(data []byte) error

type ReindexSource added in v8.5.0 

type ReindexSource struct {
	// Index The name of the data stream, index, or alias you are copying from.
	// It accepts a comma-separated list to reindex from multiple sources.
	Index []string `json:"index"`
	// Query The documents to reindex, which is defined with Query DSL.
	Query *Query `json:"query,omitempty"`
	// Remote A remote instance of Elasticsearch that you want to index from.
	Remote          *RemoteSource `json:"remote,omitempty"`
	RuntimeMappings RuntimeFields `json:"runtime_mappings,omitempty"`
	// Size The number of documents to index per batch.
	// Use it when you are indexing from remote to ensure that the batches fit
	// within the on-heap buffer, which defaults to a maximum size of 100 MB.
	Size *int `json:"size,omitempty"`
	// Slice Slice the reindex request manually using the provided slice ID and total
	// number of slices.
	Slice *SlicedScroll `json:"slice,omitempty"`
	// Sort A comma-separated list of `<field>:<direction>` pairs to sort by before
	// indexing.
	// Use it in conjunction with `max_docs` to control what documents are
	// reindexed.
	//
	// WARNING: Sort in reindex is deprecated.
	// Sorting in reindex was never guaranteed to index documents in order and
	// prevents further development of reindex such as resilience and performance
	// improvements.
	// If used in combination with `max_docs`, consider using a query filter
	// instead.
	Sort []SortCombinations `json:"sort,omitempty"`
	// SourceFields_ If `true`, reindex all source fields.
	// Set it to a list to reindex select fields.
	SourceFields_ []string `json:"_source,omitempty"`
}

ReindexSource type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex/types.ts#L69-L110

func NewReindexSource added in v8.5.0 

func NewReindexSource() *ReindexSource

NewReindexSource returns a ReindexSource.

func (*ReindexSource) UnmarshalJSON added in v8.7.1 

func (s *ReindexSource) UnmarshalJSON(data []byte) error

type ReindexStatus 

type ReindexStatus struct {
	// Batches The number of scroll responses pulled back by the reindex.
	Batches int64 `json:"batches"`
	// Created The number of documents that were successfully created.
	Created int64 `json:"created"`
	// Deleted The number of documents that were successfully deleted.
	Deleted int64 `json:"deleted"`
	// Noops The number of documents that were ignored because the script used for the
	// reindex returned a `noop` value for `ctx.op`.
	Noops int64 `json:"noops"`
	// RequestsPerSecond The number of requests per second effectively executed during the reindex.
	RequestsPerSecond float32 `json:"requests_per_second"`
	// Retries The number of retries attempted by reindex. `bulk` is the number of bulk
	// actions retried and `search` is the number of search actions retried.
	Retries   Retries  `json:"retries"`
	Throttled Duration `json:"throttled,omitempty"`
	// ThrottledMillis Number of milliseconds the request slept to conform to `requests_per_second`.
	ThrottledMillis int64    `json:"throttled_millis"`
	ThrottledUntil  Duration `json:"throttled_until,omitempty"`
	// ThrottledUntilMillis This field should always be equal to zero in a `_reindex` response.
	// It only has meaning when using the Task API, where it indicates the next time
	// (in milliseconds since epoch) a throttled request will be executed again in
	// order to conform to `requests_per_second`.
	ThrottledUntilMillis int64 `json:"throttled_until_millis"`
	// Total The number of documents that were successfully processed.
	Total int64 `json:"total"`
	// Updated The number of documents that were successfully updated, for example, a
	// document with same ID already existed prior to reindex updating it.
	Updated int64 `json:"updated"`
	// VersionConflicts The number of version conflicts that reindex hits.
	VersionConflicts int64 `json:"version_conflicts"`
}

ReindexStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex_rethrottle/types.ts#L37-L85

func NewReindexStatus added in v8.5.0 

func NewReindexStatus() *ReindexStatus

NewReindexStatus returns a ReindexStatus.

func (*ReindexStatus) UnmarshalJSON added in v8.7.1 

func (s *ReindexStatus) UnmarshalJSON(data []byte) error

type ReindexTask 

type ReindexTask struct {
	Action             string        `json:"action"`
	Cancellable        bool          `json:"cancellable"`
	Description        string        `json:"description"`
	Headers            HttpHeaders   `json:"headers"`
	Id                 int64         `json:"id"`
	Node               string        `json:"node"`
	RunningTimeInNanos int64         `json:"running_time_in_nanos"`
	StartTimeInMillis  int64         `json:"start_time_in_millis"`
	Status             ReindexStatus `json:"status"`
	Type               string        `json:"type"`
}

ReindexTask type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex_rethrottle/types.ts#L87-L98

func NewReindexTask added in v8.5.0 

func NewReindexTask() *ReindexTask

NewReindexTask returns a ReindexTask.

func (*ReindexTask) UnmarshalJSON added in v8.7.1 

func (s *ReindexTask) UnmarshalJSON(data []byte) error

type ReloadDetails 

type ReloadDetails struct {
	Index             string   `json:"index"`
	ReloadedAnalyzers []string `json:"reloaded_analyzers"`
	ReloadedNodeIds   []string `json:"reloaded_node_ids"`
}

ReloadDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/reload_search_analyzers/types.ts#L27-L31

func NewReloadDetails added in v8.5.0 

func NewReloadDetails() *ReloadDetails

NewReloadDetails returns a ReloadDetails.

func (*ReloadDetails) UnmarshalJSON added in v8.9.0 

func (s *ReloadDetails) UnmarshalJSON(data []byte) error

type ReloadResult added in v8.10.0 

type ReloadResult struct {
	ReloadDetails []ReloadDetails `json:"reload_details"`
	Shards_       ShardStatistics `json:"_shards"`
}

ReloadResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/reload_search_analyzers/types.ts#L22-L25

func NewReloadResult added in v8.10.0 

func NewReloadResult() *ReloadResult

NewReloadResult returns a ReloadResult.

type RelocationFailureInfo added in v8.7.0 

type RelocationFailureInfo struct {
	FailedAttempts int `json:"failed_attempts"`
}

RelocationFailureInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Node.ts#L67-L69

func NewRelocationFailureInfo added in v8.7.0 

func NewRelocationFailureInfo() *RelocationFailureInfo

NewRelocationFailureInfo returns a RelocationFailureInfo.

func (*RelocationFailureInfo) UnmarshalJSON added in v8.7.1 

func (s *RelocationFailureInfo) UnmarshalJSON(data []byte) error

type RemoteClusterInfo added in v8.18.1 

type RemoteClusterInfo struct {
	// ClusterUuid The UUID of the remote cluster.
	ClusterUuid string `json:"cluster_uuid"`
	// IndicesCount The total number of indices in the remote cluster.
	IndicesCount int `json:"indices_count"`
	// IndicesTotalSize Total data set size of all shards assigned to selected nodes, as a
	// human-readable string.
	IndicesTotalSize *string `json:"indices_total_size,omitempty"`
	// IndicesTotalSizeInBytes Total data set size, in bytes, of all shards assigned to selected nodes.
	IndicesTotalSizeInBytes int64 `json:"indices_total_size_in_bytes"`
	// MaxHeap Maximum amount of memory available for use by the heap across the nodes of
	// the remote cluster, as a human-readable string.
	MaxHeap *string `json:"max_heap,omitempty"`
	// MaxHeapInBytes Maximum amount of memory, in bytes, available for use by the heap across the
	// nodes of the remote cluster.
	MaxHeapInBytes int64 `json:"max_heap_in_bytes"`
	// MemTotal Total amount of physical memory across the nodes of the remote cluster, as a
	// human-readable string.
	MemTotal *string `json:"mem_total,omitempty"`
	// MemTotalInBytes Total amount, in bytes, of physical memory across the nodes of the remote
	// cluster.
	MemTotalInBytes int64 `json:"mem_total_in_bytes"`
	// Mode The connection mode used to communicate with the remote cluster.
	Mode string `json:"mode"`
	// NodesCount The total count of nodes in the remote cluster.
	NodesCount int `json:"nodes_count"`
	// ShardsCount The total number of shards in the remote cluster.
	ShardsCount int `json:"shards_count"`
	// SkipUnavailable The `skip_unavailable` setting used for this remote cluster.
	SkipUnavailable bool `json:"skip_unavailable"`
	// Status Health status of the cluster, based on the state of its primary and replica
	// shards.
	Status healthstatus.HealthStatus `json:"status"`
	// TransportCompress Transport compression setting used for this remote cluster.
	TransportCompress string `json:"transport_compress"`
	// Version The list of Elasticsearch versions used by the nodes on the remote cluster.
	Version []string `json:"version"`
}

RemoteClusterInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/stats/types.ts#L608-L639

func NewRemoteClusterInfo added in v8.18.1 

func NewRemoteClusterInfo() *RemoteClusterInfo

NewRemoteClusterInfo returns a RemoteClusterInfo.

func (*RemoteClusterInfo) UnmarshalJSON added in v8.18.1 

func (s *RemoteClusterInfo) UnmarshalJSON(data []byte) error

type RemoteClusterPrivileges added in v8.17.0 

type RemoteClusterPrivileges struct {
	// Clusters A list of cluster aliases to which the permissions in this entry apply.
	Clusters []string `json:"clusters"`
	// Privileges The cluster level privileges that owners of the role have on the remote
	// cluster.
	Privileges []remoteclusterprivilege.RemoteClusterPrivilege `json:"privileges"`
}

RemoteClusterPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L278-L290

func NewRemoteClusterPrivileges added in v8.17.0 

func NewRemoteClusterPrivileges() *RemoteClusterPrivileges

NewRemoteClusterPrivileges returns a RemoteClusterPrivileges.

func (*RemoteClusterPrivileges) UnmarshalJSON added in v8.17.0 

func (s *RemoteClusterPrivileges) UnmarshalJSON(data []byte) error

type RemoteIndicesPrivileges added in v8.16.0 

type RemoteIndicesPrivileges struct {
	// AllowRestrictedIndices Set to `true` if using wildcard or regular expressions for patterns that
	// cover restricted indices. Implicitly, restricted indices have limited
	// privileges that can cause pattern tests to fail. If restricted indices are
	// explicitly included in the `names` list, Elasticsearch checks privileges
	// against these indices regardless of the value set for
	// `allow_restricted_indices`.
	AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
	// Clusters A list of cluster aliases to which the permissions in this entry apply.
	Clusters []string `json:"clusters"`
	// FieldSecurity The document fields that the owners of the role have read access to.
	FieldSecurity *FieldSecurity `json:"field_security,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
	// Privileges The index level privileges that owners of the role have on the specified
	// indices.
	Privileges []indexprivilege.IndexPrivilege `json:"privileges"`
	// Query A search query that defines the documents the owners of the role have access
	// to. A document within the specified indices must match this query for it to
	// be accessible by the owners of the role.
	Query IndicesPrivilegesQuery `json:"query,omitempty"`
}

RemoteIndicesPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L244-L276

func NewRemoteIndicesPrivileges added in v8.16.0 

func NewRemoteIndicesPrivileges() *RemoteIndicesPrivileges

NewRemoteIndicesPrivileges returns a RemoteIndicesPrivileges.

func (*RemoteIndicesPrivileges) UnmarshalJSON added in v8.16.0 

func (s *RemoteIndicesPrivileges) UnmarshalJSON(data []byte) error

type RemoteSource 

type RemoteSource struct {
	// ConnectTimeout The remote connection timeout.
	ConnectTimeout Duration `json:"connect_timeout,omitempty"`
	// Headers An object containing the headers of the request.
	Headers map[string]string `json:"headers,omitempty"`
	// Host The URL for the remote instance of Elasticsearch that you want to index from.
	// This information is required when you're indexing from remote.
	Host string `json:"host"`
	// Password The password to use for authentication with the remote host.
	Password *string `json:"password,omitempty"`
	// SocketTimeout The remote socket read timeout.
	SocketTimeout Duration `json:"socket_timeout,omitempty"`
	// Username The username to use for authentication with the remote host.
	Username *string `json:"username,omitempty"`
}

RemoteSource type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/reindex/types.ts#L112-L140

func NewRemoteSource added in v8.5.0 

func NewRemoteSource() *RemoteSource

NewRemoteSource returns a RemoteSource.

func (*RemoteSource) UnmarshalJSON added in v8.7.1 

func (s *RemoteSource) UnmarshalJSON(data []byte) error

type RemoteUserIndicesPrivileges added in v8.18.0 

type RemoteUserIndicesPrivileges struct {
	// AllowRestrictedIndices Set to `true` if using wildcard or regular expressions for patterns that
	// cover restricted indices. Implicitly, restricted indices have limited
	// privileges that can cause pattern tests to fail. If restricted indices are
	// explicitly included in the `names` list, Elasticsearch checks privileges
	// against these indices regardless of the value set for
	// `allow_restricted_indices`.
	AllowRestrictedIndices bool     `json:"allow_restricted_indices"`
	Clusters               []string `json:"clusters"`
	// FieldSecurity The document fields that the owners of the role have read access to.
	FieldSecurity []FieldSecurity `json:"field_security,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
	// Privileges The index level privileges that owners of the role have on the specified
	// indices.
	Privileges []indexprivilege.IndexPrivilege `json:"privileges"`
	// Query Search queries that define the documents the user has access to. A document
	// within the specified indices must match these queries for it to be accessible
	// by the owners of the role.
	Query []IndicesPrivilegesQuery `json:"query,omitempty"`
}

RemoteUserIndicesPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L316-L339

func NewRemoteUserIndicesPrivileges added in v8.18.0 

func NewRemoteUserIndicesPrivileges() *RemoteUserIndicesPrivileges

NewRemoteUserIndicesPrivileges returns a RemoteUserIndicesPrivileges.

func (*RemoteUserIndicesPrivileges) UnmarshalJSON added in v8.18.0 

func (s *RemoteUserIndicesPrivileges) UnmarshalJSON(data []byte) error

type RemoveAction 

type RemoveAction struct {
	// Alias Alias for the action.
	// Index alias names support date math.
	Alias *string `json:"alias,omitempty"`
	// Aliases Aliases for the action.
	// Index alias names support date math.
	Aliases []string `json:"aliases,omitempty"`
	// Index Data stream or index for the action.
	// Supports wildcards (`*`).
	Index *string `json:"index,omitempty"`
	// Indices Data streams or indices for the action.
	// Supports wildcards (`*`).
	Indices []string `json:"indices,omitempty"`
	// MustExist If `true`, the alias must exist to perform the action.
	MustExist *bool `json:"must_exist,omitempty"`
}

RemoveAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/update_aliases/types.ts#L97-L122

func NewRemoveAction added in v8.5.0 

func NewRemoveAction() *RemoveAction

NewRemoveAction returns a RemoveAction.

func (*RemoveAction) UnmarshalJSON added in v8.7.1 

func (s *RemoveAction) UnmarshalJSON(data []byte) error

type RemoveDuplicatesTokenFilter 

type RemoveDuplicatesTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

RemoveDuplicatesTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L402-L404

func NewRemoveDuplicatesTokenFilter added in v8.5.0 

func NewRemoveDuplicatesTokenFilter() *RemoveDuplicatesTokenFilter

NewRemoveDuplicatesTokenFilter returns a RemoveDuplicatesTokenFilter.

func (RemoveDuplicatesTokenFilter) MarshalJSON added in v8.9.0 

func (s RemoveDuplicatesTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RemoveDuplicatesTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *RemoveDuplicatesTokenFilter) UnmarshalJSON(data []byte) error

type RemoveIndexAction 

type RemoveIndexAction struct {
	// Index Data stream or index for the action.
	// Supports wildcards (`*`).
	Index *string `json:"index,omitempty"`
	// Indices Data streams or indices for the action.
	// Supports wildcards (`*`).
	Indices []string `json:"indices,omitempty"`
	// MustExist If `true`, the alias must exist to perform the action.
	MustExist *bool `json:"must_exist,omitempty"`
}

RemoveIndexAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/update_aliases/types.ts#L124-L139

func NewRemoveIndexAction added in v8.5.0 

func NewRemoveIndexAction() *RemoveIndexAction

NewRemoveIndexAction returns a RemoveIndexAction.

func (*RemoveIndexAction) UnmarshalJSON added in v8.7.1 

func (s *RemoveIndexAction) UnmarshalJSON(data []byte) error

type RemoveProcessor 

type RemoveProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field Fields to be removed. Supports template snippets.
	Field []string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// Keep Fields to be kept. When set, all fields other than those specified are
	// removed.
	Keep []string `json:"keep,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

RemoveProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1358-L1372

func NewRemoveProcessor added in v8.5.0 

func NewRemoveProcessor() *RemoveProcessor

NewRemoveProcessor returns a RemoveProcessor.

func (*RemoveProcessor) UnmarshalJSON added in v8.7.1 

func (s *RemoveProcessor) UnmarshalJSON(data []byte) error

type RenameProcessor 

type RenameProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to be renamed.
	// Supports template snippets.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The new name of the field.
	// Supports template snippets.
	TargetField string `json:"target_field"`
}

RenameProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1374-L1390

func NewRenameProcessor added in v8.5.0 

func NewRenameProcessor() *RenameProcessor

NewRenameProcessor returns a RenameProcessor.

func (*RenameProcessor) UnmarshalJSON added in v8.7.1 

func (s *RenameProcessor) UnmarshalJSON(data []byte) error

type ReplicationAccess added in v8.17.0 

type ReplicationAccess struct {
	// AllowRestrictedIndices This needs to be set to true if the patterns in the names field should cover
	// system indices.
	AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
}

ReplicationAccess type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L442-L452

func NewReplicationAccess added in v8.17.0 

func NewReplicationAccess() *ReplicationAccess

NewReplicationAccess returns a ReplicationAccess.

func (*ReplicationAccess) UnmarshalJSON added in v8.17.0 

func (s *ReplicationAccess) UnmarshalJSON(data []byte) error

type ReportingEmailAttachment 

type ReportingEmailAttachment struct {
	Inline   *bool                       `json:"inline,omitempty"`
	Interval Duration                    `json:"interval,omitempty"`
	Request  *HttpInputRequestDefinition `json:"request,omitempty"`
	Retries  *int                        `json:"retries,omitempty"`
	Url      string                      `json:"url"`
}

ReportingEmailAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L224-L232

func NewReportingEmailAttachment added in v8.5.0 

func NewReportingEmailAttachment() *ReportingEmailAttachment

NewReportingEmailAttachment returns a ReportingEmailAttachment.

func (*ReportingEmailAttachment) UnmarshalJSON added in v8.7.1 

func (s *ReportingEmailAttachment) UnmarshalJSON(data []byte) error

type RepositoriesRecord 

type RepositoriesRecord struct {
	// Id The unique repository identifier.
	Id *string `json:"id,omitempty"`
	// Type The repository type.
	Type *string `json:"type,omitempty"`
}

RepositoriesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/repositories/types.ts#L20-L31

func NewRepositoriesRecord added in v8.5.0 

func NewRepositoriesRecord() *RepositoriesRecord

NewRepositoriesRecord returns a RepositoriesRecord.

func (*RepositoriesRecord) UnmarshalJSON added in v8.9.0 

func (s *RepositoriesRecord) UnmarshalJSON(data []byte) error

type Repository 

type Repository any

Repository holds the union for the following types: 

AzureRepository
GcsRepository
S3Repository
SharedFileSystemRepository
ReadOnlyUrlRepository
SourceOnlyRepository

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L24-L34

type RepositoryIntegrityIndicator added in v8.7.1 

type RepositoryIntegrityIndicator struct {
	Details   *RepositoryIntegrityIndicatorDetails        `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

RepositoryIntegrityIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L136-L140

func NewRepositoryIntegrityIndicator added in v8.7.1 

func NewRepositoryIntegrityIndicator() *RepositoryIntegrityIndicator

NewRepositoryIntegrityIndicator returns a RepositoryIntegrityIndicator.

func (*RepositoryIntegrityIndicator) UnmarshalJSON added in v8.9.0 

func (s *RepositoryIntegrityIndicator) UnmarshalJSON(data []byte) error

type RepositoryIntegrityIndicatorDetails added in v8.7.1 

type RepositoryIntegrityIndicatorDetails struct {
	Corrupted             []string `json:"corrupted,omitempty"`
	CorruptedRepositories *int64   `json:"corrupted_repositories,omitempty"`
	TotalRepositories     *int64   `json:"total_repositories,omitempty"`
}

RepositoryIntegrityIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L141-L145

func NewRepositoryIntegrityIndicatorDetails added in v8.7.1 

func NewRepositoryIntegrityIndicatorDetails() *RepositoryIntegrityIndicatorDetails

NewRepositoryIntegrityIndicatorDetails returns a RepositoryIntegrityIndicatorDetails.

func (*RepositoryIntegrityIndicatorDetails) UnmarshalJSON added in v8.7.1 

func (s *RepositoryIntegrityIndicatorDetails) UnmarshalJSON(data []byte) error

type RepositoryLocation 

type RepositoryLocation struct {
	BasePath string `json:"base_path"`
	// Bucket Bucket name (GCP, S3)
	Bucket *string `json:"bucket,omitempty"`
	// Container Container name (Azure)
	Container *string `json:"container,omitempty"`
}

RepositoryLocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/RepositoryMeteringInformation.ts#L68-L74

func NewRepositoryLocation added in v8.5.0 

func NewRepositoryLocation() *RepositoryLocation

NewRepositoryLocation returns a RepositoryLocation.

func (*RepositoryLocation) UnmarshalJSON added in v8.9.0 

func (s *RepositoryLocation) UnmarshalJSON(data []byte) error

type RepositoryMeteringInformation 

type RepositoryMeteringInformation struct {
	// Archived A flag that tells whether or not this object has been archived. When a
	// repository is closed or updated the
	// repository metering information is archived and kept for a certain period of
	// time. This allows retrieving the
	// repository metering information of previous repository instantiations.
	Archived bool `json:"archived"`
	// ClusterVersion The cluster state version when this object was archived, this field can be
	// used as a logical timestamp to delete
	// all the archived metrics up to an observed version. This field is only
	// present for archived repository metering
	// information objects. The main purpose of this field is to avoid possible race
	// conditions during repository metering
	// information deletions, i.e. deleting archived repositories metering
	// information that we haven’t observed yet.
	ClusterVersion *int64 `json:"cluster_version,omitempty"`
	// RepositoryEphemeralId An identifier that changes every time the repository is updated.
	RepositoryEphemeralId string `json:"repository_ephemeral_id"`
	// RepositoryLocation Represents an unique location within the repository.
	RepositoryLocation RepositoryLocation `json:"repository_location"`
	// RepositoryName Repository name.
	RepositoryName string `json:"repository_name"`
	// RepositoryStartedAt Time the repository was created or updated. Recorded in milliseconds since
	// the Unix Epoch.
	RepositoryStartedAt int64 `json:"repository_started_at"`
	// RepositoryStoppedAt Time the repository was deleted or updated. Recorded in milliseconds since
	// the Unix Epoch.
	RepositoryStoppedAt *int64 `json:"repository_stopped_at,omitempty"`
	// RepositoryType Repository type.
	RepositoryType string `json:"repository_type"`
	// RequestCounts An object with the number of request performed against the repository grouped
	// by request type.
	RequestCounts RequestCounts `json:"request_counts"`
}

RepositoryMeteringInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/RepositoryMeteringInformation.ts#L24-L66

func NewRepositoryMeteringInformation added in v8.5.0 

func NewRepositoryMeteringInformation() *RepositoryMeteringInformation

NewRepositoryMeteringInformation returns a RepositoryMeteringInformation.

func (*RepositoryMeteringInformation) UnmarshalJSON added in v8.7.1 

func (s *RepositoryMeteringInformation) UnmarshalJSON(data []byte) error

type RequestCacheStats 

type RequestCacheStats struct {
	Evictions         int64   `json:"evictions"`
	HitCount          int64   `json:"hit_count"`
	MemorySize        *string `json:"memory_size,omitempty"`
	MemorySizeInBytes int64   `json:"memory_size_in_bytes"`
	MissCount         int64   `json:"miss_count"`
}

RequestCacheStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L247-L253

func NewRequestCacheStats added in v8.5.0 

func NewRequestCacheStats() *RequestCacheStats

NewRequestCacheStats returns a RequestCacheStats.

func (*RequestCacheStats) UnmarshalJSON added in v8.7.1 

func (s *RequestCacheStats) UnmarshalJSON(data []byte) error

type RequestChatCompletion added in v8.18.0 

type RequestChatCompletion struct {
	// MaxCompletionTokens The upper bound limit for the number of tokens that can be generated for a
	// completion request.
	MaxCompletionTokens *int64 `json:"max_completion_tokens,omitempty"`
	// Messages A list of objects representing the conversation.
	// Requests should generally only add new messages from the user (role `user`).
	// The other message roles (`assistant`, `system`, or `tool`) should generally
	// only be copied from the response to a previous completion request, such that
	// the messages array is built up throughout a conversation.
	Messages []Message `json:"messages"`
	// Model The ID of the model to use.
	Model *string `json:"model,omitempty"`
	// Stop A sequence of strings to control when the model should stop generating
	// additional tokens.
	Stop []string `json:"stop,omitempty"`
	// Temperature The sampling temperature to use.
	Temperature *float32 `json:"temperature,omitempty"`
	// ToolChoice Controls which tool is called by the model.
	// String representation: One of `auto`, `none`, or `requrired`. `auto` allows
	// the model to choose between calling tools and generating a message. `none`
	// causes the model to not call any tools. `required` forces the model to call
	// one or more tools.
	// Example (object representation):
	// “`
	//
	//	{
	//	  "tool_choice": {
	//	      "type": "function",
	//	      "function": {
	//	          "name": "get_current_weather"
	//	      }
	//	  }
	//	}
	//
	// “`
	ToolChoice CompletionToolType `json:"tool_choice,omitempty"`
	// Tools A list of tools that the model can call.
	// Example:
	// “`
	//
	//	{
	//	  "tools": [
	//	      {
	//	          "type": "function",
	//	          "function": {
	//	              "name": "get_price_of_item",
	//	              "description": "Get the current price of an item",
	//	              "parameters": {
	//	                  "type": "object",
	//	                  "properties": {
	//	                      "item": {
	//	                          "id": "12345"
	//	                      },
	//	                      "unit": {
	//	                          "type": "currency"
	//	                      }
	//	                  }
	//	              }
	//	          }
	//	      }
	//	  ]
	//	}
	//
	// “`
	Tools []CompletionTool `json:"tools,omitempty"`
	// TopP Nucleus sampling, an alternative to sampling with temperature.
	TopP *float32 `json:"top_p,omitempty"`
}

RequestChatCompletion type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L25-L97

func NewRequestChatCompletion added in v8.18.0 

func NewRequestChatCompletion() *RequestChatCompletion

NewRequestChatCompletion returns a RequestChatCompletion.

func (*RequestChatCompletion) UnmarshalJSON added in v8.18.0 

func (s *RequestChatCompletion) UnmarshalJSON(data []byte) error

type RequestCounts 

type RequestCounts struct {
	// GetBlob Number of Get Blob requests (Azure)
	GetBlob *int64 `json:"GetBlob,omitempty"`
	// GetBlobProperties Number of Get Blob Properties requests (Azure)
	GetBlobProperties *int64 `json:"GetBlobProperties,omitempty"`
	// GetObject Number of get object requests (GCP, S3)
	GetObject *int64 `json:"GetObject,omitempty"`
	// InsertObject Number of insert object requests, including simple, multipart and resumable
	// uploads. Resumable uploads
	// can perform multiple http requests to insert a single object but they are
	// considered as a single request
	// since they are billed as an individual operation. (GCP)
	InsertObject *int64 `json:"InsertObject,omitempty"`
	// ListBlobs Number of List Blobs requests (Azure)
	ListBlobs *int64 `json:"ListBlobs,omitempty"`
	// ListObjects Number of list objects requests (GCP, S3)
	ListObjects *int64 `json:"ListObjects,omitempty"`
	// PutBlob Number of Put Blob requests (Azure)
	PutBlob *int64 `json:"PutBlob,omitempty"`
	// PutBlock Number of Put Block (Azure)
	PutBlock *int64 `json:"PutBlock,omitempty"`
	// PutBlockList Number of Put Block List requests
	PutBlockList *int64 `json:"PutBlockList,omitempty"`
	// PutMultipartObject Number of Multipart requests, including CreateMultipartUpload, UploadPart and
	// CompleteMultipartUpload requests (S3)
	PutMultipartObject *int64 `json:"PutMultipartObject,omitempty"`
	// PutObject Number of PutObject requests (S3)
	PutObject *int64 `json:"PutObject,omitempty"`
}

RequestCounts type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/RepositoryMeteringInformation.ts#L76-L103

func NewRequestCounts added in v8.5.0 

func NewRequestCounts() *RequestCounts

NewRequestCounts returns a RequestCounts.

func (*RequestCounts) UnmarshalJSON added in v8.7.1 

func (s *RequestCounts) UnmarshalJSON(data []byte) error

type RequestItem added in v8.9.0 

type RequestItem any

RequestItem holds the union for the following types: 

MultisearchHeader
TemplateConfig

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch_template/types.ts#L25-L26

type RerankedInferenceResult added in v8.18.1 

type RerankedInferenceResult struct {
	Rerank []RankedDocument `json:"rerank"`
}

RerankedInferenceResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L102-L107

func NewRerankedInferenceResult added in v8.18.1 

func NewRerankedInferenceResult() *RerankedInferenceResult

NewRerankedInferenceResult returns a RerankedInferenceResult.

type RerouteDecision 

type RerouteDecision struct {
	Decider     string `json:"decider"`
	Decision    string `json:"decision"`
	Explanation string `json:"explanation"`
}

RerouteDecision type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L86-L90

func NewRerouteDecision added in v8.5.0 

func NewRerouteDecision() *RerouteDecision

NewRerouteDecision returns a RerouteDecision.

func (*RerouteDecision) UnmarshalJSON added in v8.9.0 

func (s *RerouteDecision) UnmarshalJSON(data []byte) error

type RerouteExplanation 

type RerouteExplanation struct {
	Command    string            `json:"command"`
	Decisions  []RerouteDecision `json:"decisions"`
	Parameters RerouteParameters `json:"parameters"`
}

RerouteExplanation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L92-L96

func NewRerouteExplanation added in v8.5.0 

func NewRerouteExplanation() *RerouteExplanation

NewRerouteExplanation returns a RerouteExplanation.

func (*RerouteExplanation) UnmarshalJSON added in v8.9.0 

func (s *RerouteExplanation) UnmarshalJSON(data []byte) error

type RerouteParameters 

type RerouteParameters struct {
	AllowPrimary bool    `json:"allow_primary"`
	FromNode     *string `json:"from_node,omitempty"`
	Index        string  `json:"index"`
	Node         string  `json:"node"`
	Shard        int     `json:"shard"`
	ToNode       *string `json:"to_node,omitempty"`
}

RerouteParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/reroute/types.ts#L98-L105

func NewRerouteParameters added in v8.5.0 

func NewRerouteParameters() *RerouteParameters

NewRerouteParameters returns a RerouteParameters.

func (*RerouteParameters) UnmarshalJSON added in v8.7.1 

func (s *RerouteParameters) UnmarshalJSON(data []byte) error

type RerouteProcessor added in v8.12.1 

type RerouteProcessor struct {
	// Dataset Field references or a static value for the dataset part of the data stream
	// name.
	// In addition to the criteria for index names, cannot contain - and must be no
	// longer than 100 characters.
	// Example values are nginx.access and nginx.error.
	//
	// Supports field references with a mustache-like syntax (denoted as {{double}}
	// or {{{triple}}} curly braces).
	// When resolving field references, the processor replaces invalid characters
	// with _. Uses the <dataset> part
	// of the index name as a fallback if all field references resolve to a null,
	// missing, or non-string value.
	//
	// default {{data_stream.dataset}}
	Dataset []string `json:"dataset,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Destination A static value for the target. Can’t be set when the dataset or namespace
	// option is set.
	Destination *string `json:"destination,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// Namespace Field references or a static value for the namespace part of the data stream
	// name. See the criteria for
	// index names for allowed characters. Must be no longer than 100 characters.
	//
	// Supports field references with a mustache-like syntax (denoted as {{double}}
	// or {{{triple}}} curly braces).
	// When resolving field references, the processor replaces invalid characters
	// with _. Uses the <namespace> part
	// of the index name as a fallback if all field references resolve to a null,
	// missing, or non-string value.
	//
	// default {{data_stream.namespace}}
	Namespace []string `json:"namespace,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

RerouteProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1392-L1420

func NewRerouteProcessor added in v8.12.1 

func NewRerouteProcessor() *RerouteProcessor

NewRerouteProcessor returns a RerouteProcessor.

func (*RerouteProcessor) UnmarshalJSON added in v8.12.1 

func (s *RerouteProcessor) UnmarshalJSON(data []byte) error

type Rescore 

type Rescore struct {
	LearningToRank *LearningToRank `json:"learning_to_rank,omitempty"`
	Query          *RescoreQuery   `json:"query,omitempty"`
	WindowSize     *int            `json:"window_size,omitempty"`
}

Rescore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/rescoring.ts#L25-L38

func NewRescore added in v8.5.0 

func NewRescore() *Rescore

NewRescore returns a Rescore.

func (*Rescore) UnmarshalJSON added in v8.7.1 

func (s *Rescore) UnmarshalJSON(data []byte) error

type RescoreQuery 

type RescoreQuery struct {
	// Query The query to use for rescoring.
	// This query is only run on the Top-K results returned by the `query` and
	// `post_filter` phases.
	Query Query `json:"rescore_query"`
	// QueryWeight Relative importance of the original query versus the rescore query.
	QueryWeight *Float64 `json:"query_weight,omitempty"`
	// RescoreQueryWeight Relative importance of the rescore query versus the original query.
	RescoreQueryWeight *Float64 `json:"rescore_query_weight,omitempty"`
	// ScoreMode Determines how scores are combined.
	ScoreMode *scoremode.ScoreMode `json:"score_mode,omitempty"`
}

RescoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/rescoring.ts#L40-L62

func NewRescoreQuery added in v8.5.0 

func NewRescoreQuery() *RescoreQuery

NewRescoreQuery returns a RescoreQuery.

func (*RescoreQuery) UnmarshalJSON added in v8.7.1 

func (s *RescoreQuery) UnmarshalJSON(data []byte) error

type RescoreVector added in v8.18.0 

type RescoreVector struct {
	// Oversample Applies the specified oversample factor to k on the approximate kNN search
	Oversample float32 `json:"oversample"`
}

RescoreVector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Knn.ts#L30-L33

func NewRescoreVector added in v8.18.0 

func NewRescoreVector() *RescoreVector

NewRescoreVector returns a RescoreVector.

func (*RescoreVector) UnmarshalJSON added in v8.18.0 

func (s *RescoreVector) UnmarshalJSON(data []byte) error

type RescorerRetriever added in v8.18.1 

type RescorerRetriever struct {
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_   *string   `json:"_name,omitempty"`
	Rescore []Rescore `json:"rescore"`
	// Retriever Inner retriever.
	Retriever *RetrieverContainer `json:"retriever,omitempty"`
}

RescorerRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L62-L66

func NewRescorerRetriever added in v8.18.1 

func NewRescorerRetriever() *RescorerRetriever

NewRescorerRetriever returns a RescorerRetriever.

func (*RescorerRetriever) UnmarshalJSON added in v8.18.1 

func (s *RescorerRetriever) UnmarshalJSON(data []byte) error

type ReservedSize 

type ReservedSize struct {
	NodeId string   `json:"node_id"`
	Path   string   `json:"path"`
	Shards []string `json:"shards"`
	Total  int64    `json:"total"`
}

ReservedSize type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L72-L77

func NewReservedSize added in v8.5.0 

func NewReservedSize() *ReservedSize

NewReservedSize returns a ReservedSize.

func (*ReservedSize) UnmarshalJSON added in v8.7.1 

func (s *ReservedSize) UnmarshalJSON(data []byte) error

type ResolveClusterInfo added in v8.13.0 

type ResolveClusterInfo struct {
	// Connected Whether the remote cluster is connected to the local (querying) cluster.
	Connected bool `json:"connected"`
	// Error Provides error messages that are likely to occur if you do a search with this
	// index expression
	// on the specified cluster (for example, lack of security privileges to query
	// an index).
	Error *string `json:"error,omitempty"`
	// MatchingIndices Whether the index expression provided in the request matches any indices,
	// aliases or data streams
	// on the cluster.
	MatchingIndices *bool `json:"matching_indices,omitempty"`
	// SkipUnavailable The `skip_unavailable` setting for a remote cluster.
	SkipUnavailable bool `json:"skip_unavailable"`
	// Version Provides version information about the cluster.
	Version *ElasticsearchVersionMinInfo `json:"version,omitempty"`
}

ResolveClusterInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/resolve_cluster/ResolveClusterResponse.ts#L29-L55

func NewResolveClusterInfo added in v8.13.0 

func NewResolveClusterInfo() *ResolveClusterInfo

NewResolveClusterInfo returns a ResolveClusterInfo.

func (*ResolveClusterInfo) UnmarshalJSON added in v8.13.0 

func (s *ResolveClusterInfo) UnmarshalJSON(data []byte) error

type ResolveIndexAliasItem 

type ResolveIndexAliasItem struct {
	Indices []string `json:"indices"`
	Name    string   `json:"name"`
}

ResolveIndexAliasItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/resolve_index/ResolveIndexResponse.ts#L37-L40

func NewResolveIndexAliasItem added in v8.5.0 

func NewResolveIndexAliasItem() *ResolveIndexAliasItem

NewResolveIndexAliasItem returns a ResolveIndexAliasItem.

func (*ResolveIndexAliasItem) UnmarshalJSON added in v8.7.1 

func (s *ResolveIndexAliasItem) UnmarshalJSON(data []byte) error

type ResolveIndexDataStreamsItem 

type ResolveIndexDataStreamsItem struct {
	BackingIndices []string `json:"backing_indices"`
	Name           string   `json:"name"`
	TimestampField string   `json:"timestamp_field"`
}

ResolveIndexDataStreamsItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/resolve_index/ResolveIndexResponse.ts#L42-L46

func NewResolveIndexDataStreamsItem added in v8.5.0 

func NewResolveIndexDataStreamsItem() *ResolveIndexDataStreamsItem

NewResolveIndexDataStreamsItem returns a ResolveIndexDataStreamsItem.

func (*ResolveIndexDataStreamsItem) UnmarshalJSON added in v8.7.1 

func (s *ResolveIndexDataStreamsItem) UnmarshalJSON(data []byte) error

type ResolveIndexItem 

type ResolveIndexItem struct {
	Aliases    []string `json:"aliases,omitempty"`
	Attributes []string `json:"attributes"`
	DataStream *string  `json:"data_stream,omitempty"`
	Name       string   `json:"name"`
}

ResolveIndexItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/resolve_index/ResolveIndexResponse.ts#L30-L35

func NewResolveIndexItem added in v8.5.0 

func NewResolveIndexItem() *ResolveIndexItem

NewResolveIndexItem returns a ResolveIndexItem.

func (*ResolveIndexItem) UnmarshalJSON added in v8.7.1 

func (s *ResolveIndexItem) UnmarshalJSON(data []byte) error

type ResourcePrivileges 

type ResourcePrivileges map[string]Privileges

ResourcePrivileges type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/has_privileges/types.ts#L48-L48

type ResponseBody 

type ResponseBody struct {
	Aggregations map[string]Aggregate       `json:"aggregations,omitempty"`
	Clusters_    *ClusterStatistics         `json:"_clusters,omitempty"`
	Fields       map[string]json.RawMessage `json:"fields,omitempty"`
	// Hits The returned documents and metadata.
	Hits            HitsMetadata `json:"hits"`
	MaxScore        *Float64     `json:"max_score,omitempty"`
	NumReducePhases *int64       `json:"num_reduce_phases,omitempty"`
	PitId           *string      `json:"pit_id,omitempty"`
	Profile         *Profile     `json:"profile,omitempty"`
	// ScrollId_ The identifier for the search and its search context.
	// You can use this scroll ID with the scroll API to retrieve the next batch of
	// search results for the request.
	// This property is returned only if the `scroll` query parameter is specified
	// in the request.
	ScrollId_ *string `json:"_scroll_id,omitempty"`
	// Shards_ A count of shards used for the request.
	Shards_         ShardStatistics      `json:"_shards"`
	Suggest         map[string][]Suggest `json:"suggest,omitempty"`
	TerminatedEarly *bool                `json:"terminated_early,omitempty"`
	// TimedOut If `true`, the request timed out before completion; returned results may be
	// partial or empty.
	TimedOut bool `json:"timed_out"`
	// Took The number of milliseconds it took Elasticsearch to run the request.
	// This value is calculated by measuring the time elapsed between receipt of a
	// request on the coordinating node and the time at which the coordinating node
	// is ready to send the response.
	// It includes:
	//
	// * Communication time between the coordinating node and data nodes
	// * Time the request spends in the search thread pool, queued for execution
	// * Actual run time
	//
	// It does not include:
	//
	// * Time needed to send the request to Elasticsearch
	// * Time needed to serialize the JSON response
	// * Time needed to send the response to a client
	Took int64 `json:"took"`
}

ResponseBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/SearchResponse.ts#L38-L84

func NewResponseBody added in v8.5.0 

func NewResponseBody() *ResponseBody

NewResponseBody returns a ResponseBody.

func (*ResponseBody) UnmarshalJSON added in v8.7.0 

func (s *ResponseBody) UnmarshalJSON(data []byte) error

type ResponseItem 

type ResponseItem struct {
	// Error Additional information about the failed operation.
	// The property is returned only for failed operations.
	Error         *ErrorCause                            `json:"error,omitempty"`
	FailureStore  *failurestorestatus.FailureStoreStatus `json:"failure_store,omitempty"`
	ForcedRefresh *bool                                  `json:"forced_refresh,omitempty"`
	Get           *InlineGetDictUserDefined              `json:"get,omitempty"`
	// Id_ The document ID associated with the operation.
	Id_ *string `json:"_id,omitempty"`
	// Index_ The name of the index associated with the operation.
	// If the operation targeted a data stream, this is the backing index into which
	// the document was written.
	Index_ string `json:"_index"`
	// PrimaryTerm_ The primary term assigned to the document for the operation.
	// This property is returned only for successful operations.
	PrimaryTerm_ *int64 `json:"_primary_term,omitempty"`
	// Result The result of the operation.
	// Successful values are `created`, `deleted`, and `updated`.
	Result *string `json:"result,omitempty"`
	// SeqNo_ The sequence number assigned to the document for the operation.
	// Sequence numbers are used to ensure an older version of a document doesn't
	// overwrite a newer version.
	SeqNo_ *int64 `json:"_seq_no,omitempty"`
	// Shards_ Shard information for the operation.
	Shards_ *ShardStatistics `json:"_shards,omitempty"`
	// Status The HTTP status code returned for the operation.
	Status int `json:"status"`
	// Version_ The document version associated with the operation.
	// The document version is incremented each time the document is updated.
	// This property is returned only for successful actions.
	Version_ *int64 `json:"_version,omitempty"`
}

ResponseItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L37-L84

func NewResponseItem added in v8.9.0 

func NewResponseItem() *ResponseItem

NewResponseItem returns a ResponseItem.

func (*ResponseItem) UnmarshalJSON added in v8.9.0 

func (s *ResponseItem) UnmarshalJSON(data []byte) error

type Restriction added in v8.17.0 

type Restriction struct {
	// Workflows A list of workflows to which the API key is restricted.
	// NOTE: In order to use a role restriction, an API key must be created with a
	// single role descriptor.
	Workflows []restrictionworkflow.RestrictionWorkflow `json:"workflows"`
}

Restriction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleDescriptor.ts#L135-L141

func NewRestriction added in v8.17.0 

func NewRestriction() *Restriction

NewRestriction returns a Restriction.

type Retention 

type Retention struct {
	// ExpireAfter Time period after which a snapshot is considered expired and eligible for
	// deletion. SLM deletes expired snapshots based on the slm.retention_schedule.
	ExpireAfter Duration `json:"expire_after"`
	// MaxCount Maximum number of snapshots to retain, even if the snapshots have not yet
	// expired. If the number of snapshots in the repository exceeds this limit, the
	// policy retains the most recent snapshots and deletes older snapshots.
	MaxCount int `json:"max_count"`
	// MinCount Minimum number of snapshots to retain, even if the snapshots have expired.
	MinCount int `json:"min_count"`
}

Retention type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L94-L107

func NewRetention added in v8.5.0 

func NewRetention() *Retention

NewRetention returns a Retention.

func (*Retention) UnmarshalJSON added in v8.7.1 

func (s *Retention) UnmarshalJSON(data []byte) error

type RetentionLease 

type RetentionLease struct {
	Period Duration `json:"period"`
}

RetentionLease type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L66-L68

func NewRetentionLease added in v8.5.0 

func NewRetentionLease() *RetentionLease

NewRetentionLease returns a RetentionLease.

func (*RetentionLease) UnmarshalJSON added in v8.7.1 

func (s *RetentionLease) UnmarshalJSON(data []byte) error

type RetentionPolicy 

type RetentionPolicy struct {
	// Field The date field that is used to calculate the age of the document.
	Field string `json:"field"`
	// MaxAge Specifies the maximum age of a document in the destination index. Documents
	// that are older than the configured
	// value are removed from the destination index.
	MaxAge Duration `json:"max_age"`
}

RetentionPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L88-L96

func NewRetentionPolicy added in v8.5.0 

func NewRetentionPolicy() *RetentionPolicy

NewRetentionPolicy returns a RetentionPolicy.

func (*RetentionPolicy) UnmarshalJSON added in v8.7.1 

func (s *RetentionPolicy) UnmarshalJSON(data []byte) error

type RetentionPolicyContainer 

type RetentionPolicyContainer struct {
	// Time Specifies that the transform uses a time field to set the retention policy.
	Time *RetentionPolicy `json:"time,omitempty"`
}

RetentionPolicyContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L80-L86

func NewRetentionPolicyContainer added in v8.5.0 

func NewRetentionPolicyContainer() *RetentionPolicyContainer

NewRetentionPolicyContainer returns a RetentionPolicyContainer.

type Retries 

type Retries struct {
	// Bulk The number of bulk actions retried.
	Bulk int64 `json:"bulk"`
	// Search The number of search actions retried.
	Search int64 `json:"search"`
}

Retries type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retries.ts#L22-L31

func NewRetries added in v8.5.0 

func NewRetries() *Retries

NewRetries returns a Retries.

func (*Retries) UnmarshalJSON added in v8.7.1 

func (s *Retries) UnmarshalJSON(data []byte) error

type RetrieverContainer added in v8.14.0 

type RetrieverContainer struct {
	// Knn A retriever that replaces the functionality  of a knn search.
	Knn *KnnRetriever `json:"knn,omitempty"`
	// Linear A retriever that supports the combination of different retrievers through a
	// weighted linear combination.
	Linear *LinearRetriever `json:"linear,omitempty"`
	// Pinned A pinned retriever applies pinned documents to the underlying retriever.
	// This retriever will rewrite to a PinnedQueryBuilder.
	Pinned *PinnedRetriever `json:"pinned,omitempty"`
	// Rescorer A retriever that re-scores only the results produced by its child retriever.
	Rescorer *RescorerRetriever `json:"rescorer,omitempty"`
	// Rrf A retriever that produces top documents from reciprocal rank fusion (RRF).
	Rrf *RRFRetriever `json:"rrf,omitempty"`
	// Rule A retriever that replaces the functionality of a rule query.
	Rule *RuleRetriever `json:"rule,omitempty"`
	// Standard A retriever that replaces the functionality of a traditional query.
	Standard *StandardRetriever `json:"standard,omitempty"`
	// TextSimilarityReranker A retriever that reranks the top documents based on a reranking model using
	// the InferenceAPI
	TextSimilarityReranker *TextSimilarityReranker `json:"text_similarity_reranker,omitempty"`
}

RetrieverContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L28-L51

func NewRetrieverContainer added in v8.14.0 

func NewRetrieverContainer() *RetrieverContainer

NewRetrieverContainer returns a RetrieverContainer.

type ReverseNestedAggregate 

type ReverseNestedAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

ReverseNestedAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L540-L544

func NewReverseNestedAggregate added in v8.5.0 

func NewReverseNestedAggregate() *ReverseNestedAggregate

NewReverseNestedAggregate returns a ReverseNestedAggregate.

func (ReverseNestedAggregate) MarshalJSON 

func (s ReverseNestedAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ReverseNestedAggregate) UnmarshalJSON added in v8.7.0 

func (s *ReverseNestedAggregate) UnmarshalJSON(data []byte) error

type ReverseNestedAggregation 

type ReverseNestedAggregation struct {
	// Path Defines the nested object field that should be joined back to.
	// The default is empty, which means that it joins back to the root/main
	// document level.
	Path *string `json:"path,omitempty"`
}

ReverseNestedAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L741-L747

func NewReverseNestedAggregation added in v8.5.0 

func NewReverseNestedAggregation() *ReverseNestedAggregation

NewReverseNestedAggregation returns a ReverseNestedAggregation.

func (*ReverseNestedAggregation) UnmarshalJSON added in v8.7.1 

func (s *ReverseNestedAggregation) UnmarshalJSON(data []byte) error

type ReverseTokenFilter 

type ReverseTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ReverseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L406-L408

func NewReverseTokenFilter added in v8.5.0 

func NewReverseTokenFilter() *ReverseTokenFilter

NewReverseTokenFilter returns a ReverseTokenFilter.

func (ReverseTokenFilter) MarshalJSON added in v8.9.0 

func (s ReverseTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ReverseTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *ReverseTokenFilter) UnmarshalJSON(data []byte) error

type Role 

type Role struct {
	Applications      []ApplicationPrivileges                   `json:"applications"`
	Cluster           []clusterprivilege.ClusterPrivilege       `json:"cluster"`
	Description       *string                                   `json:"description,omitempty"`
	Global            map[string]map[string]map[string][]string `json:"global,omitempty"`
	Indices           []IndicesPrivileges                       `json:"indices"`
	Metadata          Metadata                                  `json:"metadata"`
	RemoteCluster     []RemoteClusterPrivileges                 `json:"remote_cluster,omitempty"`
	RemoteIndices     []RemoteIndicesPrivileges                 `json:"remote_indices,omitempty"`
	RoleTemplates     []RoleTemplate                            `json:"role_templates,omitempty"`
	RunAs             []string                                  `json:"run_as,omitempty"`
	TransientMetadata map[string]json.RawMessage                `json:"transient_metadata,omitempty"`
}

Role type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_role/types.ts#L32-L54

func NewRole added in v8.5.0 

func NewRole() *Role

NewRole returns a Role.

func (*Role) UnmarshalJSON added in v8.7.1 

func (s *Role) UnmarshalJSON(data []byte) error

type RoleDescriptor 

type RoleDescriptor struct {
	// Applications A list of application privilege entries
	Applications []ApplicationPrivileges `json:"applications,omitempty"`
	// Cluster A list of cluster privileges. These privileges define the cluster level
	// actions that API keys are able to execute.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster,omitempty"`
	// Description Optional description of the role descriptor
	Description *string `json:"description,omitempty"`
	// Global An object defining global privileges. A global privilege is a form of cluster
	// privilege that is request-aware. Support for global privileges is currently
	// limited to the management of application privileges.
	Global []GlobalPrivilege `json:"global,omitempty"`
	// Indices A list of indices permissions entries.
	Indices []IndicesPrivileges `json:"indices,omitempty"`
	// Metadata Optional meta-data. Within the metadata object, keys that begin with `_` are
	// reserved for system usage.
	Metadata Metadata `json:"metadata,omitempty"`
	// RemoteCluster A list of cluster permissions for remote clusters.
	// NOTE: This is limited a subset of the cluster permissions.
	RemoteCluster []RemoteClusterPrivileges `json:"remote_cluster,omitempty"`
	// RemoteIndices A list of indices permissions for remote clusters.
	RemoteIndices []RemoteIndicesPrivileges `json:"remote_indices,omitempty"`
	// Restriction Restriction for when the role descriptor is allowed to be effective.
	Restriction *Restriction `json:"restriction,omitempty"`
	// RunAs A list of users that the API keys can impersonate.
	// NOTE: In Elastic Cloud Serverless, the run-as feature is disabled.
	// For API compatibility, you can still specify an empty `run_as` field, but a
	// non-empty list will be rejected.
	RunAs             []string                   `json:"run_as,omitempty"`
	TransientMetadata map[string]json.RawMessage `json:"transient_metadata,omitempty"`
}

RoleDescriptor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleDescriptor.ts#L33-L83

func NewRoleDescriptor added in v8.5.0 

func NewRoleDescriptor() *RoleDescriptor

NewRoleDescriptor returns a RoleDescriptor.

func (*RoleDescriptor) UnmarshalJSON added in v8.7.1 

func (s *RoleDescriptor) UnmarshalJSON(data []byte) error

type RoleDescriptorRead 

type RoleDescriptorRead struct {
	// Applications A list of application privilege entries
	Applications []ApplicationPrivileges `json:"applications,omitempty"`
	// Cluster A list of cluster privileges. These privileges define the cluster level
	// actions that API keys are able to execute.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster"`
	// Description An optional description of the role descriptor.
	Description *string `json:"description,omitempty"`
	// Global An object defining global privileges. A global privilege is a form of cluster
	// privilege that is request-aware. Support for global privileges is currently
	// limited to the management of application privileges.
	Global []GlobalPrivilege `json:"global,omitempty"`
	// Indices A list of indices permissions entries.
	Indices []IndicesPrivileges `json:"indices"`
	// Metadata Optional meta-data. Within the metadata object, keys that begin with `_` are
	// reserved for system usage.
	Metadata Metadata `json:"metadata,omitempty"`
	// RemoteCluster A list of cluster permissions for remote clusters.
	// NOTE: This is limited a subset of the cluster permissions.
	RemoteCluster []RemoteClusterPrivileges `json:"remote_cluster,omitempty"`
	// RemoteIndices A list of indices permissions for remote clusters.
	RemoteIndices []RemoteIndicesPrivileges `json:"remote_indices,omitempty"`
	// Restriction A restriction for when the role descriptor is allowed to be effective.
	Restriction *Restriction `json:"restriction,omitempty"`
	// RunAs A list of users that the API keys can impersonate.
	RunAs             []string                   `json:"run_as,omitempty"`
	TransientMetadata map[string]json.RawMessage `json:"transient_metadata,omitempty"`
}

RoleDescriptorRead type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleDescriptor.ts#L85-L133

func NewRoleDescriptorRead added in v8.5.0 

func NewRoleDescriptorRead() *RoleDescriptorRead

NewRoleDescriptorRead returns a RoleDescriptorRead.

func (*RoleDescriptorRead) UnmarshalJSON added in v8.7.1 

func (s *RoleDescriptorRead) UnmarshalJSON(data []byte) error

type RoleDescriptorWrapper 

type RoleDescriptorWrapper struct {
	RoleDescriptor RoleDescriptorRead `json:"role_descriptor"`
}

RoleDescriptorWrapper type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_service_accounts/types.ts#L22-L24

func NewRoleDescriptorWrapper added in v8.5.0 

func NewRoleDescriptorWrapper() *RoleDescriptorWrapper

NewRoleDescriptorWrapper returns a RoleDescriptorWrapper.

type RoleMappingRule 

type RoleMappingRule struct {
	All    []RoleMappingRule `json:"all,omitempty"`
	Any    []RoleMappingRule `json:"any,omitempty"`
	Except *RoleMappingRule  `json:"except,omitempty"`
	Field  *FieldRule        `json:"field,omitempty"`
}

RoleMappingRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleMappingRule.ts#L22-L33

func NewRoleMappingRule added in v8.5.0 

func NewRoleMappingRule() *RoleMappingRule

NewRoleMappingRule returns a RoleMappingRule.

type RoleQueryContainer added in v8.15.0 

type RoleQueryContainer struct {
	// Bool matches roles matching boolean combinations of other queries.
	Bool *BoolQuery `json:"bool,omitempty"`
	// Exists Returns roles that contain an indexed value for a field.
	Exists *ExistsQuery `json:"exists,omitempty"`
	// Ids Returns roles based on their IDs.
	// This query uses role document IDs stored in the `_id` field.
	Ids *IdsQuery `json:"ids,omitempty"`
	// Match Returns roles that match a provided text, number, date or boolean value.
	// The provided text is analyzed before matching.
	Match map[string]MatchQuery `json:"match,omitempty"`
	// MatchAll Matches all roles, giving them all a `_score` of 1.0.
	MatchAll *MatchAllQuery `json:"match_all,omitempty"`
	// Prefix Returns roles that contain a specific prefix in a provided field.
	Prefix map[string]PrefixQuery `json:"prefix,omitempty"`
	// Range Returns roles that contain terms within a provided range.
	Range map[string]RangeQuery `json:"range,omitempty"`
	// SimpleQueryString Returns roles based on a provided query string, using a parser with a limited
	// but fault-tolerant syntax.
	SimpleQueryString *SimpleQueryStringQuery `json:"simple_query_string,omitempty"`
	// Term Returns roles that contain an exact term in a provided field.
	// To return a document, the query term must exactly match the queried field's
	// value, including whitespace and capitalization.
	Term map[string]TermQuery `json:"term,omitempty"`
	// Terms Returns roles that contain one or more exact terms in a provided field.
	// To return a document, one or more terms must exactly match a field value,
	// including whitespace and capitalization.
	Terms *TermsQuery `json:"terms,omitempty"`
	// Wildcard Returns roles that contain terms matching a wildcard pattern.
	Wildcard map[string]WildcardQuery `json:"wildcard,omitempty"`
}

RoleQueryContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_role/types.ts#L37-L101

func NewRoleQueryContainer added in v8.15.0 

func NewRoleQueryContainer() *RoleQueryContainer

NewRoleQueryContainer returns a RoleQueryContainer.

func (*RoleQueryContainer) UnmarshalJSON added in v8.15.0 

func (s *RoleQueryContainer) UnmarshalJSON(data []byte) error

type RoleTemplate 

type RoleTemplate struct {
	Format   *templateformat.TemplateFormat `json:"format,omitempty"`
	Template Script                         `json:"template"`
}

RoleTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleTemplate.ts#L28-L31

func NewRoleTemplate added in v8.5.0 

func NewRoleTemplate() *RoleTemplate

NewRoleTemplate returns a RoleTemplate.

type RoleTemplateInlineQuery added in v8.5.0 

type RoleTemplateInlineQuery any

RoleTemplateInlineQuery holds the union for the following types: 

string
Query

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L383-L384

type RoleTemplateQuery 

type RoleTemplateQuery struct {
	// Template When you create a role, you can specify a query that defines the document
	// level security permissions. You can optionally
	// use Mustache templates in the role query to insert the username of the
	// current authenticated user into the role.
	// Like other places in Elasticsearch that support templating or scripting, you
	// can specify inline, stored, or file-based
	// templates and define custom parameters. You access the details for the
	// current authenticated user through the _user parameter.
	Template *RoleTemplateScript `json:"template,omitempty"`
}

RoleTemplateQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L351-L361

func NewRoleTemplateQuery added in v8.5.0 

func NewRoleTemplateQuery() *RoleTemplateQuery

NewRoleTemplateQuery returns a RoleTemplateQuery.

type RoleTemplateScript 

type RoleTemplateScript struct {
	// Id The `id` for a stored script.
	Id *string `json:"id,omitempty"`
	// Lang Specifies the language the script is written in.
	Lang    *scriptlanguage.ScriptLanguage `json:"lang,omitempty"`
	Options map[string]string              `json:"options,omitempty"`
	// Params Specifies any named parameters that are passed into the script as variables.
	// Use parameters instead of hard-coded values to decrease compile time.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	Source RoleTemplateInlineQuery    `json:"source,omitempty"`
}

RoleTemplateScript type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L363-L381

func NewRoleTemplateScript added in v8.15.0 

func NewRoleTemplateScript() *RoleTemplateScript

NewRoleTemplateScript returns a RoleTemplateScript.

func (*RoleTemplateScript) UnmarshalJSON added in v8.15.0 

func (s *RoleTemplateScript) UnmarshalJSON(data []byte) error

type RolloverAction added in v8.15.0 

type RolloverAction struct {
	MaxAge              Duration `json:"max_age,omitempty"`
	MaxDocs             *int64   `json:"max_docs,omitempty"`
	MaxPrimaryShardDocs *int64   `json:"max_primary_shard_docs,omitempty"`
	MaxPrimaryShardSize ByteSize `json:"max_primary_shard_size,omitempty"`
	MaxSize             ByteSize `json:"max_size,omitempty"`
	MinAge              Duration `json:"min_age,omitempty"`
	MinDocs             *int64   `json:"min_docs,omitempty"`
	MinPrimaryShardDocs *int64   `json:"min_primary_shard_docs,omitempty"`
	MinPrimaryShardSize ByteSize `json:"min_primary_shard_size,omitempty"`
	MinSize             ByteSize `json:"min_size,omitempty"`
}

RolloverAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L99-L110

func NewRolloverAction added in v8.15.0 

func NewRolloverAction() *RolloverAction

NewRolloverAction returns a RolloverAction.

func (*RolloverAction) UnmarshalJSON added in v8.15.0 

func (s *RolloverAction) UnmarshalJSON(data []byte) error

type RolloverConditions 

type RolloverConditions struct {
	MaxAge                   Duration `json:"max_age,omitempty"`
	MaxAgeMillis             *int64   `json:"max_age_millis,omitempty"`
	MaxDocs                  *int64   `json:"max_docs,omitempty"`
	MaxPrimaryShardDocs      *int64   `json:"max_primary_shard_docs,omitempty"`
	MaxPrimaryShardSize      ByteSize `json:"max_primary_shard_size,omitempty"`
	MaxPrimaryShardSizeBytes *int64   `json:"max_primary_shard_size_bytes,omitempty"`
	MaxSize                  ByteSize `json:"max_size,omitempty"`
	MaxSizeBytes             *int64   `json:"max_size_bytes,omitempty"`
	MinAge                   Duration `json:"min_age,omitempty"`
	MinDocs                  *int64   `json:"min_docs,omitempty"`
	MinPrimaryShardDocs      *int64   `json:"min_primary_shard_docs,omitempty"`
	MinPrimaryShardSize      ByteSize `json:"min_primary_shard_size,omitempty"`
	MinPrimaryShardSizeBytes *int64   `json:"min_primary_shard_size_bytes,omitempty"`
	MinSize                  ByteSize `json:"min_size,omitempty"`
	MinSizeBytes             *int64   `json:"min_size_bytes,omitempty"`
}

RolloverConditions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/rollover/types.ts#L24-L40

func NewRolloverConditions added in v8.5.0 

func NewRolloverConditions() *RolloverConditions

NewRolloverConditions returns a RolloverConditions.

func (*RolloverConditions) UnmarshalJSON added in v8.7.1 

func (s *RolloverConditions) UnmarshalJSON(data []byte) error

type RollupCapabilities 

type RollupCapabilities struct {
	// RollupJobs There can be multiple, independent jobs configured for a single index or
	// index pattern. Each of these jobs may have different configurations, so the
	// API returns a list of all the various configurations available.
	RollupJobs []RollupCapabilitySummary `json:"rollup_jobs"`
}

RollupCapabilities type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_caps/types.ts#L24-L29

func NewRollupCapabilities added in v8.5.0 

func NewRollupCapabilities() *RollupCapabilities

NewRollupCapabilities returns a RollupCapabilities.

type RollupCapabilitySummary 

type RollupCapabilitySummary struct {
	Fields       map[string][]RollupFieldSummary `json:"fields"`
	IndexPattern string                          `json:"index_pattern"`
	JobId        string                          `json:"job_id"`
	RollupIndex  string                          `json:"rollup_index"`
}

RollupCapabilitySummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_caps/types.ts#L31-L36

func NewRollupCapabilitySummary added in v8.5.0 

func NewRollupCapabilitySummary() *RollupCapabilitySummary

NewRollupCapabilitySummary returns a RollupCapabilitySummary.

func (*RollupCapabilitySummary) UnmarshalJSON added in v8.7.1 

func (s *RollupCapabilitySummary) UnmarshalJSON(data []byte) error

type RollupFieldSummary added in v8.7.0 

type RollupFieldSummary struct {
	Agg              string   `json:"agg"`
	CalendarInterval Duration `json:"calendar_interval,omitempty"`
	TimeZone         *string  `json:"time_zone,omitempty"`
}

RollupFieldSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_caps/types.ts#L38-L42

func NewRollupFieldSummary added in v8.7.0 

func NewRollupFieldSummary() *RollupFieldSummary

NewRollupFieldSummary returns a RollupFieldSummary.

func (*RollupFieldSummary) UnmarshalJSON added in v8.7.1 

func (s *RollupFieldSummary) UnmarshalJSON(data []byte) error

type RollupJob 

type RollupJob struct {
	// Config The rollup job configuration.
	Config RollupJobConfiguration `json:"config"`
	// Stats Transient statistics about the rollup job, such as how many documents have
	// been processed and how many rollup summary docs have been indexed.
	// These stats are not persisted.
	// If a node is restarted, these stats are reset.
	Stats RollupJobStats `json:"stats"`
	// Status The current status of the indexer for the rollup job.
	Status RollupJobStatus `json:"status"`
}

RollupJob type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_jobs/types.ts#L28-L43

func NewRollupJob added in v8.5.0 

func NewRollupJob() *RollupJob

NewRollupJob returns a RollupJob.

type RollupJobConfiguration 

type RollupJobConfiguration struct {
	Cron         string        `json:"cron"`
	Groups       Groupings     `json:"groups"`
	Id           string        `json:"id"`
	IndexPattern string        `json:"index_pattern"`
	Metrics      []FieldMetric `json:"metrics"`
	PageSize     int64         `json:"page_size"`
	RollupIndex  string        `json:"rollup_index"`
	Timeout      Duration      `json:"timeout"`
}

RollupJobConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_jobs/types.ts#L45-L54

func NewRollupJobConfiguration added in v8.5.0 

func NewRollupJobConfiguration() *RollupJobConfiguration

NewRollupJobConfiguration returns a RollupJobConfiguration.

func (*RollupJobConfiguration) UnmarshalJSON added in v8.7.1 

func (s *RollupJobConfiguration) UnmarshalJSON(data []byte) error

type RollupJobStats 

type RollupJobStats struct {
	DocumentsProcessed int64 `json:"documents_processed"`
	IndexFailures      int64 `json:"index_failures"`
	IndexTimeInMs      int64 `json:"index_time_in_ms"`
	IndexTotal         int64 `json:"index_total"`
	PagesProcessed     int64 `json:"pages_processed"`
	ProcessingTimeInMs int64 `json:"processing_time_in_ms"`
	ProcessingTotal    int64 `json:"processing_total"`
	RollupsIndexed     int64 `json:"rollups_indexed"`
	SearchFailures     int64 `json:"search_failures"`
	SearchTimeInMs     int64 `json:"search_time_in_ms"`
	SearchTotal        int64 `json:"search_total"`
	TriggerCount       int64 `json:"trigger_count"`
}

RollupJobStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_jobs/types.ts#L56-L69

func NewRollupJobStats added in v8.5.0 

func NewRollupJobStats() *RollupJobStats

NewRollupJobStats returns a RollupJobStats.

func (*RollupJobStats) UnmarshalJSON added in v8.7.1 

func (s *RollupJobStats) UnmarshalJSON(data []byte) error

type RollupJobStatus 

type RollupJobStatus struct {
	CurrentPosition map[string]json.RawMessage        `json:"current_position,omitempty"`
	JobState        indexingjobstate.IndexingJobState `json:"job_state"`
	UpgradedDocId   *bool                             `json:"upgraded_doc_id,omitempty"`
}

RollupJobStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_jobs/types.ts#L71-L75

func NewRollupJobStatus added in v8.5.0 

func NewRollupJobStatus() *RollupJobStatus

NewRollupJobStatus returns a RollupJobStatus.

func (*RollupJobStatus) UnmarshalJSON added in v8.7.1 

func (s *RollupJobStatus) UnmarshalJSON(data []byte) error

type RollupJobSummary 

type RollupJobSummary struct {
	Fields       map[string][]RollupJobSummaryField `json:"fields"`
	IndexPattern string                             `json:"index_pattern"`
	JobId        string                             `json:"job_id"`
	RollupIndex  string                             `json:"rollup_index"`
}

RollupJobSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_index_caps/types.ts#L28-L33

func NewRollupJobSummary added in v8.5.0 

func NewRollupJobSummary() *RollupJobSummary

NewRollupJobSummary returns a RollupJobSummary.

func (*RollupJobSummary) UnmarshalJSON added in v8.7.1 

func (s *RollupJobSummary) UnmarshalJSON(data []byte) error

type RollupJobSummaryField 

type RollupJobSummaryField struct {
	Agg              string   `json:"agg"`
	CalendarInterval Duration `json:"calendar_interval,omitempty"`
	TimeZone         *string  `json:"time_zone,omitempty"`
}

RollupJobSummaryField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/get_rollup_index_caps/types.ts#L35-L39

func NewRollupJobSummaryField added in v8.5.0 

func NewRollupJobSummaryField() *RollupJobSummaryField

NewRollupJobSummaryField returns a RollupJobSummaryField.

func (*RollupJobSummaryField) UnmarshalJSON added in v8.7.1 

func (s *RollupJobSummaryField) UnmarshalJSON(data []byte) error

type RomanianAnalyzer added in v8.16.0 

type RomanianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

RomanianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L248-L253

func NewRomanianAnalyzer added in v8.16.0 

func NewRomanianAnalyzer() *RomanianAnalyzer

NewRomanianAnalyzer returns a RomanianAnalyzer.

func (RomanianAnalyzer) MarshalJSON added in v8.16.0 

func (s RomanianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RomanianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *RomanianAnalyzer) UnmarshalJSON(data []byte) error

type RoutingField 

type RoutingField struct {
	Required bool `json:"required"`
}

RoutingField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L50-L52

func NewRoutingField added in v8.5.0 

func NewRoutingField() *RoutingField

NewRoutingField returns a RoutingField.

func (*RoutingField) UnmarshalJSON added in v8.7.1 

func (s *RoutingField) UnmarshalJSON(data []byte) error

type RrfRank added in v8.8.1 

type RrfRank struct {
	// RankConstant How much influence documents in individual result sets per query have over
	// the final ranked result set
	RankConstant *int64 `json:"rank_constant,omitempty"`
	// RankWindowSize Size of the individual result sets per query
	RankWindowSize *int64 `json:"rank_window_size,omitempty"`
}

RrfRank type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Rank.ts#L32-L37

func NewRrfRank added in v8.8.1 

func NewRrfRank() *RrfRank

NewRrfRank returns a RrfRank.

func (*RrfRank) UnmarshalJSON added in v8.8.1 

func (s *RrfRank) UnmarshalJSON(data []byte) error

type RuleCondition 

type RuleCondition struct {
	// AppliesTo Specifies the result property to which the condition applies. If your
	// detector uses `lat_long`, `metric`, `rare`, or `freq_rare` functions, you can
	// only specify conditions that apply to time.
	AppliesTo appliesto.AppliesTo `json:"applies_to"`
	// Operator Specifies the condition operator. The available options are greater than,
	// greater than or equals, less than, and less than or equals.
	Operator conditionoperator.ConditionOperator `json:"operator"`
	// Value The value that is compared against the `applies_to` field using the operator.
	Value Float64 `json:"value"`
}

RuleCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Rule.ts#L52-L65

func NewRuleCondition added in v8.5.0 

func NewRuleCondition() *RuleCondition

NewRuleCondition returns a RuleCondition.

func (*RuleCondition) UnmarshalJSON added in v8.7.1 

func (s *RuleCondition) UnmarshalJSON(data []byte) error

type RuleQuery added in v8.10.0 

type RuleQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost         *float32        `json:"boost,omitempty"`
	MatchCriteria json.RawMessage `json:"match_criteria,omitempty"`
	Organic       *Query          `json:"organic,omitempty"`
	QueryName_    *string         `json:"_name,omitempty"`
	RulesetId     *string         `json:"ruleset_id,omitempty"`
	RulesetIds    []string        `json:"ruleset_ids,omitempty"`
}

RuleQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L398-L406

func NewRuleQuery added in v8.10.0 

func NewRuleQuery() *RuleQuery

NewRuleQuery returns a RuleQuery.

func (*RuleQuery) UnmarshalJSON added in v8.10.0 

func (s *RuleQuery) UnmarshalJSON(data []byte) error

type RuleRetriever added in v8.17.0 

type RuleRetriever struct {
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// MatchCriteria The match criteria that will determine if a rule in the provided rulesets
	// should be applied.
	MatchCriteria json.RawMessage `json:"match_criteria,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_ *string `json:"_name,omitempty"`
	// RankWindowSize This value determines the size of the individual result set.
	RankWindowSize *int `json:"rank_window_size,omitempty"`
	// Retriever The retriever whose results rules should be applied to.
	Retriever *RetrieverContainer `json:"retriever,omitempty"`
	// RulesetIds The ruleset IDs containing the rules this retriever is evaluating against.
	RulesetIds []string `json:"ruleset_ids"`
}

RuleRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L153-L162

func NewRuleRetriever added in v8.17.0 

func NewRuleRetriever() *RuleRetriever

NewRuleRetriever returns a RuleRetriever.

func (*RuleRetriever) UnmarshalJSON added in v8.17.0 

func (s *RuleRetriever) UnmarshalJSON(data []byte) error

type RunningStateSearchInterval 

type RunningStateSearchInterval struct {
	// End The end time.
	End Duration `json:"end,omitempty"`
	// EndMs The end time as an epoch in milliseconds.
	EndMs int64 `json:"end_ms"`
	// Start The start time.
	Start Duration `json:"start,omitempty"`
	// StartMs The start time as an epoch in milliseconds.
	StartMs int64 `json:"start_ms"`
}

RunningStateSearchInterval type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Datafeed.ts#L226-L243

func NewRunningStateSearchInterval added in v8.5.0 

func NewRunningStateSearchInterval() *RunningStateSearchInterval

NewRunningStateSearchInterval returns a RunningStateSearchInterval.

func (*RunningStateSearchInterval) UnmarshalJSON added in v8.7.1 

func (s *RunningStateSearchInterval) UnmarshalJSON(data []byte) error

type RuntimeField 

type RuntimeField struct {
	// FetchFields For type `lookup`
	FetchFields []RuntimeFieldFetchFields `json:"fetch_fields,omitempty"`
	// Fields For type `composite`
	Fields map[string]CompositeSubField `json:"fields,omitempty"`
	// Format A custom format for `date` type runtime fields.
	Format *string `json:"format,omitempty"`
	// InputField For type `lookup`
	InputField *string `json:"input_field,omitempty"`
	// Script Painless script executed at query time.
	Script *Script `json:"script,omitempty"`
	// TargetField For type `lookup`
	TargetField *string `json:"target_field,omitempty"`
	// TargetIndex For type `lookup`
	TargetIndex *string `json:"target_index,omitempty"`
	// Type Field type, which can be: `boolean`, `composite`, `date`, `double`,
	// `geo_point`, `ip`,`keyword`, `long`, or `lookup`.
	Type runtimefieldtype.RuntimeFieldType `json:"type"`
}

RuntimeField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/RuntimeFields.ts#L26-L50

func NewRuntimeField added in v8.5.0 

func NewRuntimeField() *RuntimeField

NewRuntimeField returns a RuntimeField.

func (*RuntimeField) UnmarshalJSON added in v8.7.1 

func (s *RuntimeField) UnmarshalJSON(data []byte) error

type RuntimeFieldFetchFields added in v8.7.0 

type RuntimeFieldFetchFields struct {
	Field  string  `json:"field"`
	Format *string `json:"format,omitempty"`
}

RuntimeFieldFetchFields type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/RuntimeFields.ts#L56-L60

func NewRuntimeFieldFetchFields added in v8.7.0 

func NewRuntimeFieldFetchFields() *RuntimeFieldFetchFields

NewRuntimeFieldFetchFields returns a RuntimeFieldFetchFields.

func (*RuntimeFieldFetchFields) UnmarshalJSON added in v8.7.1 

func (s *RuntimeFieldFetchFields) UnmarshalJSON(data []byte) error

type RuntimeFields 

type RuntimeFields map[string]RuntimeField

RuntimeFields type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/RuntimeFields.ts#L24-L24

type RuntimeFieldsType 

type RuntimeFieldsType struct {
	CharsMax        int64    `json:"chars_max"`
	CharsTotal      int64    `json:"chars_total"`
	Count           int64    `json:"count"`
	DocMax          int64    `json:"doc_max"`
	DocTotal        int64    `json:"doc_total"`
	IndexCount      int64    `json:"index_count"`
	Lang            []string `json:"lang"`
	LinesMax        int64    `json:"lines_max"`
	LinesTotal      int64    `json:"lines_total"`
	Name            string   `json:"name"`
	ScriptlessCount int64    `json:"scriptless_count"`
	ShadowedCount   int64    `json:"shadowed_count"`
	SourceMax       int64    `json:"source_max"`
	SourceTotal     int64    `json:"source_total"`
}

RuntimeFieldsType type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L289-L304

func NewRuntimeFieldsType added in v8.5.0 

func NewRuntimeFieldsType() *RuntimeFieldsType

NewRuntimeFieldsType returns a RuntimeFieldsType.

func (*RuntimeFieldsType) UnmarshalJSON added in v8.7.1 

func (s *RuntimeFieldsType) UnmarshalJSON(data []byte) error

type RussianAnalyzer added in v8.16.0 

type RussianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

RussianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L255-L260

func NewRussianAnalyzer added in v8.16.0 

func NewRussianAnalyzer() *RussianAnalyzer

NewRussianAnalyzer returns a RussianAnalyzer.

func (RussianAnalyzer) MarshalJSON added in v8.16.0 

func (s RussianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*RussianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *RussianAnalyzer) UnmarshalJSON(data []byte) error

type S3Repository added in v8.13.0 

type S3Repository struct {
	Settings S3RepositorySettings `json:"settings"`
	Type     string               `json:"type,omitempty"`
	Uuid     *string              `json:"uuid,omitempty"`
}

S3Repository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L50-L53

func NewS3Repository added in v8.13.0 

func NewS3Repository() *S3Repository

NewS3Repository returns a S3Repository.

func (S3Repository) MarshalJSON added in v8.13.0 

func (s S3Repository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*S3Repository) UnmarshalJSON added in v8.13.0 

func (s *S3Repository) UnmarshalJSON(data []byte) error

type S3RepositorySettings added in v8.13.0 

type S3RepositorySettings struct {
	BasePath               *string  `json:"base_path,omitempty"`
	Bucket                 string   `json:"bucket"`
	BufferSize             ByteSize `json:"buffer_size,omitempty"`
	CannedAcl              *string  `json:"canned_acl,omitempty"`
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Client                 *string  `json:"client,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	Readonly               *bool    `json:"readonly,omitempty"`
	ServerSideEncryption   *bool    `json:"server_side_encryption,omitempty"`
	StorageClass           *string  `json:"storage_class,omitempty"`
}

S3RepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L93-L102

func NewS3RepositorySettings added in v8.13.0 

func NewS3RepositorySettings() *S3RepositorySettings

NewS3RepositorySettings returns a S3RepositorySettings.

func (*S3RepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *S3RepositorySettings) UnmarshalJSON(data []byte) error

type SLMPolicy added in v8.5.0 

type SLMPolicy struct {
	Config     *Configuration `json:"config,omitempty"`
	Name       string         `json:"name"`
	Repository string         `json:"repository"`
	Retention  *Retention     `json:"retention,omitempty"`
	Schedule   string         `json:"schedule"`
}

SLMPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L86-L92

func NewSLMPolicy added in v8.5.0 

func NewSLMPolicy() *SLMPolicy

NewSLMPolicy returns a SLMPolicy.

func (*SLMPolicy) UnmarshalJSON added in v8.7.1 

func (s *SLMPolicy) UnmarshalJSON(data []byte) error

type SampleDiversity 

type SampleDiversity struct {
	Field           string `json:"field"`
	MaxDocsPerValue int    `json:"max_docs_per_value"`
}

SampleDiversity type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/ExploreControls.ts#L51-L54

func NewSampleDiversity added in v8.5.0 

func NewSampleDiversity() *SampleDiversity

NewSampleDiversity returns a SampleDiversity.

func (*SampleDiversity) UnmarshalJSON added in v8.7.1 

func (s *SampleDiversity) UnmarshalJSON(data []byte) error

type SamplerAggregate 

type SamplerAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

SamplerAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L558-L559

func NewSamplerAggregate added in v8.5.0 

func NewSamplerAggregate() *SamplerAggregate

NewSamplerAggregate returns a SamplerAggregate.

func (SamplerAggregate) MarshalJSON 

func (s SamplerAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*SamplerAggregate) UnmarshalJSON added in v8.7.0 

func (s *SamplerAggregate) UnmarshalJSON(data []byte) error

type SamplerAggregation 

type SamplerAggregation struct {
	// ShardSize Limits how many top-scoring documents are collected in the sample processed
	// on each shard.
	ShardSize *int `json:"shard_size,omitempty"`
}

SamplerAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L771-L780

func NewSamplerAggregation added in v8.5.0 

func NewSamplerAggregation() *SamplerAggregation

NewSamplerAggregation returns a SamplerAggregation.

func (*SamplerAggregation) UnmarshalJSON added in v8.7.1 

func (s *SamplerAggregation) UnmarshalJSON(data []byte) error

type ScalarValue added in v8.12.0 

type ScalarValue any

ScalarValue holds the union for the following types: 

int64
Float64
string
bool
nil

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L39-L43

type ScaledFloatNumberProperty 

type ScaledFloatNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *Float64                                         `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	ScalingFactor       *Float64                                         `json:"scaling_factor,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

ScaledFloatNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L195-L199

func NewScaledFloatNumberProperty added in v8.5.0 

func NewScaledFloatNumberProperty() *ScaledFloatNumberProperty

NewScaledFloatNumberProperty returns a ScaledFloatNumberProperty.

func (ScaledFloatNumberProperty) MarshalJSON added in v8.9.0 

func (s ScaledFloatNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ScaledFloatNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *ScaledFloatNumberProperty) UnmarshalJSON(data []byte) error

type ScandinavianFoldingTokenFilter added in v8.18.1 

type ScandinavianFoldingTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ScandinavianFoldingTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L522-L524

func NewScandinavianFoldingTokenFilter added in v8.18.1 

func NewScandinavianFoldingTokenFilter() *ScandinavianFoldingTokenFilter

NewScandinavianFoldingTokenFilter returns a ScandinavianFoldingTokenFilter.

func (ScandinavianFoldingTokenFilter) MarshalJSON added in v8.18.1 

func (s ScandinavianFoldingTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ScandinavianFoldingTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *ScandinavianFoldingTokenFilter) UnmarshalJSON(data []byte) error

type ScandinavianNormalizationTokenFilter added in v8.18.1 

type ScandinavianNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ScandinavianNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L526-L528

func NewScandinavianNormalizationTokenFilter added in v8.18.1 

func NewScandinavianNormalizationTokenFilter() *ScandinavianNormalizationTokenFilter

NewScandinavianNormalizationTokenFilter returns a ScandinavianNormalizationTokenFilter.

func (ScandinavianNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s ScandinavianNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ScandinavianNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *ScandinavianNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type ScheduleContainer 

type ScheduleContainer struct {
	Cron     *string         `json:"cron,omitempty"`
	Daily    *DailySchedule  `json:"daily,omitempty"`
	Hourly   *HourlySchedule `json:"hourly,omitempty"`
	Interval Duration        `json:"interval,omitempty"`
	Monthly  []TimeOfMonth   `json:"monthly,omitempty"`
	Timezone *string         `json:"timezone,omitempty"`
	Weekly   []TimeOfWeek    `json:"weekly,omitempty"`
	Yearly   []TimeOfYear    `json:"yearly,omitempty"`
}

ScheduleContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L80-L92

func NewScheduleContainer added in v8.5.0 

func NewScheduleContainer() *ScheduleContainer

NewScheduleContainer returns a ScheduleContainer.

func (*ScheduleContainer) UnmarshalJSON added in v8.7.1 

func (s *ScheduleContainer) UnmarshalJSON(data []byte) error

type ScheduleTimeOfDay 

type ScheduleTimeOfDay any

ScheduleTimeOfDay holds the union for the following types: 

string
HourAndMinute

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L99-L104

type ScheduleTriggerEvent 

type ScheduleTriggerEvent struct {
	ScheduledTime DateTime `json:"scheduled_time"`
	TriggeredTime DateTime `json:"triggered_time,omitempty"`
}

ScheduleTriggerEvent type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L94-L97

func NewScheduleTriggerEvent added in v8.5.0 

func NewScheduleTriggerEvent() *ScheduleTriggerEvent

NewScheduleTriggerEvent returns a ScheduleTriggerEvent.

func (*ScheduleTriggerEvent) UnmarshalJSON added in v8.7.1 

func (s *ScheduleTriggerEvent) UnmarshalJSON(data []byte) error

type SchedulingConfiguration added in v8.15.0 

type SchedulingConfiguration struct {
	AccessControl *ConnectorScheduling `json:"access_control,omitempty"`
	Full          *ConnectorScheduling `json:"full,omitempty"`
	Incremental   *ConnectorScheduling `json:"incremental,omitempty"`
}

SchedulingConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L246-L250

func NewSchedulingConfiguration added in v8.15.0 

func NewSchedulingConfiguration() *SchedulingConfiguration

NewSchedulingConfiguration returns a SchedulingConfiguration.

type ScoreSort 

type ScoreSort struct {
	Order *sortorder.SortOrder `json:"order,omitempty"`
}

ScoreSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L54-L56

func NewScoreSort added in v8.5.0 

func NewScoreSort() *ScoreSort

NewScoreSort returns a ScoreSort.

type Script 

type Script struct {
	// Id The `id` for a stored script.
	Id *string `json:"id,omitempty"`
	// Lang Specifies the language the script is written in.
	Lang    *scriptlanguage.ScriptLanguage `json:"lang,omitempty"`
	Options map[string]string              `json:"options,omitempty"`
	// Params Specifies any named parameters that are passed into the script as variables.
	// Use parameters instead of hard-coded values to decrease compile time.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// Source The script source.
	Source *string `json:"source,omitempty"`
}

Script type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Scripting.ts#L75-L99

func NewScript added in v8.15.0 

func NewScript() *Script

NewScript returns a Script.

func (*Script) UnmarshalJSON added in v8.15.0 

func (s *Script) UnmarshalJSON(data []byte) error

type ScriptCache 

type ScriptCache struct {
	// CacheEvictions Total number of times the script cache has evicted old data.
	CacheEvictions *int64 `json:"cache_evictions,omitempty"`
	// CompilationLimitTriggered Total number of times the script compilation circuit breaker has limited
	// inline script compilations.
	CompilationLimitTriggered *int64 `json:"compilation_limit_triggered,omitempty"`
	// Compilations Total number of inline script compilations performed by the node.
	Compilations *int64  `json:"compilations,omitempty"`
	Context      *string `json:"context,omitempty"`
}

ScriptCache type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1102-L1116

func NewScriptCache added in v8.5.0 

func NewScriptCache() *ScriptCache

NewScriptCache returns a ScriptCache.

func (*ScriptCache) UnmarshalJSON added in v8.7.1 

func (s *ScriptCache) UnmarshalJSON(data []byte) error

type ScriptCondition 

type ScriptCondition struct {
	Id     *string                    `json:"id,omitempty"`
	Lang   *string                    `json:"lang,omitempty"`
	Params map[string]json.RawMessage `json:"params,omitempty"`
	Source *string                    `json:"source,omitempty"`
}

ScriptCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L79-L87

func NewScriptCondition added in v8.5.0 

func NewScriptCondition() *ScriptCondition

NewScriptCondition returns a ScriptCondition.

func (*ScriptCondition) UnmarshalJSON added in v8.9.0 

func (s *ScriptCondition) UnmarshalJSON(data []byte) error

type ScriptField 

type ScriptField struct {
	IgnoreFailure *bool  `json:"ignore_failure,omitempty"`
	Script        Script `json:"script"`
}

ScriptField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Scripting.ts#L101-L104

func NewScriptField added in v8.5.0 

func NewScriptField() *ScriptField

NewScriptField returns a ScriptField.

func (*ScriptField) UnmarshalJSON added in v8.7.1 

func (s *ScriptField) UnmarshalJSON(data []byte) error

type ScriptProcessor added in v8.13.0 

type ScriptProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Id ID of a stored script.
	// If no `source` is specified, this parameter is required.
	Id *string `json:"id,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// Lang Script language.
	Lang *string `json:"lang,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Params Object containing parameters for the script.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// Source Inline script.
	// If no `id` is specified, this parameter is required.
	Source *string `json:"source,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

ScriptProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1422-L1442

func NewScriptProcessor added in v8.13.0 

func NewScriptProcessor() *ScriptProcessor

NewScriptProcessor returns a ScriptProcessor.

func (*ScriptProcessor) UnmarshalJSON added in v8.13.0 

func (s *ScriptProcessor) UnmarshalJSON(data []byte) error

type ScriptQuery 

type ScriptQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	// Script Contains a script to run as a query.
	// This script must return a boolean value, `true` or `false`.
	Script Script `json:"script"`
}

ScriptQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L337-L346

func NewScriptQuery added in v8.5.0 

func NewScriptQuery() *ScriptQuery

NewScriptQuery returns a ScriptQuery.

func (*ScriptQuery) UnmarshalJSON added in v8.7.1 

func (s *ScriptQuery) UnmarshalJSON(data []byte) error

type ScriptScoreFunction 

type ScriptScoreFunction struct {
	// Script A script that computes a score.
	Script Script `json:"script"`
}

ScriptScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L137-L142

func NewScriptScoreFunction added in v8.5.0 

func NewScriptScoreFunction() *ScriptScoreFunction

NewScriptScoreFunction returns a ScriptScoreFunction.

type ScriptScoreQuery 

type ScriptScoreQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// MinScore Documents with a score lower than this floating point number are excluded
	// from the search results.
	MinScore *float32 `json:"min_score,omitempty"`
	// Query Query used to return documents.
	Query      *Query  `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Script Script used to compute the score of documents returned by the query.
	// Important: final relevance scores from the `script_score` query cannot be
	// negative.
	Script Script `json:"script"`
}

ScriptScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L348-L365

func NewScriptScoreQuery added in v8.5.0 

func NewScriptScoreQuery() *ScriptScoreQuery

NewScriptScoreQuery returns a ScriptScoreQuery.

func (*ScriptScoreQuery) UnmarshalJSON added in v8.7.1 

func (s *ScriptScoreQuery) UnmarshalJSON(data []byte) error

type ScriptSort 

type ScriptSort struct {
	Mode   *sortmode.SortMode             `json:"mode,omitempty"`
	Nested *NestedSortValue               `json:"nested,omitempty"`
	Order  *sortorder.SortOrder           `json:"order,omitempty"`
	Script Script                         `json:"script"`
	Type   *scriptsorttype.ScriptSortType `json:"type,omitempty"`
}

ScriptSort type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L72-L78

func NewScriptSort added in v8.5.0 

func NewScriptSort() *ScriptSort

NewScriptSort returns a ScriptSort.

type ScriptTransform 

type ScriptTransform struct {
	Id     *string                    `json:"id,omitempty"`
	Lang   *string                    `json:"lang,omitempty"`
	Params map[string]json.RawMessage `json:"params,omitempty"`
	Source *string                    `json:"source,omitempty"`
}

ScriptTransform type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Transform.ts#L36-L44

func NewScriptTransform added in v8.5.0 

func NewScriptTransform() *ScriptTransform

NewScriptTransform returns a ScriptTransform.

func (*ScriptTransform) UnmarshalJSON added in v8.9.0 

func (s *ScriptTransform) UnmarshalJSON(data []byte) error

type ScriptedHeuristic 

type ScriptedHeuristic struct {
	Script Script `json:"script"`
}

ScriptedHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L813-L815

func NewScriptedHeuristic added in v8.5.0 

func NewScriptedHeuristic() *ScriptedHeuristic

NewScriptedHeuristic returns a ScriptedHeuristic.

type ScriptedMetricAggregate 

type ScriptedMetricAggregate struct {
	Meta  Metadata        `json:"meta,omitempty"`
	Value json.RawMessage `json:"value,omitempty"`
}

ScriptedMetricAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L739-L745

func NewScriptedMetricAggregate added in v8.5.0 

func NewScriptedMetricAggregate() *ScriptedMetricAggregate

NewScriptedMetricAggregate returns a ScriptedMetricAggregate.

func (*ScriptedMetricAggregate) UnmarshalJSON added in v8.7.1 

func (s *ScriptedMetricAggregate) UnmarshalJSON(data []byte) error

type ScriptedMetricAggregation 

type ScriptedMetricAggregation struct {
	// CombineScript Runs once on each shard after document collection is complete.
	// Allows the aggregation to consolidate the state returned from each shard.
	CombineScript *Script `json:"combine_script,omitempty"`
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// InitScript Runs prior to any collection of documents.
	// Allows the aggregation to set up any initial state.
	InitScript *Script `json:"init_script,omitempty"`
	// MapScript Run once per document collected.
	// If no `combine_script` is specified, the resulting state needs to be stored
	// in the `state` object.
	MapScript *Script `json:"map_script,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	// Params A global object with script parameters for `init`, `map` and `combine`
	// scripts.
	// It is shared between the scripts.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// ReduceScript Runs once on the coordinating node after all shards have returned their
	// results.
	// The script is provided with access to a variable `states`, which is an array
	// of the result of the `combine_script` on each shard.
	ReduceScript *Script `json:"reduce_script,omitempty"`
	Script       *Script `json:"script,omitempty"`
}

ScriptedMetricAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L263-L289

func NewScriptedMetricAggregation added in v8.5.0 

func NewScriptedMetricAggregation() *ScriptedMetricAggregation

NewScriptedMetricAggregation returns a ScriptedMetricAggregation.

func (*ScriptedMetricAggregation) UnmarshalJSON added in v8.7.1 

func (s *ScriptedMetricAggregation) UnmarshalJSON(data []byte) error

type Scripting 

type Scripting struct {
	// CacheEvictions Total number of times the script cache has evicted old data.
	CacheEvictions *int64 `json:"cache_evictions,omitempty"`
	// CompilationLimitTriggered Total number of times the script compilation circuit breaker has limited
	// inline script compilations.
	CompilationLimitTriggered *int64 `json:"compilation_limit_triggered,omitempty"`
	// Compilations Total number of inline script compilations performed by the node.
	Compilations *int64 `json:"compilations,omitempty"`
	// CompilationsHistory Contains this recent history of script compilations.
	CompilationsHistory map[string]int64 `json:"compilations_history,omitempty"`
	Contexts            []NodesContext   `json:"contexts,omitempty"`
}

Scripting type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1048-L1066

func NewScripting added in v8.5.0 

func NewScripting() *Scripting

NewScripting returns a Scripting.

func (*Scripting) UnmarshalJSON added in v8.7.1 

func (s *Scripting) UnmarshalJSON(data []byte) error

type ScrollIds 

type ScrollIds []string

ScrollIds type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L56-L56

type SearchAccess added in v8.17.0 

type SearchAccess struct {
	// AllowRestrictedIndices Set to `true` if using wildcard or regular expressions for patterns that
	// cover restricted indices. Implicitly, restricted indices have limited
	// privileges that can cause pattern tests to fail. If restricted indices are
	// explicitly included in the `names` list, Elasticsearch checks privileges
	// against these indices regardless of the value set for
	// `allow_restricted_indices`.
	AllowRestrictedIndices *bool `json:"allow_restricted_indices,omitempty"`
	// FieldSecurity The document fields that the owners of the role have read access to.
	FieldSecurity *FieldSecurity `json:"field_security,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
	// Query A search query that defines the documents the owners of the role have access
	// to. A document within the specified indices must match this query for it to
	// be accessible by the owners of the role.
	Query IndicesPrivilegesQuery `json:"query,omitempty"`
}

SearchAccess type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L454-L474

func NewSearchAccess added in v8.17.0 

func NewSearchAccess() *SearchAccess

NewSearchAccess returns a SearchAccess.

func (*SearchAccess) UnmarshalJSON added in v8.17.0 

func (s *SearchAccess) UnmarshalJSON(data []byte) error

type SearchApplication added in v8.8.0 

type SearchApplication struct {
	// AnalyticsCollectionName Analytics collection associated to the Search Application.
	AnalyticsCollectionName *string `json:"analytics_collection_name,omitempty"`
	// Indices Indices that are part of the Search Application.
	Indices []string `json:"indices"`
	// Name Search Application name
	Name string `json:"name"`
	// Template Search template to use on search operations.
	Template *SearchApplicationTemplate `json:"template,omitempty"`
	// UpdatedAtMillis Last time the Search Application was updated.
	UpdatedAtMillis int64 `json:"updated_at_millis"`
}

SearchApplication type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/search_application/_types/SearchApplication.ts#L24-L33

func NewSearchApplication added in v8.8.0 

func NewSearchApplication() *SearchApplication

NewSearchApplication returns a SearchApplication.

func (*SearchApplication) UnmarshalJSON added in v8.8.0 

func (s *SearchApplication) UnmarshalJSON(data []byte) error

type SearchApplicationParameters added in v8.18.0 

type SearchApplicationParameters struct {
	// AnalyticsCollectionName Analytics collection associated to the Search Application.
	AnalyticsCollectionName *string `json:"analytics_collection_name,omitempty"`
	// Indices Indices that are part of the Search Application.
	Indices []string `json:"indices"`
	// Template Search template to use on search operations.
	Template *SearchApplicationTemplate `json:"template,omitempty"`
}

SearchApplicationParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/search_application/_types/SearchApplicationParameters.ts#L23-L36

func NewSearchApplicationParameters added in v8.18.0 

func NewSearchApplicationParameters() *SearchApplicationParameters

NewSearchApplicationParameters returns a SearchApplicationParameters.

func (*SearchApplicationParameters) UnmarshalJSON added in v8.18.0 

func (s *SearchApplicationParameters) UnmarshalJSON(data []byte) error

type SearchApplicationTemplate added in v8.8.0 

type SearchApplicationTemplate struct {
	// Script The associated mustache template.
	Script Script `json:"script"`
}

SearchApplicationTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/search_application/_types/SearchApplicationTemplate.ts#L22-L27

func NewSearchApplicationTemplate added in v8.8.0 

func NewSearchApplicationTemplate() *SearchApplicationTemplate

NewSearchApplicationTemplate returns a SearchApplicationTemplate.

type SearchAsYouTypeProperty 

type SearchAsYouTypeProperty struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	CopyTo         []string                       `json:"copy_to,omitempty"`
	Dynamic        *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields         map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove    *int                           `json:"ignore_above,omitempty"`
	Index          *bool                          `json:"index,omitempty"`
	IndexOptions   *indexoptions.IndexOptions     `json:"index_options,omitempty"`
	MaxShingleSize *int                           `json:"max_shingle_size,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Norms               *bool                                            `json:"norms,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SearchAnalyzer      *string                                          `json:"search_analyzer,omitempty"`
	SearchQuoteAnalyzer *string                                          `json:"search_quote_analyzer,omitempty"`
	Similarity          *string                                          `json:"similarity,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	TermVector          *termvectoroption.TermVectorOption               `json:"term_vector,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

SearchAsYouTypeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L237-L248

func NewSearchAsYouTypeProperty added in v8.5.0 

func NewSearchAsYouTypeProperty() *SearchAsYouTypeProperty

NewSearchAsYouTypeProperty returns a SearchAsYouTypeProperty.

func (SearchAsYouTypeProperty) MarshalJSON added in v8.9.0 

func (s SearchAsYouTypeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SearchAsYouTypeProperty) UnmarshalJSON added in v8.7.0 

func (s *SearchAsYouTypeProperty) UnmarshalJSON(data []byte) error

type SearchIdle 

type SearchIdle struct {
	After Duration `json:"after,omitempty"`
}

SearchIdle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L253-L256

func NewSearchIdle added in v8.5.0 

func NewSearchIdle() *SearchIdle

NewSearchIdle returns a SearchIdle.

func (*SearchIdle) UnmarshalJSON added in v8.7.1 

func (s *SearchIdle) UnmarshalJSON(data []byte) error

type SearchInput 

type SearchInput struct {
	Extract []string                     `json:"extract,omitempty"`
	Request SearchInputRequestDefinition `json:"request"`
	Timeout Duration                     `json:"timeout,omitempty"`
}

SearchInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L109-L113

func NewSearchInput added in v8.5.0 

func NewSearchInput() *SearchInput

NewSearchInput returns a SearchInput.

func (*SearchInput) UnmarshalJSON added in v8.7.1 

func (s *SearchInput) UnmarshalJSON(data []byte) error

type SearchInputRequestBody 

type SearchInputRequestBody struct {
	Query Query `json:"query"`
}

SearchInputRequestBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L144-L146

func NewSearchInputRequestBody added in v8.5.0 

func NewSearchInputRequestBody() *SearchInputRequestBody

NewSearchInputRequestBody returns a SearchInputRequestBody.

type SearchInputRequestDefinition 

type SearchInputRequestDefinition struct {
	Body               *SearchInputRequestBody    `json:"body,omitempty"`
	Indices            []string                   `json:"indices,omitempty"`
	IndicesOptions     *IndicesOptions            `json:"indices_options,omitempty"`
	RestTotalHitsAsInt *bool                      `json:"rest_total_hits_as_int,omitempty"`
	SearchType         *searchtype.SearchType     `json:"search_type,omitempty"`
	Template           *SearchTemplateRequestBody `json:"template,omitempty"`
}

SearchInputRequestDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L115-L122

func NewSearchInputRequestDefinition added in v8.5.0 

func NewSearchInputRequestDefinition() *SearchInputRequestDefinition

NewSearchInputRequestDefinition returns a SearchInputRequestDefinition.

func (*SearchInputRequestDefinition) UnmarshalJSON added in v8.7.1 

func (s *SearchInputRequestDefinition) UnmarshalJSON(data []byte) error

type SearchProfile 

type SearchProfile struct {
	Collector   []Collector    `json:"collector"`
	Query       []QueryProfile `json:"query"`
	RewriteTime int64          `json:"rewrite_time"`
}

SearchProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L136-L140

func NewSearchProfile added in v8.5.0 

func NewSearchProfile() *SearchProfile

NewSearchProfile returns a SearchProfile.

func (*SearchProfile) UnmarshalJSON added in v8.7.1 

func (s *SearchProfile) UnmarshalJSON(data []byte) error

type SearchShardsNodeAttributes added in v8.16.0 

type SearchShardsNodeAttributes struct {
	// Attributes Lists node attributes.
	Attributes map[string]string `json:"attributes"`
	// EphemeralId The ephemeral ID of the node.
	EphemeralId     string `json:"ephemeral_id"`
	ExternalId      string `json:"external_id"`
	MaxIndexVersion int    `json:"max_index_version"`
	MinIndexVersion int    `json:"min_index_version"`
	// Name The human-readable identifier of the node.
	Name  string              `json:"name"`
	Roles []noderole.NodeRole `json:"roles"`
	// TransportAddress The host and port where transport HTTP connections are accepted.
	TransportAddress string `json:"transport_address"`
	Version          string `json:"version"`
}

SearchShardsNodeAttributes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search_shards/SearchShardsResponse.ts#L42-L60

func NewSearchShardsNodeAttributes added in v8.16.0 

func NewSearchShardsNodeAttributes() *SearchShardsNodeAttributes

NewSearchShardsNodeAttributes returns a SearchShardsNodeAttributes.

func (*SearchShardsNodeAttributes) UnmarshalJSON added in v8.16.0 

func (s *SearchShardsNodeAttributes) UnmarshalJSON(data []byte) error

type SearchStats 

type SearchStats struct {
	FetchCurrent        int64                  `json:"fetch_current"`
	FetchTime           Duration               `json:"fetch_time,omitempty"`
	FetchTimeInMillis   int64                  `json:"fetch_time_in_millis"`
	FetchTotal          int64                  `json:"fetch_total"`
	Groups              map[string]SearchStats `json:"groups,omitempty"`
	OpenContexts        *int64                 `json:"open_contexts,omitempty"`
	QueryCurrent        int64                  `json:"query_current"`
	QueryTime           Duration               `json:"query_time,omitempty"`
	QueryTimeInMillis   int64                  `json:"query_time_in_millis"`
	QueryTotal          int64                  `json:"query_total"`
	ScrollCurrent       int64                  `json:"scroll_current"`
	ScrollTime          Duration               `json:"scroll_time,omitempty"`
	ScrollTimeInMillis  int64                  `json:"scroll_time_in_millis"`
	ScrollTotal         int64                  `json:"scroll_total"`
	SuggestCurrent      int64                  `json:"suggest_current"`
	SuggestTime         Duration               `json:"suggest_time,omitempty"`
	SuggestTimeInMillis int64                  `json:"suggest_time_in_millis"`
	SuggestTotal        int64                  `json:"suggest_total"`
}

SearchStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L255-L274

func NewSearchStats added in v8.5.0 

func NewSearchStats() *SearchStats

NewSearchStats returns a SearchStats.

func (*SearchStats) UnmarshalJSON added in v8.7.1 

func (s *SearchStats) UnmarshalJSON(data []byte) error

type SearchTemplateRequestBody 

type SearchTemplateRequestBody struct {
	Explain *bool `json:"explain,omitempty"`
	// Id ID of the search template to use. If no source is specified,
	// this parameter is required.
	Id      *string                    `json:"id,omitempty"`
	Params  map[string]json.RawMessage `json:"params,omitempty"`
	Profile *bool                      `json:"profile,omitempty"`
	// Source An inline search template. Supports the same parameters as the search API's
	// request body. Also supports Mustache variables. If no id is specified, this
	// parameter is required.
	Source *string `json:"source,omitempty"`
}

SearchTemplateRequestBody type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L125-L142

func NewSearchTemplateRequestBody added in v8.5.0 

func NewSearchTemplateRequestBody() *SearchTemplateRequestBody

NewSearchTemplateRequestBody returns a SearchTemplateRequestBody.

func (*SearchTemplateRequestBody) UnmarshalJSON added in v8.7.1 

func (s *SearchTemplateRequestBody) UnmarshalJSON(data []byte) error

type SearchTransform 

type SearchTransform struct {
	Request SearchInputRequestDefinition `json:"request"`
	Timeout Duration                     `json:"timeout"`
}

SearchTransform type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Transform.ts#L46-L49

func NewSearchTransform added in v8.5.0 

func NewSearchTransform() *SearchTransform

NewSearchTransform returns a SearchTransform.

func (*SearchTransform) UnmarshalJSON added in v8.7.1 

func (s *SearchTransform) UnmarshalJSON(data []byte) error

type SearchableSnapshotAction added in v8.15.0 

type SearchableSnapshotAction struct {
	ForceMergeIndex    *bool  `json:"force_merge_index,omitempty"`
	SnapshotRepository string `json:"snapshot_repository"`
}

SearchableSnapshotAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L128-L131

func NewSearchableSnapshotAction added in v8.15.0 

func NewSearchableSnapshotAction() *SearchableSnapshotAction

NewSearchableSnapshotAction returns a SearchableSnapshotAction.

func (*SearchableSnapshotAction) UnmarshalJSON added in v8.15.0 

func (s *SearchableSnapshotAction) UnmarshalJSON(data []byte) error

type SearchableSnapshots 

type SearchableSnapshots struct {
	Available               bool `json:"available"`
	Enabled                 bool `json:"enabled"`
	FullCopyIndicesCount    *int `json:"full_copy_indices_count,omitempty"`
	IndicesCount            int  `json:"indices_count"`
	SharedCacheIndicesCount *int `json:"shared_cache_indices_count,omitempty"`
}

SearchableSnapshots type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L438-L442

func NewSearchableSnapshots added in v8.5.0 

func NewSearchableSnapshots() *SearchableSnapshots

NewSearchableSnapshots returns a SearchableSnapshots.

func (*SearchableSnapshots) UnmarshalJSON added in v8.7.1 

func (s *SearchableSnapshots) UnmarshalJSON(data []byte) error

type Security 

type Security struct {
	Anonymous          FeatureToggle               `json:"anonymous"`
	ApiKeyService      FeatureToggle               `json:"api_key_service"`
	Audit              Audit                       `json:"audit"`
	Available          bool                        `json:"available"`
	Enabled            bool                        `json:"enabled"`
	Fips140            FeatureToggle               `json:"fips_140"`
	Ipfilter           IpFilter                    `json:"ipfilter"`
	OperatorPrivileges Base                        `json:"operator_privileges"`
	Realms             map[string]XpackRealm       `json:"realms"`
	RoleMapping        map[string]XpackRoleMapping `json:"role_mapping"`
	Roles              SecurityRoles               `json:"roles"`
	Ssl                Ssl                         `json:"ssl"`
	SystemKey          *FeatureToggle              `json:"system_key,omitempty"`
	TokenService       FeatureToggle               `json:"token_service"`
}

Security type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L444-L457

func NewSecurity added in v8.5.0 

func NewSecurity() *Security

NewSecurity returns a Security.

func (*Security) UnmarshalJSON added in v8.7.1 

func (s *Security) UnmarshalJSON(data []byte) error

type SecurityRoleMapping added in v8.5.0 

type SecurityRoleMapping struct {
	Enabled       bool            `json:"enabled"`
	Metadata      Metadata        `json:"metadata"`
	RoleTemplates []RoleTemplate  `json:"role_templates,omitempty"`
	Roles         []string        `json:"roles,omitempty"`
	Rules         RoleMappingRule `json:"rules"`
}

SecurityRoleMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/RoleMapping.ts#L25-L33

func NewSecurityRoleMapping added in v8.5.0 

func NewSecurityRoleMapping() *SecurityRoleMapping

NewSecurityRoleMapping returns a SecurityRoleMapping.

func (*SecurityRoleMapping) UnmarshalJSON added in v8.7.1 

func (s *SecurityRoleMapping) UnmarshalJSON(data []byte) error

type SecurityRoles 

type SecurityRoles struct {
	Dls    SecurityRolesDls    `json:"dls"`
	File   SecurityRolesFile   `json:"file"`
	Native SecurityRolesNative `json:"native"`
}

SecurityRoles type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L306-L310

func NewSecurityRoles added in v8.5.0 

func NewSecurityRoles() *SecurityRoles

NewSecurityRoles returns a SecurityRoles.

type SecurityRolesDls 

type SecurityRolesDls struct {
	BitSetCache SecurityRolesDlsBitSetCache `json:"bit_set_cache"`
}

SecurityRolesDls type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L318-L320

func NewSecurityRolesDls added in v8.5.0 

func NewSecurityRolesDls() *SecurityRolesDls

NewSecurityRolesDls returns a SecurityRolesDls.

type SecurityRolesDlsBitSetCache 

type SecurityRolesDlsBitSetCache struct {
	Count         int      `json:"count"`
	Memory        ByteSize `json:"memory,omitempty"`
	MemoryInBytes uint64   `json:"memory_in_bytes"`
}

SecurityRolesDlsBitSetCache type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L322-L326

func NewSecurityRolesDlsBitSetCache added in v8.5.0 

func NewSecurityRolesDlsBitSetCache() *SecurityRolesDlsBitSetCache

NewSecurityRolesDlsBitSetCache returns a SecurityRolesDlsBitSetCache.

func (*SecurityRolesDlsBitSetCache) UnmarshalJSON added in v8.7.1 

func (s *SecurityRolesDlsBitSetCache) UnmarshalJSON(data []byte) error

type SecurityRolesFile 

type SecurityRolesFile struct {
	Dls  bool  `json:"dls"`
	Fls  bool  `json:"fls"`
	Size int64 `json:"size"`
}

SecurityRolesFile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L328-L332

func NewSecurityRolesFile added in v8.5.0 

func NewSecurityRolesFile() *SecurityRolesFile

NewSecurityRolesFile returns a SecurityRolesFile.

func (*SecurityRolesFile) UnmarshalJSON added in v8.7.1 

func (s *SecurityRolesFile) UnmarshalJSON(data []byte) error

type SecurityRolesNative 

type SecurityRolesNative struct {
	Dls  bool  `json:"dls"`
	Fls  bool  `json:"fls"`
	Size int64 `json:"size"`
}

SecurityRolesNative type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L312-L316

func NewSecurityRolesNative added in v8.5.0 

func NewSecurityRolesNative() *SecurityRolesNative

NewSecurityRolesNative returns a SecurityRolesNative.

func (*SecurityRolesNative) UnmarshalJSON added in v8.7.1 

func (s *SecurityRolesNative) UnmarshalJSON(data []byte) error

type SecuritySettings added in v8.18.0 

type SecuritySettings struct {
	Index *IndexSettings `json:"index,omitempty"`
}

SecuritySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/SecuritySettings.ts#L22-L24

func NewSecuritySettings added in v8.18.0 

func NewSecuritySettings() *SecuritySettings

NewSecuritySettings returns a SecuritySettings.

type Segment 

type Segment struct {
	Attributes  map[string]string `json:"attributes"`
	Committed   bool              `json:"committed"`
	Compound    bool              `json:"compound"`
	DeletedDocs int64             `json:"deleted_docs"`
	Generation  int               `json:"generation"`
	NumDocs     int64             `json:"num_docs"`
	Search      bool              `json:"search"`
	SizeInBytes Float64           `json:"size_in_bytes"`
	Version     string            `json:"version"`
}

Segment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/segments/types.ts#L28-L38

func NewSegment added in v8.5.0 

func NewSegment() *Segment

NewSegment returns a Segment.

func (*Segment) UnmarshalJSON added in v8.7.1 

func (s *Segment) UnmarshalJSON(data []byte) error

type SegmentsRecord 

type SegmentsRecord struct {
	// Committed If `true`, the segment is synced to disk.
	// Segments that are synced can survive a hard reboot.
	// If `false`, the data from uncommitted segments is also stored in the
	// transaction log so that Elasticsearch is able to replay changes on the next
	// start.
	Committed *string `json:"committed,omitempty"`
	// Compound If `true`, the segment is stored in a compound file.
	// This means Lucene merged all files from the segment in a single file to save
	// file descriptors.
	Compound *string `json:"compound,omitempty"`
	// DocsCount The number of documents in the segment.
	// This excludes deleted documents and counts any nested documents separately
	// from their parents.
	// It also excludes documents which were indexed recently and do not yet belong
	// to a segment.
	DocsCount *string `json:"docs.count,omitempty"`
	// DocsDeleted The number of deleted documents in the segment, which might be higher or
	// lower than the number of delete operations you have performed.
	// This number excludes deletes that were performed recently and do not yet
	// belong to a segment.
	// Deleted documents are cleaned up by the automatic merge process if it makes
	// sense to do so.
	// Also, Elasticsearch creates extra deleted documents to internally track the
	// recent history of operations on a shard.
	DocsDeleted *string `json:"docs.deleted,omitempty"`
	// Generation The segment generation number.
	// Elasticsearch increments this generation number for each segment written then
	// uses this number to derive the segment name.
	Generation *string `json:"generation,omitempty"`
	// Id The unique identifier of the node where it lives.
	Id *string `json:"id,omitempty"`
	// Index The index name.
	Index *string `json:"index,omitempty"`
	// Ip The IP address of the node where it lives.
	Ip *string `json:"ip,omitempty"`
	// Prirep The shard type: `primary` or `replica`.
	Prirep *string `json:"prirep,omitempty"`
	// Searchable If `true`, the segment is searchable.
	// If `false`, the segment has most likely been written to disk but needs a
	// refresh to be searchable.
	Searchable *string `json:"searchable,omitempty"`
	// Segment The segment name, which is derived from the segment generation and used
	// internally to create file names in the directory of the shard.
	Segment *string `json:"segment,omitempty"`
	// Shard The shard name.
	Shard *string `json:"shard,omitempty"`
	// Size The segment size in bytes.
	Size ByteSize `json:"size,omitempty"`
	// SizeMemory The segment memory in bytes.
	// A value of `-1` indicates Elasticsearch was unable to compute this number.
	SizeMemory ByteSize `json:"size.memory,omitempty"`
	// Version The version of Lucene used to write the segment.
	Version *string `json:"version,omitempty"`
}

SegmentsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/segments/types.ts#L22-L107

func NewSegmentsRecord added in v8.5.0 

func NewSegmentsRecord() *SegmentsRecord

NewSegmentsRecord returns a SegmentsRecord.

func (*SegmentsRecord) UnmarshalJSON added in v8.7.1 

func (s *SegmentsRecord) UnmarshalJSON(data []byte) error

type SegmentsStats 

type SegmentsStats struct {
	// Count Total number of segments across all shards assigned to selected nodes.
	Count int `json:"count"`
	// DocValuesMemory Total amount of memory used for doc values across all shards assigned to
	// selected nodes.
	DocValuesMemory ByteSize `json:"doc_values_memory,omitempty"`
	// DocValuesMemoryInBytes Total amount, in bytes, of memory used for doc values across all shards
	// assigned to selected nodes.
	DocValuesMemoryInBytes int64 `json:"doc_values_memory_in_bytes"`
	// FileSizes This object is not populated by the cluster stats API.
	// To get information on segment files, use the node stats API.
	FileSizes map[string]ShardFileSizeInfo `json:"file_sizes"`
	// FixedBitSet Total amount of memory used by fixed bit sets across all shards assigned to
	// selected nodes.
	// Fixed bit sets are used for nested object field types and type filters for
	// join fields.
	FixedBitSet ByteSize `json:"fixed_bit_set,omitempty"`
	// FixedBitSetMemoryInBytes Total amount of memory, in bytes, used by fixed bit sets across all shards
	// assigned to selected nodes.
	FixedBitSetMemoryInBytes    int64  `json:"fixed_bit_set_memory_in_bytes"`
	IndexWriterMaxMemoryInBytes *int64 `json:"index_writer_max_memory_in_bytes,omitempty"`
	// IndexWriterMemory Total amount of memory used by all index writers across all shards assigned
	// to selected nodes.
	IndexWriterMemory ByteSize `json:"index_writer_memory,omitempty"`
	// IndexWriterMemoryInBytes Total amount, in bytes, of memory used by all index writers across all shards
	// assigned to selected nodes.
	IndexWriterMemoryInBytes int64 `json:"index_writer_memory_in_bytes"`
	// MaxUnsafeAutoIdTimestamp Unix timestamp, in milliseconds, of the most recently retried indexing
	// request.
	MaxUnsafeAutoIdTimestamp int64 `json:"max_unsafe_auto_id_timestamp"`
	// Memory Total amount of memory used for segments across all shards assigned to
	// selected nodes.
	Memory ByteSize `json:"memory,omitempty"`
	// MemoryInBytes Total amount, in bytes, of memory used for segments across all shards
	// assigned to selected nodes.
	MemoryInBytes int64 `json:"memory_in_bytes"`
	// NormsMemory Total amount of memory used for normalization factors across all shards
	// assigned to selected nodes.
	NormsMemory ByteSize `json:"norms_memory,omitempty"`
	// NormsMemoryInBytes Total amount, in bytes, of memory used for normalization factors across all
	// shards assigned to selected nodes.
	NormsMemoryInBytes int64 `json:"norms_memory_in_bytes"`
	// PointsMemory Total amount of memory used for points across all shards assigned to selected
	// nodes.
	PointsMemory ByteSize `json:"points_memory,omitempty"`
	// PointsMemoryInBytes Total amount, in bytes, of memory used for points across all shards assigned
	// to selected nodes.
	PointsMemoryInBytes int64 `json:"points_memory_in_bytes"`
	// StoredFieldsMemoryInBytes Total amount, in bytes, of memory used for stored fields across all shards
	// assigned to selected nodes.
	StoredFieldsMemoryInBytes int64    `json:"stored_fields_memory_in_bytes"`
	StoredMemory              ByteSize `json:"stored_memory,omitempty"`
	// TermVectorsMemoryInBytes Total amount, in bytes, of memory used for term vectors across all shards
	// assigned to selected nodes.
	TermVectorsMemoryInBytes int64 `json:"term_vectors_memory_in_bytes"`
	// TermVectoryMemory Total amount of memory used for term vectors across all shards assigned to
	// selected nodes.
	TermVectoryMemory ByteSize `json:"term_vectory_memory,omitempty"`
	// TermsMemory Total amount of memory used for terms across all shards assigned to selected
	// nodes.
	TermsMemory ByteSize `json:"terms_memory,omitempty"`
	// TermsMemoryInBytes Total amount, in bytes, of memory used for terms across all shards assigned
	// to selected nodes.
	TermsMemoryInBytes int64 `json:"terms_memory_in_bytes"`
	// VersionMapMemory Total amount of memory used by all version maps across all shards assigned to
	// selected nodes.
	VersionMapMemory ByteSize `json:"version_map_memory,omitempty"`
	// VersionMapMemoryInBytes Total amount, in bytes, of memory used by all version maps across all shards
	// assigned to selected nodes.
	VersionMapMemoryInBytes int64 `json:"version_map_memory_in_bytes"`
}

SegmentsStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L276-L369

func NewSegmentsStats added in v8.5.0 

func NewSegmentsStats() *SegmentsStats

NewSegmentsStats returns a SegmentsStats.

func (*SegmentsStats) UnmarshalJSON added in v8.7.1 

func (s *SegmentsStats) UnmarshalJSON(data []byte) error

type SelectOption added in v8.15.0 

type SelectOption struct {
	Label string      `json:"label"`
	Value ScalarValue `json:"value"`
}

SelectOption type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L25-L28

func NewSelectOption added in v8.15.0 

func NewSelectOption() *SelectOption

NewSelectOption returns a SelectOption.

func (*SelectOption) UnmarshalJSON added in v8.15.0 

func (s *SelectOption) UnmarshalJSON(data []byte) error

type SemanticQuery added in v8.15.0 

type SemanticQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field The field to query, which must be a semantic_text field type
	Field string `json:"field"`
	// Query The query text
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
}

SemanticQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/SemanticQuery.ts#L22-L30

func NewSemanticQuery added in v8.15.0 

func NewSemanticQuery() *SemanticQuery

NewSemanticQuery returns a SemanticQuery.

func (*SemanticQuery) UnmarshalJSON added in v8.15.0 

func (s *SemanticQuery) UnmarshalJSON(data []byte) error

type SemanticTextProperty added in v8.15.0 

type SemanticTextProperty struct {
	// InferenceId Inference endpoint that will be used to generate embeddings for the field.
	// This parameter cannot be updated. Use the Create inference API to create the
	// endpoint.
	// If `search_inference_id` is specified, the inference endpoint will only be
	// used at index time.
	InferenceId *string           `json:"inference_id,omitempty"`
	Meta        map[string]string `json:"meta,omitempty"`
	// SearchInferenceId Inference endpoint that will be used to generate embeddings at query time.
	// You can update this parameter by using the Update mapping API. Use the Create
	// inference API to create the endpoint.
	// If not specified, the inference endpoint defined by inference_id will be used
	// at both index and query time.
	SearchInferenceId *string `json:"search_inference_id,omitempty"`
	Type              string  `json:"type,omitempty"`
}

SemanticTextProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L219-L235

func NewSemanticTextProperty added in v8.15.0 

func NewSemanticTextProperty() *SemanticTextProperty

NewSemanticTextProperty returns a SemanticTextProperty.

func (SemanticTextProperty) MarshalJSON added in v8.15.0 

func (s SemanticTextProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SemanticTextProperty) UnmarshalJSON added in v8.15.0 

func (s *SemanticTextProperty) UnmarshalJSON(data []byte) error

type SerbianAnalyzer added in v8.16.0 

type SerbianAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

SerbianAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L262-L267

func NewSerbianAnalyzer added in v8.16.0 

func NewSerbianAnalyzer() *SerbianAnalyzer

NewSerbianAnalyzer returns a SerbianAnalyzer.

func (SerbianAnalyzer) MarshalJSON added in v8.16.0 

func (s SerbianAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SerbianAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *SerbianAnalyzer) UnmarshalJSON(data []byte) error

type SerbianNormalizationTokenFilter added in v8.18.1 

type SerbianNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

SerbianNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L530-L532

func NewSerbianNormalizationTokenFilter added in v8.18.1 

func NewSerbianNormalizationTokenFilter() *SerbianNormalizationTokenFilter

NewSerbianNormalizationTokenFilter returns a SerbianNormalizationTokenFilter.

func (SerbianNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s SerbianNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SerbianNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *SerbianNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type SerialDifferencingAggregation 

type SerialDifferencingAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	// Lag The historical bucket to subtract from the current value.
	// Must be a positive, non-zero integer.
	Lag *int `json:"lag,omitempty"`
}

SerialDifferencingAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L399-L408

func NewSerialDifferencingAggregation added in v8.5.0 

func NewSerialDifferencingAggregation() *SerialDifferencingAggregation

NewSerialDifferencingAggregation returns a SerialDifferencingAggregation.

func (*SerialDifferencingAggregation) UnmarshalJSON added in v8.7.0 

func (s *SerialDifferencingAggregation) UnmarshalJSON(data []byte) error

type SerializedClusterState 

type SerializedClusterState struct {
	Diffs *SerializedClusterStateDetail `json:"diffs,omitempty"`
	// FullStates Number of published cluster states.
	FullStates *SerializedClusterStateDetail `json:"full_states,omitempty"`
}

SerializedClusterState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L232-L238

func NewSerializedClusterState added in v8.5.0 

func NewSerializedClusterState() *SerializedClusterState

NewSerializedClusterState returns a SerializedClusterState.

type SerializedClusterStateDetail 

type SerializedClusterStateDetail struct {
	CompressedSize          *string `json:"compressed_size,omitempty"`
	CompressedSizeInBytes   *int64  `json:"compressed_size_in_bytes,omitempty"`
	Count                   *int64  `json:"count,omitempty"`
	UncompressedSize        *string `json:"uncompressed_size,omitempty"`
	UncompressedSizeInBytes *int64  `json:"uncompressed_size_in_bytes,omitempty"`
}

SerializedClusterStateDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L240-L246

func NewSerializedClusterStateDetail added in v8.5.0 

func NewSerializedClusterStateDetail() *SerializedClusterStateDetail

NewSerializedClusterStateDetail returns a SerializedClusterStateDetail.

func (*SerializedClusterStateDetail) UnmarshalJSON added in v8.7.1 

func (s *SerializedClusterStateDetail) UnmarshalJSON(data []byte) error

type ServiceToken added in v8.5.0 

type ServiceToken struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

ServiceToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/create_service_token/types.ts#L22-L25

func NewServiceToken added in v8.5.0 

func NewServiceToken() *ServiceToken

NewServiceToken returns a ServiceToken.

func (*ServiceToken) UnmarshalJSON added in v8.7.1 

func (s *ServiceToken) UnmarshalJSON(data []byte) error

type SetPriorityAction added in v8.15.0 

type SetPriorityAction struct {
	Priority *int `json:"priority,omitempty"`
}

SetPriorityAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L95-L97

func NewSetPriorityAction added in v8.15.0 

func NewSetPriorityAction() *SetPriorityAction

NewSetPriorityAction returns a SetPriorityAction.

func (*SetPriorityAction) UnmarshalJSON added in v8.15.0 

func (s *SetPriorityAction) UnmarshalJSON(data []byte) error

type SetProcessor 

type SetProcessor struct {
	// CopyFrom The origin field which will be copied to `field`, cannot set `value`
	// simultaneously.
	// Supported data types are `boolean`, `number`, `array`, `object`, `string`,
	// `date`, etc.
	CopyFrom *string `json:"copy_from,omitempty"`
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to insert, upsert, or update.
	// Supports template snippets.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreEmptyValue If `true` and `value` is a template snippet that evaluates to `null` or the
	// empty string, the processor quietly exits without modifying the document.
	IgnoreEmptyValue *bool `json:"ignore_empty_value,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// MediaType The media type for encoding `value`.
	// Applies only when value is a template snippet.
	// Must be one of `application/json`, `text/plain`, or
	// `application/x-www-form-urlencoded`.
	MediaType *string `json:"media_type,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Override If `true` processor will update fields with pre-existing non-null-valued
	// field.
	// When set to `false`, such fields will not be touched.
	Override *bool `json:"override,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// Value The value to be set for the field.
	// Supports template snippets.
	// May specify only one of `value` or `copy_from`.
	Value json.RawMessage `json:"value,omitempty"`
}

SetProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1444-L1478

func NewSetProcessor added in v8.5.0 

func NewSetProcessor() *SetProcessor

NewSetProcessor returns a SetProcessor.

func (*SetProcessor) UnmarshalJSON added in v8.7.1 

func (s *SetProcessor) UnmarshalJSON(data []byte) error

type SetSecurityUserProcessor 

type SetSecurityUserProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to store the user information into.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Properties Controls what user related properties are added to the field.
	Properties []string `json:"properties,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

SetSecurityUserProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1480-L1489

func NewSetSecurityUserProcessor added in v8.5.0 

func NewSetSecurityUserProcessor() *SetSecurityUserProcessor

NewSetSecurityUserProcessor returns a SetSecurityUserProcessor.

func (*SetSecurityUserProcessor) UnmarshalJSON added in v8.7.1 

func (s *SetSecurityUserProcessor) UnmarshalJSON(data []byte) error

type Settings 

type Settings struct {
	// AlignCheckpoints Specifies whether the transform checkpoint ranges should be optimized for
	// performance. Such optimization can align
	// checkpoint ranges with the date histogram interval when date histogram is
	// specified as a group source in the
	// transform config. As a result, less document updates in the destination index
	// will be performed thus improving
	// overall performance.
	AlignCheckpoints *bool `json:"align_checkpoints,omitempty"`
	// DatesAsEpochMillis Defines if dates in the ouput should be written as ISO formatted string or as
	// millis since epoch. epoch_millis was
	// the default for transforms created before version 7.11. For compatible output
	// set this value to `true`.
	DatesAsEpochMillis *bool `json:"dates_as_epoch_millis,omitempty"`
	// DeduceMappings Specifies whether the transform should deduce the destination index mappings
	// from the transform configuration.
	DeduceMappings *bool `json:"deduce_mappings,omitempty"`
	// DocsPerSecond Specifies a limit on the number of input documents per second. This setting
	// throttles the transform by adding a
	// wait time between search requests. The default value is null, which disables
	// throttling.
	DocsPerSecond *float32 `json:"docs_per_second,omitempty"`
	// MaxPageSearchSize Defines the initial page size to use for the composite aggregation for each
	// checkpoint. If circuit breaker
	// exceptions occur, the page size is dynamically adjusted to a lower value. The
	// minimum value is `10` and the
	// maximum is `65,536`.
	MaxPageSearchSize *int `json:"max_page_search_size,omitempty"`
	// Unattended If `true`, the transform runs in unattended mode. In unattended mode, the
	// transform retries indefinitely in case
	// of an error which means the transform never fails. Setting the number of
	// retries other than infinite fails in
	// validation.
	Unattended *bool `json:"unattended,omitempty"`
}

Settings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L98-L144

func NewSettings added in v8.5.0 

func NewSettings() *Settings

NewSettings returns a Settings.

func (*Settings) UnmarshalJSON added in v8.7.1 

func (s *Settings) UnmarshalJSON(data []byte) error

type SettingsAnalyze 

type SettingsAnalyze struct {
	MaxTokenCount Stringifiedinteger `json:"max_token_count,omitempty"`
}

SettingsAnalyze type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L243-L246

func NewSettingsAnalyze added in v8.5.0 

func NewSettingsAnalyze() *SettingsAnalyze

NewSettingsAnalyze returns a SettingsAnalyze.

func (*SettingsAnalyze) UnmarshalJSON added in v8.7.1 

func (s *SettingsAnalyze) UnmarshalJSON(data []byte) error

type SettingsHighlight 

type SettingsHighlight struct {
	MaxAnalyzedOffset *int `json:"max_analyzed_offset,omitempty"`
}

SettingsHighlight type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L238-L241

func NewSettingsHighlight added in v8.5.0 

func NewSettingsHighlight() *SettingsHighlight

NewSettingsHighlight returns a SettingsHighlight.

func (*SettingsHighlight) UnmarshalJSON added in v8.7.1 

func (s *SettingsHighlight) UnmarshalJSON(data []byte) error

type SettingsQueryString 

type SettingsQueryString struct {
	Lenient Stringifiedboolean `json:"lenient"`
}

SettingsQueryString type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L258-L260

func NewSettingsQueryString added in v8.5.0 

func NewSettingsQueryString() *SettingsQueryString

NewSettingsQueryString returns a SettingsQueryString.

func (*SettingsQueryString) UnmarshalJSON added in v8.7.1 

func (s *SettingsQueryString) UnmarshalJSON(data []byte) error

type SettingsSearch 

type SettingsSearch struct {
	Idle    *SearchIdle      `json:"idle,omitempty"`
	Slowlog *SlowlogSettings `json:"slowlog,omitempty"`
}

SettingsSearch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L248-L251

func NewSettingsSearch added in v8.5.0 

func NewSettingsSearch() *SettingsSearch

NewSettingsSearch returns a SettingsSearch.

type SettingsSimilarity 

type SettingsSimilarity any

SettingsSimilarity holds the union for the following types: 

SettingsSimilarityBm25
SettingsSimilarityBoolean
SettingsSimilarityDfi
SettingsSimilarityDfr
SettingsSimilarityIb
SettingsSimilarityLmd
SettingsSimilarityLmj
SettingsSimilarityScripted

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L178-L190

type SettingsSimilarityBm25 

type SettingsSimilarityBm25 struct {
	B                *Float64 `json:"b,omitempty"`
	DiscountOverlaps *bool    `json:"discount_overlaps,omitempty"`
	K1               *Float64 `json:"k1,omitempty"`
	Type             string   `json:"type,omitempty"`
}

SettingsSimilarityBm25 type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L196-L201

func NewSettingsSimilarityBm25 added in v8.5.0 

func NewSettingsSimilarityBm25() *SettingsSimilarityBm25

NewSettingsSimilarityBm25 returns a SettingsSimilarityBm25.

func (SettingsSimilarityBm25) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityBm25) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SettingsSimilarityBm25) UnmarshalJSON added in v8.7.1 

func (s *SettingsSimilarityBm25) UnmarshalJSON(data []byte) error

type SettingsSimilarityBoolean added in v8.13.0 

type SettingsSimilarityBoolean struct {
	Type string `json:"type,omitempty"`
}

SettingsSimilarityBoolean type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L192-L194

func NewSettingsSimilarityBoolean added in v8.13.0 

func NewSettingsSimilarityBoolean() *SettingsSimilarityBoolean

NewSettingsSimilarityBoolean returns a SettingsSimilarityBoolean.

func (SettingsSimilarityBoolean) MarshalJSON added in v8.13.0 

func (s SettingsSimilarityBoolean) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type SettingsSimilarityDfi 

type SettingsSimilarityDfi struct {
	IndependenceMeasure dfiindependencemeasure.DFIIndependenceMeasure `json:"independence_measure"`
	Type                string                                        `json:"type,omitempty"`
}

SettingsSimilarityDfi type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L203-L206

func NewSettingsSimilarityDfi added in v8.5.0 

func NewSettingsSimilarityDfi() *SettingsSimilarityDfi

NewSettingsSimilarityDfi returns a SettingsSimilarityDfi.

func (SettingsSimilarityDfi) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityDfi) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type SettingsSimilarityDfr 

type SettingsSimilarityDfr struct {
	AfterEffect   dfraftereffect.DFRAfterEffect `json:"after_effect"`
	BasicModel    dfrbasicmodel.DFRBasicModel   `json:"basic_model"`
	Normalization normalization.Normalization   `json:"normalization"`
	Type          string                        `json:"type,omitempty"`
}

SettingsSimilarityDfr type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L208-L213

func NewSettingsSimilarityDfr added in v8.5.0 

func NewSettingsSimilarityDfr() *SettingsSimilarityDfr

NewSettingsSimilarityDfr returns a SettingsSimilarityDfr.

func (SettingsSimilarityDfr) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityDfr) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type SettingsSimilarityIb 

type SettingsSimilarityIb struct {
	Distribution  ibdistribution.IBDistribution `json:"distribution"`
	Lambda        iblambda.IBLambda             `json:"lambda"`
	Normalization normalization.Normalization   `json:"normalization"`
	Type          string                        `json:"type,omitempty"`
}

SettingsSimilarityIb type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L215-L220

func NewSettingsSimilarityIb added in v8.5.0 

func NewSettingsSimilarityIb() *SettingsSimilarityIb

NewSettingsSimilarityIb returns a SettingsSimilarityIb.

func (SettingsSimilarityIb) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityIb) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type SettingsSimilarityLmd 

type SettingsSimilarityLmd struct {
	Mu   *Float64 `json:"mu,omitempty"`
	Type string   `json:"type,omitempty"`
}

SettingsSimilarityLmd type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L222-L225

func NewSettingsSimilarityLmd added in v8.5.0 

func NewSettingsSimilarityLmd() *SettingsSimilarityLmd

NewSettingsSimilarityLmd returns a SettingsSimilarityLmd.

func (SettingsSimilarityLmd) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityLmd) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SettingsSimilarityLmd) UnmarshalJSON added in v8.7.1 

func (s *SettingsSimilarityLmd) UnmarshalJSON(data []byte) error

type SettingsSimilarityLmj 

type SettingsSimilarityLmj struct {
	Lambda *Float64 `json:"lambda,omitempty"`
	Type   string   `json:"type,omitempty"`
}

SettingsSimilarityLmj type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L227-L230

func NewSettingsSimilarityLmj added in v8.5.0 

func NewSettingsSimilarityLmj() *SettingsSimilarityLmj

NewSettingsSimilarityLmj returns a SettingsSimilarityLmj.

func (SettingsSimilarityLmj) MarshalJSON added in v8.9.0 

func (s SettingsSimilarityLmj) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SettingsSimilarityLmj) UnmarshalJSON added in v8.7.1 

func (s *SettingsSimilarityLmj) UnmarshalJSON(data []byte) error

type SettingsSimilarityScripted added in v8.13.0 

type SettingsSimilarityScripted struct {
	Script       Script  `json:"script"`
	Type         string  `json:"type,omitempty"`
	WeightScript *Script `json:"weight_script,omitempty"`
}

SettingsSimilarityScripted type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L232-L236

func NewSettingsSimilarityScripted added in v8.13.0 

func NewSettingsSimilarityScripted() *SettingsSimilarityScripted

NewSettingsSimilarityScripted returns a SettingsSimilarityScripted.

func (SettingsSimilarityScripted) MarshalJSON added in v8.13.0 

func (s SettingsSimilarityScripted) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

type ShapeFieldQuery 

type ShapeFieldQuery struct {
	// IndexedShape Queries using a pre-indexed shape.
	IndexedShape *FieldLookup `json:"indexed_shape,omitempty"`
	// Relation Spatial relation between the query shape and the document shape.
	Relation *geoshaperelation.GeoShapeRelation `json:"relation,omitempty"`
	// Shape Queries using an inline shape definition in GeoJSON or Well Known Text (WKT)
	// format.
	Shape json.RawMessage `json:"shape,omitempty"`
}

ShapeFieldQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L383-L396

func NewShapeFieldQuery added in v8.5.0 

func NewShapeFieldQuery() *ShapeFieldQuery

NewShapeFieldQuery returns a ShapeFieldQuery.

func (*ShapeFieldQuery) UnmarshalJSON added in v8.7.1 

func (s *ShapeFieldQuery) UnmarshalJSON(data []byte) error

type ShapeProperty 

type ShapeProperty struct {
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	IgnoreZValue    *bool                          `json:"ignore_z_value,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Orientation         *geoorientation.GeoOrientation                   `json:"orientation,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

ShapeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/geo.ts#L74-L86

func NewShapeProperty added in v8.5.0 

func NewShapeProperty() *ShapeProperty

NewShapeProperty returns a ShapeProperty.

func (ShapeProperty) MarshalJSON added in v8.9.0 

func (s ShapeProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ShapeProperty) UnmarshalJSON added in v8.7.0 

func (s *ShapeProperty) UnmarshalJSON(data []byte) error

type ShapeQuery 

type ShapeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// IgnoreUnmapped When set to `true` the query ignores an unmapped field and will not match any
	// documents.
	IgnoreUnmapped *bool                      `json:"ignore_unmapped,omitempty"`
	QueryName_     *string                    `json:"_name,omitempty"`
	ShapeQuery     map[string]ShapeFieldQuery `json:"-"`
}

ShapeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L367-L381

func NewShapeQuery added in v8.5.0 

func NewShapeQuery() *ShapeQuery

NewShapeQuery returns a ShapeQuery.

func (ShapeQuery) MarshalJSON 

func (s ShapeQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ShapeQuery) UnmarshalJSON added in v8.7.1 

func (s *ShapeQuery) UnmarshalJSON(data []byte) error

type ShardCommit 

type ShardCommit struct {
	Generation int               `json:"generation"`
	Id         string            `json:"id"`
	NumDocs    int64             `json:"num_docs"`
	UserData   map[string]string `json:"user_data"`
}

ShardCommit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L112-L117

func NewShardCommit added in v8.5.0 

func NewShardCommit() *ShardCommit

NewShardCommit returns a ShardCommit.

func (*ShardCommit) UnmarshalJSON added in v8.7.1 

func (s *ShardCommit) UnmarshalJSON(data []byte) error

type ShardFailure 

type ShardFailure struct {
	Index  *string    `json:"index,omitempty"`
	Node   *string    `json:"node,omitempty"`
	Reason ErrorCause `json:"reason"`
	Shard  int        `json:"shard"`
	Status *string    `json:"status,omitempty"`
}

ShardFailure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Errors.ts#L52-L58

func NewShardFailure added in v8.5.0 

func NewShardFailure() *ShardFailure

NewShardFailure returns a ShardFailure.

func (*ShardFailure) UnmarshalJSON added in v8.7.1 

func (s *ShardFailure) UnmarshalJSON(data []byte) error

type ShardFileSizeInfo 

type ShardFileSizeInfo struct {
	AverageSizeInBytes *int64 `json:"average_size_in_bytes,omitempty"`
	Count              *int64 `json:"count,omitempty"`
	Description        string `json:"description"`
	MaxSizeInBytes     *int64 `json:"max_size_in_bytes,omitempty"`
	MinSizeInBytes     *int64 `json:"min_size_in_bytes,omitempty"`
	SizeInBytes        int64  `json:"size_in_bytes"`
}

ShardFileSizeInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L124-L131

func NewShardFileSizeInfo added in v8.5.0 

func NewShardFileSizeInfo() *ShardFileSizeInfo

NewShardFileSizeInfo returns a ShardFileSizeInfo.

func (*ShardFileSizeInfo) UnmarshalJSON added in v8.7.1 

func (s *ShardFileSizeInfo) UnmarshalJSON(data []byte) error

type ShardHealthStats 

type ShardHealthStats struct {
	ActiveShards            int                       `json:"active_shards"`
	InitializingShards      int                       `json:"initializing_shards"`
	PrimaryActive           bool                      `json:"primary_active"`
	RelocatingShards        int                       `json:"relocating_shards"`
	Status                  healthstatus.HealthStatus `json:"status"`
	UnassignedPrimaryShards int                       `json:"unassigned_primary_shards"`
	UnassignedShards        int                       `json:"unassigned_shards"`
}

ShardHealthStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/health/types.ts#L37-L45

func NewShardHealthStats added in v8.5.0 

func NewShardHealthStats() *ShardHealthStats

NewShardHealthStats returns a ShardHealthStats.

func (*ShardHealthStats) UnmarshalJSON added in v8.7.1 

func (s *ShardHealthStats) UnmarshalJSON(data []byte) error

type ShardLease 

type ShardLease struct {
	Id             string `json:"id"`
	RetainingSeqNo int64  `json:"retaining_seq_no"`
	Source         string `json:"source"`
	Timestamp      int64  `json:"timestamp"`
}

ShardLease type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L133-L138

func NewShardLease added in v8.5.0 

func NewShardLease() *ShardLease

NewShardLease returns a ShardLease.

func (*ShardLease) UnmarshalJSON added in v8.7.1 

func (s *ShardLease) UnmarshalJSON(data []byte) error

type ShardMigrationStatus 

type ShardMigrationStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

ShardMigrationStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L52-L54

func NewShardMigrationStatus added in v8.5.0 

func NewShardMigrationStatus() *ShardMigrationStatus

NewShardMigrationStatus returns a ShardMigrationStatus.

type ShardPath 

type ShardPath struct {
	DataPath         string `json:"data_path"`
	IsCustomDataPath bool   `json:"is_custom_data_path"`
	StatePath        string `json:"state_path"`
}

ShardPath type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L140-L144

func NewShardPath added in v8.5.0 

func NewShardPath() *ShardPath

NewShardPath returns a ShardPath.

func (*ShardPath) UnmarshalJSON added in v8.7.1 

func (s *ShardPath) UnmarshalJSON(data []byte) error

type ShardProfile 

type ShardProfile struct {
	Aggregations []AggregationProfile `json:"aggregations"`
	Cluster      string               `json:"cluster"`
	Dfs          *DfsProfile          `json:"dfs,omitempty"`
	Fetch        *FetchProfile        `json:"fetch,omitempty"`
	Id           string               `json:"id"`
	Index        string               `json:"index"`
	NodeId       string               `json:"node_id"`
	Searches     []SearchProfile      `json:"searches"`
	ShardId      int                  `json:"shard_id"`
}

ShardProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/profile.ts#L142-L152

func NewShardProfile added in v8.5.0 

func NewShardProfile() *ShardProfile

NewShardProfile returns a ShardProfile.

func (*ShardProfile) UnmarshalJSON added in v8.9.0 

func (s *ShardProfile) UnmarshalJSON(data []byte) error

type ShardQueryCache 

type ShardQueryCache struct {
	CacheCount        int64 `json:"cache_count"`
	CacheSize         int64 `json:"cache_size"`
	Evictions         int64 `json:"evictions"`
	HitCount          int64 `json:"hit_count"`
	MemorySizeInBytes int64 `json:"memory_size_in_bytes"`
	MissCount         int64 `json:"miss_count"`
	TotalCount        int64 `json:"total_count"`
}

ShardQueryCache type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L146-L154

func NewShardQueryCache added in v8.5.0 

func NewShardQueryCache() *ShardQueryCache

NewShardQueryCache returns a ShardQueryCache.

func (*ShardQueryCache) UnmarshalJSON added in v8.7.1 

func (s *ShardQueryCache) UnmarshalJSON(data []byte) error

type ShardRecovery 

type ShardRecovery struct {
	Id                int64                `json:"id"`
	Index             RecoveryIndexStatus  `json:"index"`
	Primary           bool                 `json:"primary"`
	Source            RecoveryOrigin       `json:"source"`
	Stage             string               `json:"stage"`
	Start             *RecoveryStartStatus `json:"start,omitempty"`
	StartTime         DateTime             `json:"start_time,omitempty"`
	StartTimeInMillis int64                `json:"start_time_in_millis"`
	StopTime          DateTime             `json:"stop_time,omitempty"`
	StopTimeInMillis  *int64               `json:"stop_time_in_millis,omitempty"`
	Target            RecoveryOrigin       `json:"target"`
	TotalTime         Duration             `json:"total_time,omitempty"`
	TotalTimeInMillis int64                `json:"total_time_in_millis"`
	Translog          TranslogStatus       `json:"translog"`
	Type              string               `json:"type"`
	VerifyIndex       VerifyIndex          `json:"verify_index"`
}

ShardRecovery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L118-L135

func NewShardRecovery added in v8.5.0 

func NewShardRecovery() *ShardRecovery

NewShardRecovery returns a ShardRecovery.

func (*ShardRecovery) UnmarshalJSON added in v8.7.1 

func (s *ShardRecovery) UnmarshalJSON(data []byte) error

type ShardRetentionLeases 

type ShardRetentionLeases struct {
	Leases      []ShardLease `json:"leases"`
	PrimaryTerm int64        `json:"primary_term"`
	Version     int64        `json:"version"`
}

ShardRetentionLeases type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L156-L160

func NewShardRetentionLeases added in v8.5.0 

func NewShardRetentionLeases() *ShardRetentionLeases

NewShardRetentionLeases returns a ShardRetentionLeases.

func (*ShardRetentionLeases) UnmarshalJSON added in v8.7.1 

func (s *ShardRetentionLeases) UnmarshalJSON(data []byte) error

type ShardRouting 

type ShardRouting struct {
	Node           string                              `json:"node"`
	Primary        bool                                `json:"primary"`
	RelocatingNode *string                             `json:"relocating_node,omitempty"`
	State          shardroutingstate.ShardRoutingState `json:"state"`
}

ShardRouting type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L162-L167

func NewShardRouting added in v8.5.0 

func NewShardRouting() *ShardRouting

NewShardRouting returns a ShardRouting.

func (*ShardRouting) UnmarshalJSON added in v8.7.1 

func (s *ShardRouting) UnmarshalJSON(data []byte) error

type ShardSegmentRouting 

type ShardSegmentRouting struct {
	Node    string `json:"node"`
	Primary bool   `json:"primary"`
	State   string `json:"state"`
}

ShardSegmentRouting type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/segments/types.ts#L40-L44

func NewShardSegmentRouting added in v8.5.0 

func NewShardSegmentRouting() *ShardSegmentRouting

NewShardSegmentRouting returns a ShardSegmentRouting.

func (*ShardSegmentRouting) UnmarshalJSON added in v8.7.1 

func (s *ShardSegmentRouting) UnmarshalJSON(data []byte) error

type ShardSequenceNumber 

type ShardSequenceNumber struct {
	GlobalCheckpoint int64 `json:"global_checkpoint"`
	LocalCheckpoint  int64 `json:"local_checkpoint"`
	MaxSeqNo         int64 `json:"max_seq_no"`
}

ShardSequenceNumber type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L176-L180

func NewShardSequenceNumber added in v8.5.0 

func NewShardSequenceNumber() *ShardSequenceNumber

NewShardSequenceNumber returns a ShardSequenceNumber.

func (*ShardSequenceNumber) UnmarshalJSON added in v8.7.1 

func (s *ShardSequenceNumber) UnmarshalJSON(data []byte) error

type ShardStatistics 

type ShardStatistics struct {
	// Failed The number of shards the operation or search attempted to run on but failed.
	Failed   uint           `json:"failed"`
	Failures []ShardFailure `json:"failures,omitempty"`
	Skipped  *uint          `json:"skipped,omitempty"`
	// Successful The number of shards the operation or search succeeded on.
	Successful uint `json:"successful"`
	// Total The number of shards the operation or search will run on overall.
	Total uint `json:"total"`
}

ShardStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L54-L69

func NewShardStatistics added in v8.5.0 

func NewShardStatistics() *ShardStatistics

NewShardStatistics returns a ShardStatistics.

type ShardStore 

type ShardStore struct {
	Allocation     shardstoreallocation.ShardStoreAllocation `json:"allocation"`
	AllocationId   *string                                   `json:"allocation_id,omitempty"`
	ShardStore     map[string]ShardStoreNode                 `json:"-"`
	StoreException *ShardStoreException                      `json:"store_exception,omitempty"`
}

ShardStore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/shard_stores/types.ts#L29-L36

func NewShardStore added in v8.5.0 

func NewShardStore() *ShardStore

NewShardStore returns a ShardStore.

func (ShardStore) MarshalJSON added in v8.7.0 

func (s ShardStore) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*ShardStore) UnmarshalJSON added in v8.7.1 

func (s *ShardStore) UnmarshalJSON(data []byte) error

type ShardStoreException 

type ShardStoreException struct {
	Reason string `json:"reason"`
	Type   string `json:"type"`
}

ShardStoreException type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/shard_stores/types.ts#L53-L56

func NewShardStoreException added in v8.5.0 

func NewShardStoreException() *ShardStoreException

NewShardStoreException returns a ShardStoreException.

func (*ShardStoreException) UnmarshalJSON added in v8.9.0 

func (s *ShardStoreException) UnmarshalJSON(data []byte) error

type ShardStoreIndex 

type ShardStoreIndex struct {
	Aliases []string `json:"aliases,omitempty"`
	Filter  *Query   `json:"filter,omitempty"`
}

ShardStoreIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search_shards/SearchShardsResponse.ts#L62-L65

func NewShardStoreIndex added in v8.5.0 

func NewShardStoreIndex() *ShardStoreIndex

NewShardStoreIndex returns a ShardStoreIndex.

type ShardStoreNode added in v8.7.0 

type ShardStoreNode struct {
	Attributes       map[string]string `json:"attributes"`
	EphemeralId      *string           `json:"ephemeral_id,omitempty"`
	ExternalId       *string           `json:"external_id,omitempty"`
	Name             string            `json:"name"`
	Roles            []string          `json:"roles"`
	TransportAddress string            `json:"transport_address"`
}

ShardStoreNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/shard_stores/types.ts#L38-L45

func NewShardStoreNode added in v8.7.0 

func NewShardStoreNode() *ShardStoreNode

NewShardStoreNode returns a ShardStoreNode.

func (*ShardStoreNode) UnmarshalJSON added in v8.7.1 

func (s *ShardStoreNode) UnmarshalJSON(data []byte) error

type ShardStoreWrapper 

type ShardStoreWrapper struct {
	Stores []ShardStore `json:"stores"`
}

ShardStoreWrapper type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/shard_stores/types.ts#L58-L60

func NewShardStoreWrapper added in v8.5.0 

func NewShardStoreWrapper() *ShardStoreWrapper

NewShardStoreWrapper returns a ShardStoreWrapper.

type ShardsAvailabilityIndicator added in v8.7.1 

type ShardsAvailabilityIndicator struct {
	Details   *ShardsAvailabilityIndicatorDetails         `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

ShardsAvailabilityIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L105-L109

func NewShardsAvailabilityIndicator added in v8.7.1 

func NewShardsAvailabilityIndicator() *ShardsAvailabilityIndicator

NewShardsAvailabilityIndicator returns a ShardsAvailabilityIndicator.

func (*ShardsAvailabilityIndicator) UnmarshalJSON added in v8.9.0 

func (s *ShardsAvailabilityIndicator) UnmarshalJSON(data []byte) error

type ShardsAvailabilityIndicatorDetails added in v8.7.1 

type ShardsAvailabilityIndicatorDetails struct {
	CreatingPrimaries     int64 `json:"creating_primaries"`
	CreatingReplicas      int64 `json:"creating_replicas"`
	InitializingPrimaries int64 `json:"initializing_primaries"`
	InitializingReplicas  int64 `json:"initializing_replicas"`
	RestartingPrimaries   int64 `json:"restarting_primaries"`
	RestartingReplicas    int64 `json:"restarting_replicas"`
	StartedPrimaries      int64 `json:"started_primaries"`
	StartedReplicas       int64 `json:"started_replicas"`
	UnassignedPrimaries   int64 `json:"unassigned_primaries"`
	UnassignedReplicas    int64 `json:"unassigned_replicas"`
}

ShardsAvailabilityIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L110-L121

func NewShardsAvailabilityIndicatorDetails added in v8.7.1 

func NewShardsAvailabilityIndicatorDetails() *ShardsAvailabilityIndicatorDetails

NewShardsAvailabilityIndicatorDetails returns a ShardsAvailabilityIndicatorDetails.

func (*ShardsAvailabilityIndicatorDetails) UnmarshalJSON added in v8.7.1 

func (s *ShardsAvailabilityIndicatorDetails) UnmarshalJSON(data []byte) error

type ShardsCapacityIndicator added in v8.10.0 

type ShardsCapacityIndicator struct {
	Details   *ShardsCapacityIndicatorDetails             `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

ShardsCapacityIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L190-L194

func NewShardsCapacityIndicator added in v8.10.0 

func NewShardsCapacityIndicator() *ShardsCapacityIndicator

NewShardsCapacityIndicator returns a ShardsCapacityIndicator.

func (*ShardsCapacityIndicator) UnmarshalJSON added in v8.10.0 

func (s *ShardsCapacityIndicator) UnmarshalJSON(data []byte) error

type ShardsCapacityIndicatorDetails added in v8.10.0 

type ShardsCapacityIndicatorDetails struct {
	Data   ShardsCapacityIndicatorTierDetail `json:"data"`
	Frozen ShardsCapacityIndicatorTierDetail `json:"frozen"`
}

ShardsCapacityIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L196-L199

func NewShardsCapacityIndicatorDetails added in v8.10.0 

func NewShardsCapacityIndicatorDetails() *ShardsCapacityIndicatorDetails

NewShardsCapacityIndicatorDetails returns a ShardsCapacityIndicatorDetails.

type ShardsCapacityIndicatorTierDetail added in v8.10.0 

type ShardsCapacityIndicatorTierDetail struct {
	CurrentUsedShards  *int `json:"current_used_shards,omitempty"`
	MaxShardsInCluster int  `json:"max_shards_in_cluster"`
}

ShardsCapacityIndicatorTierDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L201-L204

func NewShardsCapacityIndicatorTierDetail added in v8.10.0 

func NewShardsCapacityIndicatorTierDetail() *ShardsCapacityIndicatorTierDetail

NewShardsCapacityIndicatorTierDetail returns a ShardsCapacityIndicatorTierDetail.

func (*ShardsCapacityIndicatorTierDetail) UnmarshalJSON added in v8.10.0 

func (s *ShardsCapacityIndicatorTierDetail) UnmarshalJSON(data []byte) error

type ShardsRecord 

type ShardsRecord struct {
	// BulkAvgSizeInBytes The average size in bytes of shard bulk operations.
	BulkAvgSizeInBytes *string `json:"bulk.avg_size_in_bytes,omitempty"`
	// BulkAvgTime The average time spent in shard bulk operations.
	BulkAvgTime *string `json:"bulk.avg_time,omitempty"`
	// BulkTotalOperations The number of bulk shard operations.
	BulkTotalOperations *string `json:"bulk.total_operations,omitempty"`
	// BulkTotalSizeInBytes The total size in bytes of shard bulk operations.
	BulkTotalSizeInBytes *string `json:"bulk.total_size_in_bytes,omitempty"`
	// BulkTotalTime The time spent in shard bulk operations.
	BulkTotalTime *string `json:"bulk.total_time,omitempty"`
	// CompletionSize The size of completion.
	CompletionSize *string `json:"completion.size,omitempty"`
	// Dataset total size of dataset (including the cache for partially mounted indices)
	Dataset *string `json:"dataset,omitempty"`
	// Docs The number of documents in the shard.
	Docs *string `json:"docs,omitempty"`
	// FielddataEvictions The fielddata cache evictions.
	FielddataEvictions *string `json:"fielddata.evictions,omitempty"`
	// FielddataMemorySize The used fielddata cache memory.
	FielddataMemorySize *string `json:"fielddata.memory_size,omitempty"`
	// FlushTotal The number of flushes.
	FlushTotal *string `json:"flush.total,omitempty"`
	// FlushTotalTime The time spent in flush.
	FlushTotalTime *string `json:"flush.total_time,omitempty"`
	// GetCurrent The number of current get operations.
	GetCurrent *string `json:"get.current,omitempty"`
	// GetExistsTime The time spent in successful get operations.
	GetExistsTime *string `json:"get.exists_time,omitempty"`
	// GetExistsTotal The number of successful get operations.
	GetExistsTotal *string `json:"get.exists_total,omitempty"`
	// GetMissingTime The time spent in failed get operations.
	GetMissingTime *string `json:"get.missing_time,omitempty"`
	// GetMissingTotal The number of failed get operations.
	GetMissingTotal *string `json:"get.missing_total,omitempty"`
	// GetTime The time spent in get operations.
	GetTime *string `json:"get.time,omitempty"`
	// GetTotal The number of get operations.
	GetTotal *string `json:"get.total,omitempty"`
	// Id The unique identifier for the node.
	Id *string `json:"id,omitempty"`
	// Index The index name.
	Index *string `json:"index,omitempty"`
	// IndexingDeleteCurrent The number of current deletion operations.
	IndexingDeleteCurrent *string `json:"indexing.delete_current,omitempty"`
	// IndexingDeleteTime The time spent in deletion operations.
	IndexingDeleteTime *string `json:"indexing.delete_time,omitempty"`
	// IndexingDeleteTotal The number of delete operations.
	IndexingDeleteTotal *string `json:"indexing.delete_total,omitempty"`
	// IndexingIndexCurrent The number of current indexing operations.
	IndexingIndexCurrent *string `json:"indexing.index_current,omitempty"`
	// IndexingIndexFailed The number of failed indexing operations.
	IndexingIndexFailed *string `json:"indexing.index_failed,omitempty"`
	// IndexingIndexTime The time spent in indexing operations.
	IndexingIndexTime *string `json:"indexing.index_time,omitempty"`
	// IndexingIndexTotal The number of indexing operations.
	IndexingIndexTotal *string `json:"indexing.index_total,omitempty"`
	// Ip The IP address of the node.
	Ip *string `json:"ip,omitempty"`
	// MergesCurrent The number of current merge operations.
	MergesCurrent *string `json:"merges.current,omitempty"`
	// MergesCurrentDocs The number of current merging documents.
	MergesCurrentDocs *string `json:"merges.current_docs,omitempty"`
	// MergesCurrentSize The size of current merge operations.
	MergesCurrentSize *string `json:"merges.current_size,omitempty"`
	// MergesTotal The number of completed merge operations.
	MergesTotal *string `json:"merges.total,omitempty"`
	// MergesTotalDocs The nuber of merged documents.
	MergesTotalDocs *string `json:"merges.total_docs,omitempty"`
	// MergesTotalSize The size of current merges.
	MergesTotalSize *string `json:"merges.total_size,omitempty"`
	// MergesTotalTime The time spent merging documents.
	MergesTotalTime *string `json:"merges.total_time,omitempty"`
	// Node The name of node.
	Node *string `json:"node,omitempty"`
	// PathData The shard data path.
	PathData *string `json:"path.data,omitempty"`
	// PathState The shard state path.
	PathState *string `json:"path.state,omitempty"`
	// Prirep The shard type: `primary` or `replica`.
	Prirep *string `json:"prirep,omitempty"`
	// QueryCacheEvictions The query cache evictions.
	QueryCacheEvictions *string `json:"query_cache.evictions,omitempty"`
	// QueryCacheMemorySize The used query cache memory.
	QueryCacheMemorySize *string `json:"query_cache.memory_size,omitempty"`
	// RecoverysourceType The type of recovery source.
	RecoverysourceType *string `json:"recoverysource.type,omitempty"`
	// RefreshExternalTime The time spent in external refreshes.
	RefreshExternalTime *string `json:"refresh.external_time,omitempty"`
	// RefreshExternalTotal The total nunber of external refreshes.
	RefreshExternalTotal *string `json:"refresh.external_total,omitempty"`
	// RefreshListeners The number of pending refresh listeners.
	RefreshListeners *string `json:"refresh.listeners,omitempty"`
	// RefreshTime The time spent in refreshes.
	RefreshTime *string `json:"refresh.time,omitempty"`
	// RefreshTotal The total number of refreshes.
	RefreshTotal *string `json:"refresh.total,omitempty"`
	// SearchFetchCurrent The current fetch phase operations.
	SearchFetchCurrent *string `json:"search.fetch_current,omitempty"`
	// SearchFetchTime The time spent in fetch phase.
	SearchFetchTime *string `json:"search.fetch_time,omitempty"`
	// SearchFetchTotal The total number of fetch operations.
	SearchFetchTotal *string `json:"search.fetch_total,omitempty"`
	// SearchOpenContexts The number of open search contexts.
	SearchOpenContexts *string `json:"search.open_contexts,omitempty"`
	// SearchQueryCurrent The current query phase operations.
	SearchQueryCurrent *string `json:"search.query_current,omitempty"`
	// SearchQueryTime The time spent in query phase.
	SearchQueryTime *string `json:"search.query_time,omitempty"`
	// SearchQueryTotal The total number of query phase operations.
	SearchQueryTotal *string `json:"search.query_total,omitempty"`
	// SearchScrollCurrent The open scroll contexts.
	SearchScrollCurrent *string `json:"search.scroll_current,omitempty"`
	// SearchScrollTime The time scroll contexts were held open.
	SearchScrollTime *string `json:"search.scroll_time,omitempty"`
	// SearchScrollTotal The number of completed scroll contexts.
	SearchScrollTotal *string `json:"search.scroll_total,omitempty"`
	// SegmentsCount The number of segments.
	SegmentsCount *string `json:"segments.count,omitempty"`
	// SegmentsFixedBitsetMemory The memory used by fixed bit sets for nested object field types and export
	// type filters for types referred in `_parent` fields.
	SegmentsFixedBitsetMemory *string `json:"segments.fixed_bitset_memory,omitempty"`
	// SegmentsIndexWriterMemory The memory used by the index writer.
	SegmentsIndexWriterMemory *string `json:"segments.index_writer_memory,omitempty"`
	// SegmentsMemory The memory used by segments.
	SegmentsMemory *string `json:"segments.memory,omitempty"`
	// SegmentsVersionMapMemory The memory used by the version map.
	SegmentsVersionMapMemory *string `json:"segments.version_map_memory,omitempty"`
	// SeqNoGlobalCheckpoint The global checkpoint.
	SeqNoGlobalCheckpoint *string `json:"seq_no.global_checkpoint,omitempty"`
	// SeqNoLocalCheckpoint The local checkpoint.
	SeqNoLocalCheckpoint *string `json:"seq_no.local_checkpoint,omitempty"`
	// SeqNoMax The maximum sequence number.
	SeqNoMax *string `json:"seq_no.max,omitempty"`
	// Shard The shard name.
	Shard *string `json:"shard,omitempty"`
	// State The shard state.
	// Returned values include:
	// `INITIALIZING`: The shard is recovering from a peer shard or gateway.
	// `RELOCATING`: The shard is relocating.
	// `STARTED`: The shard has started.
	// `UNASSIGNED`: The shard is not assigned to any node.
	State *string `json:"state,omitempty"`
	// Store The disk space used by the shard.
	Store *string `json:"store,omitempty"`
	// SyncId The sync identifier.
	SyncId *string `json:"sync_id,omitempty"`
	// UnassignedAt The time at which the shard became unassigned in Coordinated Universal Time
	// (UTC).
	UnassignedAt *string `json:"unassigned.at,omitempty"`
	// UnassignedDetails Additional details as to why the shard became unassigned.
	// It does not explain why the shard is not assigned; use the cluster allocation
	// explain API for that information.
	UnassignedDetails *string `json:"unassigned.details,omitempty"`
	// UnassignedFor The time at which the shard was requested to be unassigned in Coordinated
	// Universal Time (UTC).
	UnassignedFor *string `json:"unassigned.for,omitempty"`
	// UnassignedReason The reason for the last change to the state of an unassigned shard.
	// It does not explain why the shard is currently unassigned; use the cluster
	// allocation explain API for that information.
	// Returned values include:
	// `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the
	// shard.
	// `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery.
	// `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling
	// index.
	// `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed
	// index.
	// `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing
	// an empty primary using the cluster reroute API.
	// `INDEX_CLOSED`: Unassigned because the index was closed.
	// `INDEX_CREATED`: Unassigned as a result of an API creation of an index.
	// `INDEX_REOPENED`: Unassigned as a result of opening a closed index.
	// `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster
	// reroute API.
	// `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index.
	// `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the
	// cluster.
	// `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was
	// registered as restarting using the node shutdown API.
	// `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary
	// shard failed before the initialization completed.
	// `REALLOCATED_REPLICA`: A better replica location is identified and causes the
	// existing replica allocation to be cancelled.
	// `REINITIALIZED`: When a shard moves from started back to initializing.
	// `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.
	// `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute
	// command.
	UnassignedReason *string `json:"unassigned.reason,omitempty"`
	// WarmerCurrent The number of current warmer operations.
	WarmerCurrent *string `json:"warmer.current,omitempty"`
	// WarmerTotal The total number of warmer operations.
	WarmerTotal *string `json:"warmer.total,omitempty"`
	// WarmerTotalTime The time spent in warmer operations.
	WarmerTotalTime *string `json:"warmer.total_time,omitempty"`
}

ShardsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/shards/types.ts#L20-L427

func NewShardsRecord added in v8.5.0 

func NewShardsRecord() *ShardsRecord

NewShardsRecord returns a ShardsRecord.

func (*ShardsRecord) UnmarshalJSON added in v8.7.1 

func (s *ShardsRecord) UnmarshalJSON(data []byte) error

type ShardsSegment 

type ShardsSegment struct {
	NumCommittedSegments int                 `json:"num_committed_segments"`
	NumSearchSegments    int                 `json:"num_search_segments"`
	Routing              ShardSegmentRouting `json:"routing"`
	Segments             map[string]Segment  `json:"segments"`
}

ShardsSegment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/segments/types.ts#L46-L51

func NewShardsSegment added in v8.5.0 

func NewShardsSegment() *ShardsSegment

NewShardsSegment returns a ShardsSegment.

func (*ShardsSegment) UnmarshalJSON added in v8.7.1 

func (s *ShardsSegment) UnmarshalJSON(data []byte) error

type ShardsStatsSummary 

type ShardsStatsSummary struct {
	Incremental       ShardsStatsSummaryItem `json:"incremental"`
	StartTimeInMillis int64                  `json:"start_time_in_millis"`
	Time              Duration               `json:"time,omitempty"`
	TimeInMillis      int64                  `json:"time_in_millis"`
	Total             ShardsStatsSummaryItem `json:"total"`
}

ShardsStatsSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotShardsStatus.ts#L29-L35

func NewShardsStatsSummary added in v8.5.0 

func NewShardsStatsSummary() *ShardsStatsSummary

NewShardsStatsSummary returns a ShardsStatsSummary.

func (*ShardsStatsSummary) UnmarshalJSON added in v8.7.1 

func (s *ShardsStatsSummary) UnmarshalJSON(data []byte) error

type ShardsStatsSummaryItem 

type ShardsStatsSummaryItem struct {
	FileCount   int64 `json:"file_count"`
	SizeInBytes int64 `json:"size_in_bytes"`
}

ShardsStatsSummaryItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotShardsStatus.ts#L37-L40

func NewShardsStatsSummaryItem added in v8.5.0 

func NewShardsStatsSummaryItem() *ShardsStatsSummaryItem

NewShardsStatsSummaryItem returns a ShardsStatsSummaryItem.

func (*ShardsStatsSummaryItem) UnmarshalJSON added in v8.7.1 

func (s *ShardsStatsSummaryItem) UnmarshalJSON(data []byte) error

type ShardsTotalStats 

type ShardsTotalStats struct {
	TotalCount int64 `json:"total_count"`
}

ShardsTotalStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/stats/types.ts#L182-L184

func NewShardsTotalStats added in v8.5.0 

func NewShardsTotalStats() *ShardsTotalStats

NewShardsTotalStats returns a ShardsTotalStats.

func (*ShardsTotalStats) UnmarshalJSON added in v8.7.1 

func (s *ShardsTotalStats) UnmarshalJSON(data []byte) error

type Shared 

type Shared struct {
	BytesReadInBytes    ByteSize `json:"bytes_read_in_bytes"`
	BytesWrittenInBytes ByteSize `json:"bytes_written_in_bytes"`
	Evictions           int64    `json:"evictions"`
	NumRegions          int      `json:"num_regions"`
	Reads               int64    `json:"reads"`
	RegionSizeInBytes   ByteSize `json:"region_size_in_bytes"`
	SizeInBytes         ByteSize `json:"size_in_bytes"`
	Writes              int64    `json:"writes"`
}

Shared type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/searchable_snapshots/cache_stats/Response.ts#L34-L43

func NewShared added in v8.5.0 

func NewShared() *Shared

NewShared returns a Shared.

func (*Shared) UnmarshalJSON added in v8.7.1 

func (s *Shared) UnmarshalJSON(data []byte) error

type SharedFileSystemRepository added in v8.13.0 

type SharedFileSystemRepository struct {
	Settings SharedFileSystemRepositorySettings `json:"settings"`
	Type     string                             `json:"type,omitempty"`
	Uuid     *string                            `json:"uuid,omitempty"`
}

SharedFileSystemRepository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L55-L58

func NewSharedFileSystemRepository added in v8.13.0 

func NewSharedFileSystemRepository() *SharedFileSystemRepository

NewSharedFileSystemRepository returns a SharedFileSystemRepository.

func (SharedFileSystemRepository) MarshalJSON added in v8.13.0 

func (s SharedFileSystemRepository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SharedFileSystemRepository) UnmarshalJSON added in v8.13.0 

func (s *SharedFileSystemRepository) UnmarshalJSON(data []byte) error

type SharedFileSystemRepositorySettings added in v8.13.0 

type SharedFileSystemRepositorySettings struct {
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	Location               string   `json:"location"`
	MaxNumberOfSnapshots   *int     `json:"max_number_of_snapshots,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	Readonly               *bool    `json:"readonly,omitempty"`
}

SharedFileSystemRepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L104-L108

func NewSharedFileSystemRepositorySettings added in v8.13.0 

func NewSharedFileSystemRepositorySettings() *SharedFileSystemRepositorySettings

NewSharedFileSystemRepositorySettings returns a SharedFileSystemRepositorySettings.

func (*SharedFileSystemRepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *SharedFileSystemRepositorySettings) UnmarshalJSON(data []byte) error

type ShingleTokenFilter 

type ShingleTokenFilter struct {
	// FillerToken String used in shingles as a replacement for empty positions that do not
	// contain a token. This filler token is only used in shingles, not original
	// unigrams. Defaults to an underscore (`_`).
	FillerToken *string `json:"filler_token,omitempty"`
	// MaxShingleSize Maximum number of tokens to concatenate when creating shingles. Defaults to
	// `2`.
	MaxShingleSize Stringifiedinteger `json:"max_shingle_size,omitempty"`
	// MinShingleSize Minimum number of tokens to concatenate when creating shingles. Defaults to
	// `2`.
	MinShingleSize Stringifiedinteger `json:"min_shingle_size,omitempty"`
	// OutputUnigrams If `true`, the output includes the original input tokens. If `false`, the
	// output only includes shingles; the original input tokens are removed.
	// Defaults to `true`.
	OutputUnigrams *bool `json:"output_unigrams,omitempty"`
	// OutputUnigramsIfNoShingles If `true`, the output includes the original input tokens only if no shingles
	// are produced; if shingles are produced, the output only includes shingles.
	// Defaults to `false`.
	OutputUnigramsIfNoShingles *bool `json:"output_unigrams_if_no_shingles,omitempty"`
	// TokenSeparator Separator used to concatenate adjacent tokens to form a shingle. Defaults to
	// a space (`" "`).
	TokenSeparator *string `json:"token_separator,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

ShingleTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L109-L123

func NewShingleTokenFilter added in v8.5.0 

func NewShingleTokenFilter() *ShingleTokenFilter

NewShingleTokenFilter returns a ShingleTokenFilter.

func (ShingleTokenFilter) MarshalJSON added in v8.9.0 

func (s ShingleTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ShingleTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *ShingleTokenFilter) UnmarshalJSON(data []byte) error

type ShortNumberProperty 

type ShortNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *int                                             `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

ShortNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L180-L183

func NewShortNumberProperty added in v8.5.0 

func NewShortNumberProperty() *ShortNumberProperty

NewShortNumberProperty returns a ShortNumberProperty.

func (ShortNumberProperty) MarshalJSON added in v8.9.0 

func (s ShortNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ShortNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *ShortNumberProperty) UnmarshalJSON(data []byte) error

type ShrinkAction added in v8.15.0 

type ShrinkAction struct {
	AllowWriteAfterShrink *bool    `json:"allow_write_after_shrink,omitempty"`
	MaxPrimaryShardSize   ByteSize `json:"max_primary_shard_size,omitempty"`
	NumberOfShards        *int     `json:"number_of_shards,omitempty"`
}

ShrinkAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L117-L121

func NewShrinkAction added in v8.15.0 

func NewShrinkAction() *ShrinkAction

NewShrinkAction returns a ShrinkAction.

func (*ShrinkAction) UnmarshalJSON added in v8.15.0 

func (s *ShrinkAction) UnmarshalJSON(data []byte) error

type SignificantLongTermsAggregate 

type SignificantLongTermsAggregate struct {
	BgCount  *int64                            `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantLongTermsBucket `json:"buckets"`
	DocCount *int64                            `json:"doc_count,omitempty"`
	Meta     Metadata                          `json:"meta,omitempty"`
}

SignificantLongTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L668-L670

func NewSignificantLongTermsAggregate added in v8.5.0 

func NewSignificantLongTermsAggregate() *SignificantLongTermsAggregate

NewSignificantLongTermsAggregate returns a SignificantLongTermsAggregate.

func (*SignificantLongTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *SignificantLongTermsAggregate) UnmarshalJSON(data []byte) error

type SignificantLongTermsBucket 

type SignificantLongTermsBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	BgCount      int64                `json:"bg_count"`
	DocCount     int64                `json:"doc_count"`
	Key          int64                `json:"key"`
	KeyAsString  *string              `json:"key_as_string,omitempty"`
	Score        Float64              `json:"score"`
}

SignificantLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L677-L680

func NewSignificantLongTermsBucket added in v8.5.0 

func NewSignificantLongTermsBucket() *SignificantLongTermsBucket

NewSignificantLongTermsBucket returns a SignificantLongTermsBucket.

func (SignificantLongTermsBucket) MarshalJSON 

func (s SignificantLongTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*SignificantLongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *SignificantLongTermsBucket) UnmarshalJSON(data []byte) error

type SignificantStringTermsAggregate 

type SignificantStringTermsAggregate struct {
	BgCount  *int64                              `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantStringTermsBucket `json:"buckets"`
	DocCount *int64                              `json:"doc_count,omitempty"`
	Meta     Metadata                            `json:"meta,omitempty"`
}

SignificantStringTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L682-L684

func NewSignificantStringTermsAggregate added in v8.5.0 

func NewSignificantStringTermsAggregate() *SignificantStringTermsAggregate

NewSignificantStringTermsAggregate returns a SignificantStringTermsAggregate.

func (*SignificantStringTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *SignificantStringTermsAggregate) UnmarshalJSON(data []byte) error

type SignificantStringTermsBucket 

type SignificantStringTermsBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	BgCount      int64                `json:"bg_count"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
	Score        Float64              `json:"score"`
}

SignificantStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L686-L688

func NewSignificantStringTermsBucket added in v8.5.0 

func NewSignificantStringTermsBucket() *SignificantStringTermsBucket

NewSignificantStringTermsBucket returns a SignificantStringTermsBucket.

func (SignificantStringTermsBucket) MarshalJSON 

func (s SignificantStringTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*SignificantStringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *SignificantStringTermsBucket) UnmarshalJSON(data []byte) error

type SignificantTermsAggregateBaseSignificantLongTermsBucket added in v8.5.0 

type SignificantTermsAggregateBaseSignificantLongTermsBucket struct {
	BgCount  *int64                            `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantLongTermsBucket `json:"buckets"`
	DocCount *int64                            `json:"doc_count,omitempty"`
	Meta     Metadata                          `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseSignificantLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L658-L666

func NewSignificantTermsAggregateBaseSignificantLongTermsBucket added in v8.5.0 

func NewSignificantTermsAggregateBaseSignificantLongTermsBucket() *SignificantTermsAggregateBaseSignificantLongTermsBucket

NewSignificantTermsAggregateBaseSignificantLongTermsBucket returns a SignificantTermsAggregateBaseSignificantLongTermsBucket.

func (*SignificantTermsAggregateBaseSignificantLongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *SignificantTermsAggregateBaseSignificantLongTermsBucket) UnmarshalJSON(data []byte) error

type SignificantTermsAggregateBaseSignificantStringTermsBucket added in v8.5.0 

type SignificantTermsAggregateBaseSignificantStringTermsBucket struct {
	BgCount  *int64                              `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantStringTermsBucket `json:"buckets"`
	DocCount *int64                              `json:"doc_count,omitempty"`
	Meta     Metadata                            `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseSignificantStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L658-L666

func NewSignificantTermsAggregateBaseSignificantStringTermsBucket added in v8.5.0 

func NewSignificantTermsAggregateBaseSignificantStringTermsBucket() *SignificantTermsAggregateBaseSignificantStringTermsBucket

NewSignificantTermsAggregateBaseSignificantStringTermsBucket returns a SignificantTermsAggregateBaseSignificantStringTermsBucket.

func (*SignificantTermsAggregateBaseSignificantStringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *SignificantTermsAggregateBaseSignificantStringTermsBucket) UnmarshalJSON(data []byte) error

type SignificantTermsAggregateBaseVoid added in v8.5.0 

type SignificantTermsAggregateBaseVoid struct {
	BgCount  *int64      `json:"bg_count,omitempty"`
	Buckets  BucketsVoid `json:"buckets"`
	DocCount *int64      `json:"doc_count,omitempty"`
	Meta     Metadata    `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L658-L666

func NewSignificantTermsAggregateBaseVoid added in v8.5.0 

func NewSignificantTermsAggregateBaseVoid() *SignificantTermsAggregateBaseVoid

NewSignificantTermsAggregateBaseVoid returns a SignificantTermsAggregateBaseVoid.

func (*SignificantTermsAggregateBaseVoid) UnmarshalJSON added in v8.7.0 

func (s *SignificantTermsAggregateBaseVoid) UnmarshalJSON(data []byte) error

type SignificantTermsAggregation 

type SignificantTermsAggregation struct {
	// BackgroundFilter A background filter that can be used to focus in on significant terms within
	// a narrower context, instead of the entire index.
	BackgroundFilter *Query `json:"background_filter,omitempty"`
	// ChiSquare Use Chi square, as described in "Information Retrieval", Manning et al.,
	// Chapter 13.5.2, as the significance score.
	ChiSquare *ChiSquareHeuristic `json:"chi_square,omitempty"`
	// Exclude Terms to exclude.
	Exclude []string `json:"exclude,omitempty"`
	// ExecutionHint Mechanism by which the aggregation should be executed: using field values
	// directly or using global ordinals.
	ExecutionHint *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	// Field The field from which to return significant terms.
	Field *string `json:"field,omitempty"`
	// Gnd Use Google normalized distance as described in "The Google Similarity
	// Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
	Gnd *GoogleNormalizedDistanceHeuristic `json:"gnd,omitempty"`
	// Include Terms to include.
	Include TermsInclude `json:"include,omitempty"`
	// Jlh Use JLH score as the significance score.
	Jlh *EmptyObject `json:"jlh,omitempty"`
	// MinDocCount Only return terms that are found in more than `min_doc_count` hits.
	MinDocCount *int64 `json:"min_doc_count,omitempty"`
	// MutualInformation Use mutual information as described in "Information Retrieval", Manning et
	// al., Chapter 13.5.1, as the significance score.
	MutualInformation *MutualInformationHeuristic `json:"mutual_information,omitempty"`
	// Percentage A simple calculation of the number of documents in the foreground sample with
	// a term divided by the number of documents in the background with the term.
	Percentage *PercentageScoreHeuristic `json:"percentage,omitempty"`
	// ScriptHeuristic Customized score, implemented via a script.
	ScriptHeuristic *ScriptedHeuristic `json:"script_heuristic,omitempty"`
	// ShardMinDocCount Regulates the certainty a shard has if the term should actually be added to
	// the candidate list or not with respect to the `min_doc_count`.
	// Terms will only be considered if their local shard frequency within the set
	// is higher than the `shard_min_doc_count`.
	ShardMinDocCount *int64 `json:"shard_min_doc_count,omitempty"`
	// ShardSize Can be used to control the volumes of candidate terms produced by each shard.
	// By default, `shard_size` will be automatically estimated based on the number
	// of shards and the `size` parameter.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The number of buckets returned out of the overall terms list.
	Size *int `json:"size,omitempty"`
}

SignificantTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L817-L884

func NewSignificantTermsAggregation added in v8.5.0 

func NewSignificantTermsAggregation() *SignificantTermsAggregation

NewSignificantTermsAggregation returns a SignificantTermsAggregation.

func (*SignificantTermsAggregation) UnmarshalJSON added in v8.7.1 

func (s *SignificantTermsAggregation) UnmarshalJSON(data []byte) error

type SignificantTextAggregation 

type SignificantTextAggregation struct {
	// BackgroundFilter A background filter that can be used to focus in on significant terms within
	// a narrower context, instead of the entire index.
	BackgroundFilter *Query `json:"background_filter,omitempty"`
	// ChiSquare Use Chi square, as described in "Information Retrieval", Manning et al.,
	// Chapter 13.5.2, as the significance score.
	ChiSquare *ChiSquareHeuristic `json:"chi_square,omitempty"`
	// Exclude Values to exclude.
	Exclude []string `json:"exclude,omitempty"`
	// ExecutionHint Determines whether the aggregation will use field values directly or global
	// ordinals.
	ExecutionHint *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	// Field The field from which to return significant text.
	Field *string `json:"field,omitempty"`
	// FilterDuplicateText Whether to out duplicate text to deal with noisy data.
	FilterDuplicateText *bool `json:"filter_duplicate_text,omitempty"`
	// Gnd Use Google normalized distance as described in "The Google Similarity
	// Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
	Gnd *GoogleNormalizedDistanceHeuristic `json:"gnd,omitempty"`
	// Include Values to include.
	Include TermsInclude `json:"include,omitempty"`
	// Jlh Use JLH score as the significance score.
	Jlh *EmptyObject `json:"jlh,omitempty"`
	// MinDocCount Only return values that are found in more than `min_doc_count` hits.
	MinDocCount *int64 `json:"min_doc_count,omitempty"`
	// MutualInformation Use mutual information as described in "Information Retrieval", Manning et
	// al., Chapter 13.5.1, as the significance score.
	MutualInformation *MutualInformationHeuristic `json:"mutual_information,omitempty"`
	// Percentage A simple calculation of the number of documents in the foreground sample with
	// a term divided by the number of documents in the background with the term.
	Percentage *PercentageScoreHeuristic `json:"percentage,omitempty"`
	// ScriptHeuristic Customized score, implemented via a script.
	ScriptHeuristic *ScriptedHeuristic `json:"script_heuristic,omitempty"`
	// ShardMinDocCount Regulates the certainty a shard has if the values should actually be added to
	// the candidate list or not with respect to the min_doc_count.
	// Values will only be considered if their local shard frequency within the set
	// is higher than the `shard_min_doc_count`.
	ShardMinDocCount *int64 `json:"shard_min_doc_count,omitempty"`
	// ShardSize The number of candidate terms produced by each shard.
	// By default, `shard_size` will be automatically estimated based on the number
	// of shards and the `size` parameter.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The number of buckets returned out of the overall terms list.
	Size *int `json:"size,omitempty"`
	// SourceFields Overrides the JSON `_source` fields from which text will be analyzed.
	SourceFields []string `json:"source_fields,omitempty"`
}

SignificantTextAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L886-L961

func NewSignificantTextAggregation added in v8.5.0 

func NewSignificantTextAggregation() *SignificantTextAggregation

NewSignificantTextAggregation returns a SignificantTextAggregation.

func (*SignificantTextAggregation) UnmarshalJSON added in v8.7.1 

func (s *SignificantTextAggregation) UnmarshalJSON(data []byte) error

type SimpleAnalyzer 

type SimpleAnalyzer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

SimpleAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L320-L323

func NewSimpleAnalyzer added in v8.5.0 

func NewSimpleAnalyzer() *SimpleAnalyzer

NewSimpleAnalyzer returns a SimpleAnalyzer.

func (SimpleAnalyzer) MarshalJSON added in v8.9.0 

func (s SimpleAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SimpleAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *SimpleAnalyzer) UnmarshalJSON(data []byte) error

type SimpleMovingAverageAggregation 

type SimpleMovingAverageAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
	Minimize  *bool                `json:"minimize,omitempty"`
	Model     string               `json:"model,omitempty"`
	Predict   *int                 `json:"predict,omitempty"`
	Settings  EmptyObject          `json:"settings"`
	Window    *int                 `json:"window,omitempty"`
}

SimpleMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L273-L276

func NewSimpleMovingAverageAggregation added in v8.5.0 

func NewSimpleMovingAverageAggregation() *SimpleMovingAverageAggregation

NewSimpleMovingAverageAggregation returns a SimpleMovingAverageAggregation.

func (SimpleMovingAverageAggregation) MarshalJSON added in v8.9.0 

func (s SimpleMovingAverageAggregation) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SimpleMovingAverageAggregation) UnmarshalJSON added in v8.7.0 

func (s *SimpleMovingAverageAggregation) UnmarshalJSON(data []byte) error

type SimplePatternSplitTokenizer added in v8.16.0 

type SimplePatternSplitTokenizer struct {
	Pattern *string `json:"pattern,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

SimplePatternSplitTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L116-L119

func NewSimplePatternSplitTokenizer added in v8.16.0 

func NewSimplePatternSplitTokenizer() *SimplePatternSplitTokenizer

NewSimplePatternSplitTokenizer returns a SimplePatternSplitTokenizer.

func (SimplePatternSplitTokenizer) MarshalJSON added in v8.16.0 

func (s SimplePatternSplitTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SimplePatternSplitTokenizer) UnmarshalJSON added in v8.16.0 

func (s *SimplePatternSplitTokenizer) UnmarshalJSON(data []byte) error

type SimplePatternTokenizer added in v8.16.0 

type SimplePatternTokenizer struct {
	Pattern *string `json:"pattern,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

SimplePatternTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L111-L114

func NewSimplePatternTokenizer added in v8.16.0 

func NewSimplePatternTokenizer() *SimplePatternTokenizer

NewSimplePatternTokenizer returns a SimplePatternTokenizer.

func (SimplePatternTokenizer) MarshalJSON added in v8.16.0 

func (s SimplePatternTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SimplePatternTokenizer) UnmarshalJSON added in v8.16.0 

func (s *SimplePatternTokenizer) UnmarshalJSON(data []byte) error

type SimpleQueryStringFlags 

type SimpleQueryStringFlags PipeSeparatedFlagsSimpleQueryStringFlag

SimpleQueryStringFlags type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L774-L778

type SimpleQueryStringQuery 

type SimpleQueryStringQuery struct {
	// AnalyzeWildcard If `true`, the query attempts to analyze wildcard terms in the query string.
	AnalyzeWildcard *bool `json:"analyze_wildcard,omitempty"`
	// Analyzer Analyzer used to convert text in the query string into tokens.
	Analyzer *string `json:"analyzer,omitempty"`
	// AutoGenerateSynonymsPhraseQuery If `true`, the parser creates a match_phrase query for each multi-position
	// token.
	AutoGenerateSynonymsPhraseQuery *bool `json:"auto_generate_synonyms_phrase_query,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// DefaultOperator Default boolean logic used to interpret text in the query string if no
	// operators are specified.
	DefaultOperator *operator.Operator `json:"default_operator,omitempty"`
	// Fields Array of fields you wish to search.
	// Accepts wildcard expressions.
	// You also can boost relevance scores for matches to particular fields using a
	// caret (`^`) notation.
	// Defaults to the `index.query.default_field index` setting, which has a
	// default value of `*`.
	Fields []string `json:"fields,omitempty"`
	// Flags List of enabled operators for the simple query string syntax.
	Flags PipeSeparatedFlagsSimpleQueryStringFlag `json:"flags,omitempty"`
	// FuzzyMaxExpansions Maximum number of terms to which the query expands for fuzzy matching.
	FuzzyMaxExpansions *int `json:"fuzzy_max_expansions,omitempty"`
	// FuzzyPrefixLength Number of beginning characters left unchanged for fuzzy matching.
	FuzzyPrefixLength *int `json:"fuzzy_prefix_length,omitempty"`
	// FuzzyTranspositions If `true`, edits for fuzzy matching include transpositions of two adjacent
	// characters (for example, `ab` to `ba`).
	FuzzyTranspositions *bool `json:"fuzzy_transpositions,omitempty"`
	// Lenient If `true`, format-based errors, such as providing a text value for a numeric
	// field, are ignored.
	Lenient *bool `json:"lenient,omitempty"`
	// MinimumShouldMatch Minimum number of clauses that must match for a document to be returned.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// Query Query string in the simple query string syntax you wish to parse and use for
	// search.
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
	// QuoteFieldSuffix Suffix appended to quoted text in the query string.
	QuoteFieldSuffix *string `json:"quote_field_suffix,omitempty"`
}

SimpleQueryStringQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/fulltext.ts#L837-L905

func NewSimpleQueryStringQuery added in v8.5.0 

func NewSimpleQueryStringQuery() *SimpleQueryStringQuery

NewSimpleQueryStringQuery returns a SimpleQueryStringQuery.

func (*SimpleQueryStringQuery) UnmarshalJSON added in v8.7.0 

func (s *SimpleQueryStringQuery) UnmarshalJSON(data []byte) error

type SimpleValueAggregate 

type SimpleValueAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

SimpleValueAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L238-L239

func NewSimpleValueAggregate added in v8.5.0 

func NewSimpleValueAggregate() *SimpleValueAggregate

NewSimpleValueAggregate returns a SimpleValueAggregate.

func (*SimpleValueAggregate) UnmarshalJSON added in v8.7.1 

func (s *SimpleValueAggregate) UnmarshalJSON(data []byte) error

type SimulateDocumentResult added in v8.16.0 

type SimulateDocumentResult struct {
	Doc              *DocumentSimulation       `json:"doc,omitempty"`
	Error            *ErrorCause               `json:"error,omitempty"`
	ProcessorResults []PipelineProcessorResult `json:"processor_results,omitempty"`
}

SimulateDocumentResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Simulation.ts#L45-L49

func NewSimulateDocumentResult added in v8.16.0 

func NewSimulateDocumentResult() *SimulateDocumentResult

NewSimulateDocumentResult returns a SimulateDocumentResult.

type SimulateIngestDocumentResult added in v8.18.0 

type SimulateIngestDocumentResult struct {
	Doc *IngestDocumentSimulation `json:"doc,omitempty"`
}

SimulateIngestDocumentResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/simulate/ingest/SimulateIngestResponse.ts#L31-L33

func NewSimulateIngestDocumentResult added in v8.18.0 

func NewSimulateIngestDocumentResult() *SimulateIngestDocumentResult

NewSimulateIngestDocumentResult returns a SimulateIngestDocumentResult.

type SimulatedActions 

type SimulatedActions struct {
	Actions []string          `json:"actions"`
	All     *SimulatedActions `json:"all,omitempty"`
	UseAll  bool              `json:"use_all"`
}

SimulatedActions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L90-L94

func NewSimulatedActions added in v8.5.0 

func NewSimulatedActions() *SimulatedActions

NewSimulatedActions returns a SimulatedActions.

func (*SimulatedActions) UnmarshalJSON added in v8.7.1 

func (s *SimulatedActions) UnmarshalJSON(data []byte) error

type SizeField 

type SizeField struct {
	Enabled bool `json:"enabled"`
}

SizeField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L54-L56

func NewSizeField added in v8.5.0 

func NewSizeField() *SizeField

NewSizeField returns a SizeField.

func (*SizeField) UnmarshalJSON added in v8.7.1 

func (s *SizeField) UnmarshalJSON(data []byte) error

type SizeHttpHistogram added in v8.16.0 

type SizeHttpHistogram struct {
	Count   int64  `json:"count"`
	GeBytes *int64 `json:"ge_bytes,omitempty"`
	LtBytes *int64 `json:"lt_bytes,omitempty"`
}

SizeHttpHistogram type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L714-L718

func NewSizeHttpHistogram added in v8.16.0 

func NewSizeHttpHistogram() *SizeHttpHistogram

NewSizeHttpHistogram returns a SizeHttpHistogram.

func (*SizeHttpHistogram) UnmarshalJSON added in v8.16.0 

func (s *SizeHttpHistogram) UnmarshalJSON(data []byte) error

type SlackAction 

type SlackAction struct {
	Account *string      `json:"account,omitempty"`
	Message SlackMessage `json:"message"`
}

SlackAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L91-L94

func NewSlackAction added in v8.5.0 

func NewSlackAction() *SlackAction

NewSlackAction returns a SlackAction.

func (*SlackAction) UnmarshalJSON added in v8.9.0 

func (s *SlackAction) UnmarshalJSON(data []byte) error

type SlackAttachment 

type SlackAttachment struct {
	AuthorIcon *string                `json:"author_icon,omitempty"`
	AuthorLink *string                `json:"author_link,omitempty"`
	AuthorName string                 `json:"author_name"`
	Color      *string                `json:"color,omitempty"`
	Fallback   *string                `json:"fallback,omitempty"`
	Fields     []SlackAttachmentField `json:"fields,omitempty"`
	Footer     *string                `json:"footer,omitempty"`
	FooterIcon *string                `json:"footer_icon,omitempty"`
	ImageUrl   *string                `json:"image_url,omitempty"`
	Pretext    *string                `json:"pretext,omitempty"`
	Text       *string                `json:"text,omitempty"`
	ThumbUrl   *string                `json:"thumb_url,omitempty"`
	Title      string                 `json:"title"`
	TitleLink  *string                `json:"title_link,omitempty"`
	Ts         *int64                 `json:"ts,omitempty"`
}

SlackAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L101-L117

func NewSlackAttachment added in v8.5.0 

func NewSlackAttachment() *SlackAttachment

NewSlackAttachment returns a SlackAttachment.

func (*SlackAttachment) UnmarshalJSON added in v8.7.1 

func (s *SlackAttachment) UnmarshalJSON(data []byte) error

type SlackAttachmentField 

type SlackAttachmentField struct {
	Int   bool   `json:"short"`
	Title string `json:"title"`
	Value string `json:"value"`
}

SlackAttachmentField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L119-L123

func NewSlackAttachmentField added in v8.5.0 

func NewSlackAttachmentField() *SlackAttachmentField

NewSlackAttachmentField returns a SlackAttachmentField.

func (*SlackAttachmentField) UnmarshalJSON added in v8.7.1 

func (s *SlackAttachmentField) UnmarshalJSON(data []byte) error

type SlackDynamicAttachment 

type SlackDynamicAttachment struct {
	AttachmentTemplate SlackAttachment `json:"attachment_template"`
	ListPath           string          `json:"list_path"`
}

SlackDynamicAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L125-L128

func NewSlackDynamicAttachment added in v8.5.0 

func NewSlackDynamicAttachment() *SlackDynamicAttachment

NewSlackDynamicAttachment returns a SlackDynamicAttachment.

func (*SlackDynamicAttachment) UnmarshalJSON added in v8.9.0 

func (s *SlackDynamicAttachment) UnmarshalJSON(data []byte) error

type SlackMessage 

type SlackMessage struct {
	Attachments        []SlackAttachment       `json:"attachments"`
	DynamicAttachments *SlackDynamicAttachment `json:"dynamic_attachments,omitempty"`
	From               string                  `json:"from"`
	Icon               *string                 `json:"icon,omitempty"`
	Text               string                  `json:"text"`
	To                 []string                `json:"to"`
}

SlackMessage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L130-L137

func NewSlackMessage added in v8.5.0 

func NewSlackMessage() *SlackMessage

NewSlackMessage returns a SlackMessage.

func (*SlackMessage) UnmarshalJSON added in v8.9.0 

func (s *SlackMessage) UnmarshalJSON(data []byte) error

type SlackResult 

type SlackResult struct {
	Account *string      `json:"account,omitempty"`
	Message SlackMessage `json:"message"`
}

SlackResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L96-L99

func NewSlackResult added in v8.5.0 

func NewSlackResult() *SlackResult

NewSlackResult returns a SlackResult.

func (*SlackResult) UnmarshalJSON added in v8.9.0 

func (s *SlackResult) UnmarshalJSON(data []byte) error

type SlicedScroll 

type SlicedScroll struct {
	Field *string `json:"field,omitempty"`
	Id    string  `json:"id"`
	Max   int     `json:"max"`
}

SlicedScroll type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/SlicedScroll.ts#L23-L27

func NewSlicedScroll added in v8.5.0 

func NewSlicedScroll() *SlicedScroll

NewSlicedScroll returns a SlicedScroll.

func (*SlicedScroll) UnmarshalJSON added in v8.7.1 

func (s *SlicedScroll) UnmarshalJSON(data []byte) error

type Slices 

type Slices any

Slices holds the union for the following types: 

int
slicescalculation.SlicesCalculation

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L368-L373

type Slm 

type Slm struct {
	Available   bool        `json:"available"`
	Enabled     bool        `json:"enabled"`
	PolicyCount *int        `json:"policy_count,omitempty"`
	PolicyStats *Statistics `json:"policy_stats,omitempty"`
}

Slm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L459-L462

func NewSlm added in v8.5.0 

func NewSlm() *Slm

NewSlm returns a Slm.

func (*Slm) UnmarshalJSON added in v8.7.1 

func (s *Slm) UnmarshalJSON(data []byte) error

type SlmIndicator added in v8.7.1 

type SlmIndicator struct {
	Details   *SlmIndicatorDetails                        `json:"details,omitempty"`
	Diagnosis []Diagnosis                                 `json:"diagnosis,omitempty"`
	Impacts   []Impact                                    `json:"impacts,omitempty"`
	Status    indicatorhealthstatus.IndicatorHealthStatus `json:"status"`
	Symptom   string                                      `json:"symptom"`
}

SlmIndicator type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L174-L178

func NewSlmIndicator added in v8.7.1 

func NewSlmIndicator() *SlmIndicator

NewSlmIndicator returns a SlmIndicator.

func (*SlmIndicator) UnmarshalJSON added in v8.9.0 

func (s *SlmIndicator) UnmarshalJSON(data []byte) error

type SlmIndicatorDetails added in v8.7.1 

type SlmIndicatorDetails struct {
	Policies          int64                                         `json:"policies"`
	SlmStatus         lifecycleoperationmode.LifecycleOperationMode `json:"slm_status"`
	UnhealthyPolicies *SlmIndicatorUnhealthyPolicies                `json:"unhealthy_policies,omitempty"`
}

SlmIndicatorDetails type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L179-L183

func NewSlmIndicatorDetails added in v8.7.1 

func NewSlmIndicatorDetails() *SlmIndicatorDetails

NewSlmIndicatorDetails returns a SlmIndicatorDetails.

func (*SlmIndicatorDetails) UnmarshalJSON added in v8.7.1 

func (s *SlmIndicatorDetails) UnmarshalJSON(data []byte) error

type SlmIndicatorUnhealthyPolicies added in v8.7.1 

type SlmIndicatorUnhealthyPolicies struct {
	Count                       int64            `json:"count"`
	InvocationsSinceLastSuccess map[string]int64 `json:"invocations_since_last_success,omitempty"`
}

SlmIndicatorUnhealthyPolicies type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L185-L188

func NewSlmIndicatorUnhealthyPolicies added in v8.7.1 

func NewSlmIndicatorUnhealthyPolicies() *SlmIndicatorUnhealthyPolicies

NewSlmIndicatorUnhealthyPolicies returns a SlmIndicatorUnhealthyPolicies.

func (*SlmIndicatorUnhealthyPolicies) UnmarshalJSON added in v8.7.1 

func (s *SlmIndicatorUnhealthyPolicies) UnmarshalJSON(data []byte) error

type SlowlogSettings 

type SlowlogSettings struct {
	Level     *string           `json:"level,omitempty"`
	Reformat  *bool             `json:"reformat,omitempty"`
	Source    *int              `json:"source,omitempty"`
	Threshold *SlowlogTresholds `json:"threshold,omitempty"`
}

SlowlogSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L515-L520

func NewSlowlogSettings added in v8.5.0 

func NewSlowlogSettings() *SlowlogSettings

NewSlowlogSettings returns a SlowlogSettings.

func (*SlowlogSettings) UnmarshalJSON added in v8.7.1 

func (s *SlowlogSettings) UnmarshalJSON(data []byte) error

type SlowlogTresholdLevels 

type SlowlogTresholdLevels struct {
	Debug Duration `json:"debug,omitempty"`
	Info  Duration `json:"info,omitempty"`
	Trace Duration `json:"trace,omitempty"`
	Warn  Duration `json:"warn,omitempty"`
}

SlowlogTresholdLevels type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L527-L532

func NewSlowlogTresholdLevels added in v8.5.0 

func NewSlowlogTresholdLevels() *SlowlogTresholdLevels

NewSlowlogTresholdLevels returns a SlowlogTresholdLevels.

func (*SlowlogTresholdLevels) UnmarshalJSON added in v8.7.1 

func (s *SlowlogTresholdLevels) UnmarshalJSON(data []byte) error

type SlowlogTresholds 

type SlowlogTresholds struct {
	Fetch *SlowlogTresholdLevels `json:"fetch,omitempty"`
	Query *SlowlogTresholdLevels `json:"query,omitempty"`
}

SlowlogTresholds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L522-L525

func NewSlowlogTresholds added in v8.5.0 

func NewSlowlogTresholds() *SlowlogTresholds

NewSlowlogTresholds returns a SlowlogTresholds.

type SmoothingModelContainer 

type SmoothingModelContainer struct {
	// Laplace A smoothing model that uses an additive smoothing where a constant (typically
	// `1.0` or smaller) is added to all counts to balance weights.
	Laplace *LaplaceSmoothingModel `json:"laplace,omitempty"`
	// LinearInterpolation A smoothing model that takes the weighted mean of the unigrams, bigrams, and
	// trigrams based on user supplied weights (lambdas).
	LinearInterpolation *LinearInterpolationSmoothingModel `json:"linear_interpolation,omitempty"`
	// StupidBackoff A simple backoff model that backs off to lower order n-gram models if the
	// higher order count is `0` and discounts the lower order n-gram model by a
	// constant factor.
	StupidBackoff *StupidBackoffSmoothingModel `json:"stupid_backoff,omitempty"`
}

SmoothingModelContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L445-L461

func NewSmoothingModelContainer added in v8.5.0 

func NewSmoothingModelContainer() *SmoothingModelContainer

NewSmoothingModelContainer returns a SmoothingModelContainer.

type SnapshotIndexStats 

type SnapshotIndexStats struct {
	Shards      map[string]SnapshotShardsStatus `json:"shards"`
	ShardsStats SnapshotShardsStats             `json:"shards_stats"`
	Stats       SnapshotStats                   `json:"stats"`
}

SnapshotIndexStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotIndexStats.ts#L25-L29

func NewSnapshotIndexStats added in v8.5.0 

func NewSnapshotIndexStats() *SnapshotIndexStats

NewSnapshotIndexStats returns a SnapshotIndexStats.

type SnapshotInfo 

type SnapshotInfo struct {
	DataStreams        []string                `json:"data_streams"`
	Duration           Duration                `json:"duration,omitempty"`
	DurationInMillis   *int64                  `json:"duration_in_millis,omitempty"`
	EndTime            DateTime                `json:"end_time,omitempty"`
	EndTimeInMillis    *int64                  `json:"end_time_in_millis,omitempty"`
	Failures           []SnapshotShardFailure  `json:"failures,omitempty"`
	FeatureStates      []InfoFeatureState      `json:"feature_states,omitempty"`
	IncludeGlobalState *bool                   `json:"include_global_state,omitempty"`
	IndexDetails       map[string]IndexDetails `json:"index_details,omitempty"`
	Indices            []string                `json:"indices,omitempty"`
	Metadata           Metadata                `json:"metadata,omitempty"`
	Reason             *string                 `json:"reason,omitempty"`
	Repository         *string                 `json:"repository,omitempty"`
	Shards             *ShardStatistics        `json:"shards,omitempty"`
	Snapshot           string                  `json:"snapshot"`
	StartTime          DateTime                `json:"start_time,omitempty"`
	StartTimeInMillis  *int64                  `json:"start_time_in_millis,omitempty"`
	State              *string                 `json:"state,omitempty"`
	Uuid               string                  `json:"uuid"`
	Version            *string                 `json:"version,omitempty"`
	VersionId          *int64                  `json:"version_id,omitempty"`
}

SnapshotInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotInfo.ts#L41-L71

func NewSnapshotInfo added in v8.5.0 

func NewSnapshotInfo() *SnapshotInfo

NewSnapshotInfo returns a SnapshotInfo.

func (*SnapshotInfo) UnmarshalJSON added in v8.7.1 

func (s *SnapshotInfo) UnmarshalJSON(data []byte) error

type SnapshotLifecycle 

type SnapshotLifecycle struct {
	InProgress  *InProgress `json:"in_progress,omitempty"`
	LastFailure *Invocation `json:"last_failure,omitempty"`
	LastSuccess *Invocation `json:"last_success,omitempty"`
	// ModifiedDate The last time the policy was modified.
	ModifiedDate       DateTime `json:"modified_date,omitempty"`
	ModifiedDateMillis int64    `json:"modified_date_millis"`
	// NextExecution The next time the policy will run.
	NextExecution       DateTime   `json:"next_execution,omitempty"`
	NextExecutionMillis int64      `json:"next_execution_millis"`
	Policy              SLMPolicy  `json:"policy"`
	Stats               Statistics `json:"stats"`
	// Version The version of the snapshot policy.
	// Only the latest version is stored and incremented when the policy is updated.
	Version int64 `json:"version"`
}

SnapshotLifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L38-L59

func NewSnapshotLifecycle added in v8.5.0 

func NewSnapshotLifecycle() *SnapshotLifecycle

NewSnapshotLifecycle returns a SnapshotLifecycle.

func (*SnapshotLifecycle) UnmarshalJSON added in v8.7.1 

func (s *SnapshotLifecycle) UnmarshalJSON(data []byte) error

type SnapshotNodeInfo added in v8.18.0 

type SnapshotNodeInfo struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

SnapshotNodeInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L110-L113

func NewSnapshotNodeInfo added in v8.18.0 

func NewSnapshotNodeInfo() *SnapshotNodeInfo

NewSnapshotNodeInfo returns a SnapshotNodeInfo.

func (*SnapshotNodeInfo) UnmarshalJSON added in v8.18.0 

func (s *SnapshotNodeInfo) UnmarshalJSON(data []byte) error

type SnapshotPolicyStats added in v8.18.1 

type SnapshotPolicyStats struct {
	Policy                   string `json:"policy"`
	SnapshotDeletionFailures int64  `json:"snapshot_deletion_failures"`
	SnapshotsDeleted         int64  `json:"snapshots_deleted"`
	SnapshotsFailed          int64  `json:"snapshots_failed"`
	SnapshotsTaken           int64  `json:"snapshots_taken"`
}

SnapshotPolicyStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L153-L159

func NewSnapshotPolicyStats added in v8.18.1 

func NewSnapshotPolicyStats() *SnapshotPolicyStats

NewSnapshotPolicyStats returns a SnapshotPolicyStats.

func (*SnapshotPolicyStats) UnmarshalJSON added in v8.18.1 

func (s *SnapshotPolicyStats) UnmarshalJSON(data []byte) error

type SnapshotResponseItem 

type SnapshotResponseItem struct {
	Error      *ErrorCause    `json:"error,omitempty"`
	Repository string         `json:"repository"`
	Snapshots  []SnapshotInfo `json:"snapshots,omitempty"`
}

SnapshotResponseItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/get/SnapshotGetResponse.ts#L44-L48

func NewSnapshotResponseItem added in v8.5.0 

func NewSnapshotResponseItem() *SnapshotResponseItem

NewSnapshotResponseItem returns a SnapshotResponseItem.

func (*SnapshotResponseItem) UnmarshalJSON added in v8.7.1 

func (s *SnapshotResponseItem) UnmarshalJSON(data []byte) error

type SnapshotRestore 

type SnapshotRestore struct {
	Indices  []string        `json:"indices"`
	Shards   ShardStatistics `json:"shards"`
	Snapshot string          `json:"snapshot"`
}

SnapshotRestore type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/restore/SnapshotRestoreResponse.ts#L30-L34

func NewSnapshotRestore added in v8.5.0 

func NewSnapshotRestore() *SnapshotRestore

NewSnapshotRestore returns a SnapshotRestore.

func (*SnapshotRestore) UnmarshalJSON added in v8.7.1 

func (s *SnapshotRestore) UnmarshalJSON(data []byte) error

type SnapshotShardFailure 

type SnapshotShardFailure struct {
	Index     string  `json:"index"`
	IndexUuid string  `json:"index_uuid"`
	NodeId    *string `json:"node_id,omitempty"`
	Reason    string  `json:"reason"`
	ShardId   int     `json:"shard_id"`
	Status    string  `json:"status"`
}

SnapshotShardFailure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotShardFailure.ts#L23-L30

func NewSnapshotShardFailure added in v8.5.0 

func NewSnapshotShardFailure() *SnapshotShardFailure

NewSnapshotShardFailure returns a SnapshotShardFailure.

func (*SnapshotShardFailure) UnmarshalJSON added in v8.7.1 

func (s *SnapshotShardFailure) UnmarshalJSON(data []byte) error

type SnapshotShardsStats added in v8.5.0 

type SnapshotShardsStats struct {
	Done         int64 `json:"done"`
	Failed       int64 `json:"failed"`
	Finalizing   int64 `json:"finalizing"`
	Initializing int64 `json:"initializing"`
	Started      int64 `json:"started"`
	Total        int64 `json:"total"`
}

SnapshotShardsStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotShardsStats.ts#L22-L29

func NewSnapshotShardsStats added in v8.5.0 

func NewSnapshotShardsStats() *SnapshotShardsStats

NewSnapshotShardsStats returns a SnapshotShardsStats.

func (*SnapshotShardsStats) UnmarshalJSON added in v8.7.1 

func (s *SnapshotShardsStats) UnmarshalJSON(data []byte) error

type SnapshotShardsStatus 

type SnapshotShardsStatus struct {
	Stage shardsstatsstage.ShardsStatsStage `json:"stage"`
	Stats ShardsStatsSummary                `json:"stats"`
}

SnapshotShardsStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotShardsStatus.ts#L24-L27

func NewSnapshotShardsStatus added in v8.5.0 

func NewSnapshotShardsStatus() *SnapshotShardsStatus

NewSnapshotShardsStatus returns a SnapshotShardsStatus.

type SnapshotStats 

type SnapshotStats struct {
	Incremental       FileCountSnapshotStats `json:"incremental"`
	StartTimeInMillis int64                  `json:"start_time_in_millis"`
	Time              Duration               `json:"time,omitempty"`
	TimeInMillis      int64                  `json:"time_in_millis"`
	Total             FileCountSnapshotStats `json:"total"`
}

SnapshotStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotStats.ts#L23-L29

func NewSnapshotStats added in v8.5.0 

func NewSnapshotStats() *SnapshotStats

NewSnapshotStats returns a SnapshotStats.

func (*SnapshotStats) UnmarshalJSON added in v8.7.1 

func (s *SnapshotStats) UnmarshalJSON(data []byte) error

type SnapshotsRecord 

type SnapshotsRecord struct {
	// Duration The time it took the snapshot process to complete, in time units.
	Duration Duration `json:"duration,omitempty"`
	// EndEpoch The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot
	// process ended.
	EndEpoch StringifiedEpochTimeUnitSeconds `json:"end_epoch,omitempty"`
	// EndTime The time (HH:MM:SS) at which the snapshot process ended.
	EndTime *string `json:"end_time,omitempty"`
	// FailedShards The number of failed shards in the snapshot.
	FailedShards *string `json:"failed_shards,omitempty"`
	// Id The unique identifier for the snapshot.
	Id *string `json:"id,omitempty"`
	// Indices The number of indices in the snapshot.
	Indices *string `json:"indices,omitempty"`
	// Reason The reason for any snapshot failures.
	Reason *string `json:"reason,omitempty"`
	// Repository The repository name.
	Repository *string `json:"repository,omitempty"`
	// StartEpoch The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot
	// process started.
	StartEpoch StringifiedEpochTimeUnitSeconds `json:"start_epoch,omitempty"`
	// StartTime The time (HH:MM:SS) at which the snapshot process started.
	StartTime ScheduleTimeOfDay `json:"start_time,omitempty"`
	// Status The state of the snapshot process.
	// Returned values include:
	// `FAILED`: The snapshot process failed.
	// `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster
	// version.
	// `IN_PROGRESS`: The snapshot process started but has not completed.
	// `PARTIAL`: The snapshot process completed with a partial success.
	// `SUCCESS`: The snapshot process completed with a full success.
	Status *string `json:"status,omitempty"`
	// SuccessfulShards The number of successful shards in the snapshot.
	SuccessfulShards *string `json:"successful_shards,omitempty"`
	// TotalShards The total number of shards in the snapshot.
	TotalShards *string `json:"total_shards,omitempty"`
}

SnapshotsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/snapshots/types.ts#L24-L96

func NewSnapshotsRecord added in v8.5.0 

func NewSnapshotsRecord() *SnapshotsRecord

NewSnapshotsRecord returns a SnapshotsRecord.

func (*SnapshotsRecord) UnmarshalJSON added in v8.7.0 

func (s *SnapshotsRecord) UnmarshalJSON(data []byte) error

type SnowballAnalyzer 

type SnowballAnalyzer struct {
	Language  snowballlanguage.SnowballLanguage `json:"language"`
	Stopwords StopWords                         `json:"stopwords,omitempty"`
	Type      string                            `json:"type,omitempty"`
	Version   *string                           `json:"version,omitempty"`
}

SnowballAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L325-L330

func NewSnowballAnalyzer added in v8.5.0 

func NewSnowballAnalyzer() *SnowballAnalyzer

NewSnowballAnalyzer returns a SnowballAnalyzer.

func (SnowballAnalyzer) MarshalJSON added in v8.9.0 

func (s SnowballAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SnowballAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *SnowballAnalyzer) UnmarshalJSON(data []byte) error

type SnowballTokenFilter 

type SnowballTokenFilter struct {
	// Language Controls the language used by the stemmer.
	Language *snowballlanguage.SnowballLanguage `json:"language,omitempty"`
	Type     string                             `json:"type,omitempty"`
	Version  *string                            `json:"version,omitempty"`
}

SnowballTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L410-L414

func NewSnowballTokenFilter added in v8.5.0 

func NewSnowballTokenFilter() *SnowballTokenFilter

NewSnowballTokenFilter returns a SnowballTokenFilter.

func (SnowballTokenFilter) MarshalJSON added in v8.9.0 

func (s SnowballTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SnowballTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *SnowballTokenFilter) UnmarshalJSON(data []byte) error

type SoftDeletes 

type SoftDeletes struct {
	// Enabled Indicates whether soft deletes are enabled on the index.
	Enabled *bool `json:"enabled,omitempty"`
	// RetentionLease The maximum period to retain a shard history retention lease before it is
	// considered expired.
	// Shard history retention leases ensure that soft deletes are retained during
	// merges on the Lucene
	// index. If a soft delete is merged away before it can be replicated to a
	// follower the following
	// process will fail due to incomplete history on the leader.
	RetentionLease *RetentionLease `json:"retention_lease,omitempty"`
}

SoftDeletes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L51-L64

func NewSoftDeletes added in v8.5.0 

func NewSoftDeletes() *SoftDeletes

NewSoftDeletes returns a SoftDeletes.

func (*SoftDeletes) UnmarshalJSON added in v8.7.1 

func (s *SoftDeletes) UnmarshalJSON(data []byte) error

type SoraniAnalyzer added in v8.16.0 

type SoraniAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

SoraniAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L269-L274

func NewSoraniAnalyzer added in v8.16.0 

func NewSoraniAnalyzer() *SoraniAnalyzer

NewSoraniAnalyzer returns a SoraniAnalyzer.

func (SoraniAnalyzer) MarshalJSON added in v8.16.0 

func (s SoraniAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SoraniAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *SoraniAnalyzer) UnmarshalJSON(data []byte) error

type SoraniNormalizationTokenFilter added in v8.18.1 

type SoraniNormalizationTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

SoraniNormalizationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L534-L536

func NewSoraniNormalizationTokenFilter added in v8.18.1 

func NewSoraniNormalizationTokenFilter() *SoraniNormalizationTokenFilter

NewSoraniNormalizationTokenFilter returns a SoraniNormalizationTokenFilter.

func (SoraniNormalizationTokenFilter) MarshalJSON added in v8.18.1 

func (s SoraniNormalizationTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SoraniNormalizationTokenFilter) UnmarshalJSON added in v8.18.1 

func (s *SoraniNormalizationTokenFilter) UnmarshalJSON(data []byte) error

type Sort 

type Sort []SortCombinations

Sort type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L104-L104

type SortCombinations 

type SortCombinations any

SortCombinations holds the union for the following types: 

string
SortOptions

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L98-L102

type SortOptions 

type SortOptions struct {
	Doc_         *ScoreSort           `json:"_doc,omitempty"`
	GeoDistance_ *GeoDistanceSort     `json:"_geo_distance,omitempty"`
	Score_       *ScoreSort           `json:"_score,omitempty"`
	Script_      *ScriptSort          `json:"_script,omitempty"`
	SortOptions  map[string]FieldSort `json:"-"`
}

SortOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/sort.ts#L86-L96

func NewSortOptions added in v8.5.0 

func NewSortOptions() *SortOptions

NewSortOptions returns a SortOptions.

func (SortOptions) MarshalJSON 

func (s SortOptions) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type SortProcessor 

type SortProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to be sorted.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Order The sort order to use.
	// Accepts `"asc"` or `"desc"`.
	Order *sortorder.SortOrder `json:"order,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the sorted value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

SortProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1496-L1512

func NewSortProcessor added in v8.5.0 

func NewSortProcessor() *SortProcessor

NewSortProcessor returns a SortProcessor.

func (*SortProcessor) UnmarshalJSON added in v8.7.1 

func (s *SortProcessor) UnmarshalJSON(data []byte) error

type SourceConfig 

type SourceConfig any

SourceConfig holds the union for the following types: 

bool
SourceFilter

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/SourceFilter.ts#L33-L37

type SourceConfigParam 

type SourceConfigParam any

SourceConfigParam holds the union for the following types: 

bool
[]string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/SourceFilter.ts#L39-L45

type SourceField 

type SourceField struct {
	Compress          *bool                            `json:"compress,omitempty"`
	CompressThreshold *string                          `json:"compress_threshold,omitempty"`
	Enabled           *bool                            `json:"enabled,omitempty"`
	Excludes          []string                         `json:"excludes,omitempty"`
	Includes          []string                         `json:"includes,omitempty"`
	Mode              *sourcefieldmode.SourceFieldMode `json:"mode,omitempty"`
}

SourceField type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/meta-fields.ts#L58-L65

func NewSourceField added in v8.5.0 

func NewSourceField() *SourceField

NewSourceField returns a SourceField.

func (*SourceField) UnmarshalJSON added in v8.7.1 

func (s *SourceField) UnmarshalJSON(data []byte) error

type SourceFilter 

type SourceFilter struct {
	Excludes []string `json:"excludes,omitempty"`
	Includes []string `json:"includes,omitempty"`
}

SourceFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/SourceFilter.ts#L23-L31

func NewSourceFilter added in v8.5.0 

func NewSourceFilter() *SourceFilter

NewSourceFilter returns a SourceFilter.

func (*SourceFilter) UnmarshalJSON added in v8.7.1 

func (s *SourceFilter) UnmarshalJSON(data []byte) error

type SourceIndex added in v8.18.0 

type SourceIndex struct {
	Index string `json:"index"`
}

SourceIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/migrate_reindex/MigrateReindexRequest.ts#L50-L52

func NewSourceIndex added in v8.18.0 

func NewSourceIndex() *SourceIndex

NewSourceIndex returns a SourceIndex.

func (*SourceIndex) UnmarshalJSON added in v8.18.0 

func (s *SourceIndex) UnmarshalJSON(data []byte) error

type SourceOnlyRepository added in v8.13.0 

type SourceOnlyRepository struct {
	Settings SourceOnlyRepositorySettings `json:"settings"`
	Type     string                       `json:"type,omitempty"`
	Uuid     *string                      `json:"uuid,omitempty"`
}

SourceOnlyRepository type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L65-L68

func NewSourceOnlyRepository added in v8.13.0 

func NewSourceOnlyRepository() *SourceOnlyRepository

NewSourceOnlyRepository returns a SourceOnlyRepository.

func (SourceOnlyRepository) MarshalJSON added in v8.13.0 

func (s SourceOnlyRepository) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SourceOnlyRepository) UnmarshalJSON added in v8.13.0 

func (s *SourceOnlyRepository) UnmarshalJSON(data []byte) error

type SourceOnlyRepositorySettings added in v8.13.0 

type SourceOnlyRepositorySettings struct {
	ChunkSize              ByteSize `json:"chunk_size,omitempty"`
	Compress               *bool    `json:"compress,omitempty"`
	DelegateType           *string  `json:"delegate_type,omitempty"`
	MaxNumberOfSnapshots   *int     `json:"max_number_of_snapshots,omitempty"`
	MaxRestoreBytesPerSec  ByteSize `json:"max_restore_bytes_per_sec,omitempty"`
	MaxSnapshotBytesPerSec ByteSize `json:"max_snapshot_bytes_per_sec,omitempty"`
	ReadOnly               *bool    `json:"read_only,omitempty"`
}

SourceOnlyRepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotRepository.ts#L117-L124

func NewSourceOnlyRepositorySettings added in v8.13.0 

func NewSourceOnlyRepositorySettings() *SourceOnlyRepositorySettings

NewSourceOnlyRepositorySettings returns a SourceOnlyRepositorySettings.

func (*SourceOnlyRepositorySettings) UnmarshalJSON added in v8.13.0 

func (s *SourceOnlyRepositorySettings) UnmarshalJSON(data []byte) error

type SpanContainingQuery 

type SpanContainingQuery struct {
	// Big Can be any span query.
	// Matching spans from `big` that contain matches from `little` are returned.
	Big *SpanQuery `json:"big,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Little Can be any span query.
	// Matching spans from `big` that contain matches from `little` are returned.
	Little     *SpanQuery `json:"little,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanContainingQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L25-L39

func NewSpanContainingQuery added in v8.5.0 

func NewSpanContainingQuery() *SpanContainingQuery

NewSpanContainingQuery returns a SpanContainingQuery.

func (*SpanContainingQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanContainingQuery) UnmarshalJSON(data []byte) error

type SpanFieldMaskingQuery 

type SpanFieldMaskingQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32   `json:"boost,omitempty"`
	Field      string     `json:"field"`
	Query      *SpanQuery `json:"query,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanFieldMaskingQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L41-L47

func NewSpanFieldMaskingQuery added in v8.5.0 

func NewSpanFieldMaskingQuery() *SpanFieldMaskingQuery

NewSpanFieldMaskingQuery returns a SpanFieldMaskingQuery.

func (*SpanFieldMaskingQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanFieldMaskingQuery) UnmarshalJSON(data []byte) error

type SpanFirstQuery 

type SpanFirstQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// End Controls the maximum end position permitted in a match.
	End int `json:"end"`
	// Match Can be any other span type query.
	Match      *SpanQuery `json:"match,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanFirstQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L49-L61

func NewSpanFirstQuery added in v8.5.0 

func NewSpanFirstQuery() *SpanFirstQuery

NewSpanFirstQuery returns a SpanFirstQuery.

func (*SpanFirstQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanFirstQuery) UnmarshalJSON(data []byte) error

type SpanGapQuery 

type SpanGapQuery map[string]int

SpanGapQuery type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L63-L65

type SpanMultiTermQuery 

type SpanMultiTermQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Match Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`,
	// or `regexp` query).
	Match      *Query  `json:"match,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
}

SpanMultiTermQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L67-L75

func NewSpanMultiTermQuery added in v8.5.0 

func NewSpanMultiTermQuery() *SpanMultiTermQuery

NewSpanMultiTermQuery returns a SpanMultiTermQuery.

func (*SpanMultiTermQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanMultiTermQuery) UnmarshalJSON(data []byte) error

type SpanNearQuery 

type SpanNearQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Clauses Array of one or more other span type queries.
	Clauses []SpanQuery `json:"clauses"`
	// InOrder Controls whether matches are required to be in-order.
	InOrder    *bool   `json:"in_order,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Slop Controls the maximum number of intervening unmatched positions permitted.
	Slop *int `json:"slop,omitempty"`
}

SpanNearQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L77-L93

func NewSpanNearQuery added in v8.5.0 

func NewSpanNearQuery() *SpanNearQuery

NewSpanNearQuery returns a SpanNearQuery.

func (*SpanNearQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanNearQuery) UnmarshalJSON(data []byte) error

type SpanNotQuery 

type SpanNotQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Dist The number of tokens from within the include span that can’t have overlap
	// with the exclude span.
	// Equivalent to setting both `pre` and `post`.
	Dist *int `json:"dist,omitempty"`
	// Exclude Span query whose matches must not overlap those returned.
	Exclude *SpanQuery `json:"exclude,omitempty"`
	// Include Span query whose matches are filtered.
	Include *SpanQuery `json:"include,omitempty"`
	// Post The number of tokens after the include span that can’t have overlap with the
	// exclude span.
	Post *int `json:"post,omitempty"`
	// Pre The number of tokens before the include span that can’t have overlap with the
	// exclude span.
	Pre        *int    `json:"pre,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
}

SpanNotQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L95-L122

func NewSpanNotQuery added in v8.5.0 

func NewSpanNotQuery() *SpanNotQuery

NewSpanNotQuery returns a SpanNotQuery.

func (*SpanNotQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanNotQuery) UnmarshalJSON(data []byte) error

type SpanOrQuery 

type SpanOrQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Clauses Array of one or more other span type queries.
	Clauses    []SpanQuery `json:"clauses"`
	QueryName_ *string     `json:"_name,omitempty"`
}

SpanOrQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L124-L132

func NewSpanOrQuery added in v8.5.0 

func NewSpanOrQuery() *SpanOrQuery

NewSpanOrQuery returns a SpanOrQuery.

func (*SpanOrQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanOrQuery) UnmarshalJSON(data []byte) error

type SpanQuery 

type SpanQuery struct {
	// SpanContaining Accepts a list of span queries, but only returns those spans which also match
	// a second span query.
	SpanContaining *SpanContainingQuery `json:"span_containing,omitempty"`
	// SpanFieldMasking Allows queries like `span_near` or `span_or` across different fields.
	SpanFieldMasking *SpanFieldMaskingQuery `json:"span_field_masking,omitempty"`
	// SpanFirst Accepts another span query whose matches must appear within the first N
	// positions of the field.
	SpanFirst *SpanFirstQuery `json:"span_first,omitempty"`
	SpanGap   SpanGapQuery    `json:"span_gap,omitempty"`
	// SpanMulti Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.
	SpanMulti *SpanMultiTermQuery `json:"span_multi,omitempty"`
	// SpanNear Accepts multiple span queries whose matches must be within the specified
	// distance of each other, and possibly in the same order.
	SpanNear *SpanNearQuery `json:"span_near,omitempty"`
	// SpanNot Wraps another span query, and excludes any documents which match that query.
	SpanNot *SpanNotQuery `json:"span_not,omitempty"`
	// SpanOr Combines multiple span queries and returns documents which match any of the
	// specified queries.
	SpanOr *SpanOrQuery `json:"span_or,omitempty"`
	// SpanTerm The equivalent of the `term` query but for use with other span queries.
	SpanTerm map[string]SpanTermQuery `json:"span_term,omitempty"`
	// SpanWithin The result from a single span query is returned as long is its span falls
	// within the spans returned by a list of other span queries.
	SpanWithin *SpanWithinQuery `json:"span_within,omitempty"`
}

SpanQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L158-L200

func NewSpanQuery added in v8.5.0 

func NewSpanQuery() *SpanQuery

NewSpanQuery returns a SpanQuery.

func (*SpanQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanQuery) UnmarshalJSON(data []byte) error

type SpanTermQuery 

type SpanTermQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Value      string   `json:"value"`
}

SpanTermQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L134-L140

func NewSpanTermQuery added in v8.5.0 

func NewSpanTermQuery() *SpanTermQuery

NewSpanTermQuery returns a SpanTermQuery.

func (*SpanTermQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanTermQuery) UnmarshalJSON(data []byte) error

type SpanWithinQuery 

type SpanWithinQuery struct {
	// Big Can be any span query.
	// Matching spans from `little` that are enclosed within `big` are returned.
	Big *SpanQuery `json:"big,omitempty"`
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Little Can be any span query.
	// Matching spans from `little` that are enclosed within `big` are returned.
	Little     *SpanQuery `json:"little,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanWithinQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/span.ts#L142-L156

func NewSpanWithinQuery added in v8.5.0 

func NewSpanWithinQuery() *SpanWithinQuery

NewSpanWithinQuery returns a SpanWithinQuery.

func (*SpanWithinQuery) UnmarshalJSON added in v8.7.1 

func (s *SpanWithinQuery) UnmarshalJSON(data []byte) error

type SpanishAnalyzer added in v8.16.0 

type SpanishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

SpanishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L276-L281

func NewSpanishAnalyzer added in v8.16.0 

func NewSpanishAnalyzer() *SpanishAnalyzer

NewSpanishAnalyzer returns a SpanishAnalyzer.

func (SpanishAnalyzer) MarshalJSON added in v8.16.0 

func (s SpanishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SpanishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *SpanishAnalyzer) UnmarshalJSON(data []byte) error

type SparseEmbeddingInferenceResult added in v8.18.1 

type SparseEmbeddingInferenceResult struct {
	SparseEmbedding []SparseEmbeddingResult `json:"sparse_embedding"`
}

SparseEmbeddingInferenceResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L40-L45

func NewSparseEmbeddingInferenceResult added in v8.18.1 

func NewSparseEmbeddingInferenceResult() *SparseEmbeddingInferenceResult

NewSparseEmbeddingInferenceResult returns a SparseEmbeddingInferenceResult.

type SparseEmbeddingResult added in v8.12.0 

type SparseEmbeddingResult struct {
	Embedding SparseVector `json:"embedding"`
}

SparseEmbeddingResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L36-L38

func NewSparseEmbeddingResult added in v8.12.0 

func NewSparseEmbeddingResult() *SparseEmbeddingResult

NewSparseEmbeddingResult returns a SparseEmbeddingResult.

func (*SparseEmbeddingResult) UnmarshalJSON added in v8.12.0 

func (s *SparseEmbeddingResult) UnmarshalJSON(data []byte) error

type SparseVector added in v8.12.0 

type SparseVector map[string]float32

SparseVector type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L24-L28

type SparseVectorProperty added in v8.11.1 

type SparseVectorProperty struct {
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

SparseVectorProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L215-L217

func NewSparseVectorProperty added in v8.11.1 

func NewSparseVectorProperty() *SparseVectorProperty

NewSparseVectorProperty returns a SparseVectorProperty.

func (SparseVectorProperty) MarshalJSON added in v8.11.1 

func (s SparseVectorProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SparseVectorProperty) UnmarshalJSON added in v8.11.1 

func (s *SparseVectorProperty) UnmarshalJSON(data []byte) error

type SparseVectorQuery added in v8.15.0 

type SparseVectorQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field The name of the field that contains the token-weight pairs to be searched
	// against.
	// This field must be a mapped sparse_vector field.
	Field string `json:"field"`
	// InferenceId The inference ID to use to convert the query text into token-weight pairs.
	// It must be the same inference ID that was used to create the tokens from the
	// input text.
	// Only one of inference_id and query_vector is allowed.
	// If inference_id is specified, query must also be specified.
	// Only one of inference_id or query_vector may be supplied in a request.
	InferenceId *string `json:"inference_id,omitempty"`
	// Prune Whether to perform pruning, omitting the non-significant tokens from the
	// query to improve query performance.
	// If prune is true but the pruning_config is not specified, pruning will occur
	// but default values will be used.
	// Default: false
	Prune *bool `json:"prune,omitempty"`
	// PruningConfig Optional pruning configuration.
	// If enabled, this will omit non-significant tokens from the query in order to
	// improve query performance.
	// This is only used if prune is set to true.
	// If prune is set to true but pruning_config is not specified, default values
	// will be used.
	PruningConfig *TokenPruningConfig `json:"pruning_config,omitempty"`
	// Query The query text you want to use for search.
	// If inference_id is specified, query must also be specified.
	Query      *string `json:"query,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// QueryVector Dictionary of precomputed sparse vectors and their associated weights.
	// Only one of inference_id or query_vector may be supplied in a request.
	QueryVector map[string]float32 `json:"query_vector,omitempty"`
}

SparseVectorQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/SparseVectorQuery.ts#L26-L80

func NewSparseVectorQuery added in v8.15.0 

func NewSparseVectorQuery() *SparseVectorQuery

NewSparseVectorQuery returns a SparseVectorQuery.

func (*SparseVectorQuery) UnmarshalJSON added in v8.15.0 

func (s *SparseVectorQuery) UnmarshalJSON(data []byte) error

type SpecifiedDocument added in v8.18.1 

type SpecifiedDocument struct {
	Id    string  `json:"id"`
	Index *string `json:"index,omitempty"`
}

SpecifiedDocument type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L93-L96

func NewSpecifiedDocument added in v8.18.1 

func NewSpecifiedDocument() *SpecifiedDocument

NewSpecifiedDocument returns a SpecifiedDocument.

func (*SpecifiedDocument) UnmarshalJSON added in v8.18.1 

func (s *SpecifiedDocument) UnmarshalJSON(data []byte) error

type SplitProcessor 

type SplitProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to split.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// PreserveTrailing Preserves empty trailing fields, if any.
	PreserveTrailing *bool `json:"preserve_trailing,omitempty"`
	// Separator A regex which matches the separator, for example, `,` or `\s+`.
	Separator string `json:"separator"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the split value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

SplitProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1514-L1539

func NewSplitProcessor added in v8.5.0 

func NewSplitProcessor() *SplitProcessor

NewSplitProcessor returns a SplitProcessor.

func (*SplitProcessor) UnmarshalJSON added in v8.7.1 

func (s *SplitProcessor) UnmarshalJSON(data []byte) error

type Sql 

type Sql struct {
	Available bool                  `json:"available"`
	Enabled   bool                  `json:"enabled"`
	Features  map[string]int        `json:"features"`
	Queries   map[string]XpackQuery `json:"queries"`
}

Sql type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L396-L399

func NewSql added in v8.5.0 

func NewSql() *Sql

NewSql returns a Sql.

func (*Sql) UnmarshalJSON added in v8.7.1 

func (s *Sql) UnmarshalJSON(data []byte) error

type Ssl 

type Ssl struct {
	Http      FeatureToggle `json:"http"`
	Transport FeatureToggle `json:"transport"`
}

Ssl type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L401-L404

func NewSsl added in v8.5.0 

func NewSsl() *Ssl

NewSsl returns a Ssl.

type StagnatingBackingIndices added in v8.16.0 

type StagnatingBackingIndices struct {
	FirstOccurrenceTimestamp int64  `json:"first_occurrence_timestamp"`
	IndexName                string `json:"index_name"`
	RetryCount               int    `json:"retry_count"`
}

StagnatingBackingIndices type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/health_report/types.ts#L157-L161

func NewStagnatingBackingIndices added in v8.16.0 

func NewStagnatingBackingIndices() *StagnatingBackingIndices

NewStagnatingBackingIndices returns a StagnatingBackingIndices.

func (*StagnatingBackingIndices) UnmarshalJSON added in v8.16.0 

func (s *StagnatingBackingIndices) UnmarshalJSON(data []byte) error

type StandardAnalyzer 

type StandardAnalyzer struct {
	MaxTokenLength *int      `json:"max_token_length,omitempty"`
	Stopwords      StopWords `json:"stopwords,omitempty"`
	Type           string    `json:"type,omitempty"`
}

StandardAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L332-L336

func NewStandardAnalyzer added in v8.5.0 

func NewStandardAnalyzer() *StandardAnalyzer

NewStandardAnalyzer returns a StandardAnalyzer.

func (StandardAnalyzer) MarshalJSON added in v8.9.0 

func (s StandardAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StandardAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *StandardAnalyzer) UnmarshalJSON(data []byte) error

type StandardDeviationBounds 

type StandardDeviationBounds struct {
	Lower           *Float64 `json:"lower,omitempty"`
	LowerPopulation *Float64 `json:"lower_population,omitempty"`
	LowerSampling   *Float64 `json:"lower_sampling,omitempty"`
	Upper           *Float64 `json:"upper,omitempty"`
	UpperPopulation *Float64 `json:"upper_population,omitempty"`
	UpperSampling   *Float64 `json:"upper_sampling,omitempty"`
}

StandardDeviationBounds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L281-L288

func NewStandardDeviationBounds added in v8.5.0 

func NewStandardDeviationBounds() *StandardDeviationBounds

NewStandardDeviationBounds returns a StandardDeviationBounds.

func (*StandardDeviationBounds) UnmarshalJSON added in v8.7.1 

func (s *StandardDeviationBounds) UnmarshalJSON(data []byte) error

type StandardDeviationBoundsAsString 

type StandardDeviationBoundsAsString struct {
	Lower           string `json:"lower"`
	LowerPopulation string `json:"lower_population"`
	LowerSampling   string `json:"lower_sampling"`
	Upper           string `json:"upper"`
	UpperPopulation string `json:"upper_population"`
	UpperSampling   string `json:"upper_sampling"`
}

StandardDeviationBoundsAsString type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L290-L297

func NewStandardDeviationBoundsAsString added in v8.5.0 

func NewStandardDeviationBoundsAsString() *StandardDeviationBoundsAsString

NewStandardDeviationBoundsAsString returns a StandardDeviationBoundsAsString.

func (*StandardDeviationBoundsAsString) UnmarshalJSON added in v8.9.0 

func (s *StandardDeviationBoundsAsString) UnmarshalJSON(data []byte) error

type StandardRetriever added in v8.14.0 

type StandardRetriever struct {
	// Collapse Collapses the top documents by a specified key into a single top document per
	// key.
	Collapse *FieldCollapse `json:"collapse,omitempty"`
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_ *string `json:"_name,omitempty"`
	// Query Defines a query to retrieve a set of top documents.
	Query *Query `json:"query,omitempty"`
	// SearchAfter Defines a search after object parameter used for pagination.
	SearchAfter []FieldValue `json:"search_after,omitempty"`
	// Sort A sort object that that specifies the order of matching documents.
	Sort []SortCombinations `json:"sort,omitempty"`
	// TerminateAfter Maximum number of documents to collect for each shard.
	TerminateAfter *int `json:"terminate_after,omitempty"`
}

StandardRetriever type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L98-L109

func NewStandardRetriever added in v8.14.0 

func NewStandardRetriever() *StandardRetriever

NewStandardRetriever returns a StandardRetriever.

func (*StandardRetriever) UnmarshalJSON added in v8.14.0 

func (s *StandardRetriever) UnmarshalJSON(data []byte) error

type StandardTokenizer 

type StandardTokenizer struct {
	MaxTokenLength *int    `json:"max_token_length,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

StandardTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L121-L124

func NewStandardTokenizer added in v8.5.0 

func NewStandardTokenizer() *StandardTokenizer

NewStandardTokenizer returns a StandardTokenizer.

func (StandardTokenizer) MarshalJSON added in v8.9.0 

func (s StandardTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StandardTokenizer) UnmarshalJSON added in v8.7.1 

func (s *StandardTokenizer) UnmarshalJSON(data []byte) error

type Statistics 

type Statistics struct {
	Policy                        *string  `json:"policy,omitempty"`
	RetentionDeletionTime         Duration `json:"retention_deletion_time,omitempty"`
	RetentionDeletionTimeMillis   *int64   `json:"retention_deletion_time_millis,omitempty"`
	RetentionFailed               *int64   `json:"retention_failed,omitempty"`
	RetentionRuns                 *int64   `json:"retention_runs,omitempty"`
	RetentionTimedOut             *int64   `json:"retention_timed_out,omitempty"`
	TotalSnapshotDeletionFailures *int64   `json:"total_snapshot_deletion_failures,omitempty"`
	TotalSnapshotsDeleted         *int64   `json:"total_snapshots_deleted,omitempty"`
	TotalSnapshotsFailed          *int64   `json:"total_snapshots_failed,omitempty"`
	TotalSnapshotsTaken           *int64   `json:"total_snapshots_taken,omitempty"`
}

Statistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/slm/_types/SnapshotLifecycle.ts#L61-L84

func NewStatistics added in v8.5.0 

func NewStatistics() *Statistics

NewStatistics returns a Statistics.

func (*Statistics) UnmarshalJSON added in v8.7.1 

func (s *Statistics) UnmarshalJSON(data []byte) error

type Stats 

type Stats struct {
	// AdaptiveSelection Statistics about adaptive replica selection.
	AdaptiveSelection map[string]AdaptiveSelection `json:"adaptive_selection,omitempty"`
	// Attributes Contains a list of attributes for the node.
	Attributes map[string]string `json:"attributes,omitempty"`
	// Breakers Statistics about the field data circuit breaker.
	Breakers map[string]Breaker `json:"breakers,omitempty"`
	// Discovery Contains node discovery statistics for the node.
	Discovery *Discovery `json:"discovery,omitempty"`
	// Fs File system information, data path, free disk space, read/write stats.
	Fs *FileSystem `json:"fs,omitempty"`
	// Host Network host for the node, based on the network host setting.
	Host *string `json:"host,omitempty"`
	// Http HTTP connection information.
	Http *Http `json:"http,omitempty"`
	// IndexingPressure Contains indexing pressure statistics for the node.
	IndexingPressure *NodesIndexingPressure `json:"indexing_pressure,omitempty"`
	// Indices Indices stats about size, document count, indexing and deletion times, search
	// times, field cache size, merges and flushes.
	Indices *IndicesShardStats `json:"indices,omitempty"`
	// Ingest Statistics about ingest preprocessing.
	Ingest *NodesIngest `json:"ingest,omitempty"`
	// Ip IP address and port for the node.
	Ip []string `json:"ip,omitempty"`
	// Jvm JVM stats, memory pool information, garbage collection, buffer pools, number
	// of loaded/unloaded classes.
	Jvm *Jvm `json:"jvm,omitempty"`
	// Name Human-readable identifier for the node.
	// Based on the node name setting.
	Name *string `json:"name,omitempty"`
	// Os Operating system stats, load average, mem, swap.
	Os *OperatingSystem `json:"os,omitempty"`
	// Process Process statistics, memory consumption, cpu usage, open file descriptors.
	Process *Process `json:"process,omitempty"`
	// Roles Roles assigned to the node.
	Roles []noderole.NodeRole `json:"roles,omitempty"`
	// Script Contains script statistics for the node.
	Script      *Scripting               `json:"script,omitempty"`
	ScriptCache map[string][]ScriptCache `json:"script_cache,omitempty"`
	// ThreadPool Statistics about each thread pool, including current size, queue and rejected
	// tasks.
	ThreadPool map[string]ThreadCount `json:"thread_pool,omitempty"`
	Timestamp  *int64                 `json:"timestamp,omitempty"`
	// Transport Transport statistics about sent and received bytes in cluster communication.
	Transport *Transport `json:"transport,omitempty"`
	// TransportAddress Host and port for the transport layer, used for internal communication
	// between nodes in a cluster.
	TransportAddress *string `json:"transport_address,omitempty"`
}

Stats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L30-L114

func NewStats added in v8.5.0 

func NewStats() *Stats

NewStats returns a Stats.

func (*Stats) UnmarshalJSON added in v8.7.1 

func (s *Stats) UnmarshalJSON(data []byte) error

type StatsAggregate 

type StatsAggregate struct {
	Avg         *Float64 `json:"avg,omitempty"`
	AvgAsString *string  `json:"avg_as_string,omitempty"`
	Count       int64    `json:"count"`
	Max         *Float64 `json:"max,omitempty"`
	MaxAsString *string  `json:"max_as_string,omitempty"`
	Meta        Metadata `json:"meta,omitempty"`
	Min         *Float64 `json:"min,omitempty"`
	MinAsString *string  `json:"min_as_string,omitempty"`
	Sum         Float64  `json:"sum"`
	SumAsString *string  `json:"sum_as_string,omitempty"`
}

StatsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L257-L273

func NewStatsAggregate added in v8.5.0 

func NewStatsAggregate() *StatsAggregate

NewStatsAggregate returns a StatsAggregate.

func (*StatsAggregate) UnmarshalJSON added in v8.7.1 

func (s *StatsAggregate) UnmarshalJSON(data []byte) error

type StatsAggregation 

type StatsAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

StatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L291-L291

func NewStatsAggregation added in v8.5.0 

func NewStatsAggregation() *StatsAggregation

NewStatsAggregation returns a StatsAggregation.

func (*StatsAggregation) UnmarshalJSON added in v8.7.1 

func (s *StatsAggregation) UnmarshalJSON(data []byte) error

type StatsBucketAggregate 

type StatsBucketAggregate struct {
	Avg         *Float64 `json:"avg,omitempty"`
	AvgAsString *string  `json:"avg_as_string,omitempty"`
	Count       int64    `json:"count"`
	Max         *Float64 `json:"max,omitempty"`
	MaxAsString *string  `json:"max_as_string,omitempty"`
	Meta        Metadata `json:"meta,omitempty"`
	Min         *Float64 `json:"min,omitempty"`
	MinAsString *string  `json:"min_as_string,omitempty"`
	Sum         Float64  `json:"sum"`
	SumAsString *string  `json:"sum_as_string,omitempty"`
}

StatsBucketAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L275-L279

func NewStatsBucketAggregate added in v8.5.0 

func NewStatsBucketAggregate() *StatsBucketAggregate

NewStatsBucketAggregate returns a StatsBucketAggregate.

func (*StatsBucketAggregate) UnmarshalJSON added in v8.7.1 

func (s *StatsBucketAggregate) UnmarshalJSON(data []byte) error

type StatsBucketAggregation 

type StatsBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

StatsBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L410-L410

func NewStatsBucketAggregation added in v8.5.0 

func NewStatsBucketAggregation() *StatsBucketAggregation

NewStatsBucketAggregation returns a StatsBucketAggregation.

func (*StatsBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *StatsBucketAggregation) UnmarshalJSON(data []byte) error

type Status 

type Status struct {
	IncludeGlobalState bool                          `json:"include_global_state"`
	Indices            map[string]SnapshotIndexStats `json:"indices"`
	Repository         string                        `json:"repository"`
	ShardsStats        SnapshotShardsStats           `json:"shards_stats"`
	Snapshot           string                        `json:"snapshot"`
	State              string                        `json:"state"`
	Stats              SnapshotStats                 `json:"stats"`
	Uuid               string                        `json:"uuid"`
}

Status type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/_types/SnapshotStatus.ts#L26-L35

func NewStatus added in v8.5.0 

func NewStatus() *Status

NewStatus returns a Status.

func (*Status) UnmarshalJSON added in v8.7.1 

func (s *Status) UnmarshalJSON(data []byte) error

type StatusError added in v8.18.0 

type StatusError struct {
	Index   string `json:"index"`
	Message string `json:"message"`
}

StatusError type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L44-L47

func NewStatusError added in v8.18.0 

func NewStatusError() *StatusError

NewStatusError returns a StatusError.

func (*StatusError) UnmarshalJSON added in v8.18.0 

func (s *StatusError) UnmarshalJSON(data []byte) error

type StatusInProgress added in v8.18.0 

type StatusInProgress struct {
	Index             string `json:"index"`
	ReindexedDocCount int64  `json:"reindexed_doc_count"`
	TotalDocCount     int64  `json:"total_doc_count"`
}

StatusInProgress type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L38-L42

func NewStatusInProgress added in v8.18.0 

func NewStatusInProgress() *StatusInProgress

NewStatusInProgress returns a StatusInProgress.

func (*StatusInProgress) UnmarshalJSON added in v8.18.0 

func (s *StatusInProgress) UnmarshalJSON(data []byte) error

type StemmerOverrideTokenFilter 

type StemmerOverrideTokenFilter struct {
	// Rules A list of mapping rules to use.
	Rules []string `json:"rules,omitempty"`
	// RulesPath A path (either relative to `config` location, or absolute) to a list of
	// mappings.
	RulesPath *string `json:"rules_path,omitempty"`
	Type      string  `json:"type,omitempty"`
	Version   *string `json:"version,omitempty"`
}

StemmerOverrideTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L416-L422

func NewStemmerOverrideTokenFilter added in v8.5.0 

func NewStemmerOverrideTokenFilter() *StemmerOverrideTokenFilter

NewStemmerOverrideTokenFilter returns a StemmerOverrideTokenFilter.

func (StemmerOverrideTokenFilter) MarshalJSON added in v8.9.0 

func (s StemmerOverrideTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StemmerOverrideTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *StemmerOverrideTokenFilter) UnmarshalJSON(data []byte) error

type StemmerTokenFilter 

type StemmerTokenFilter struct {
	Language *string `json:"language,omitempty"`
	Type     string  `json:"type,omitempty"`
	Version  *string `json:"version,omitempty"`
}

StemmerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L424-L428

func NewStemmerTokenFilter added in v8.5.0 

func NewStemmerTokenFilter() *StemmerTokenFilter

NewStemmerTokenFilter returns a StemmerTokenFilter.

func (StemmerTokenFilter) MarshalJSON added in v8.9.0 

func (s StemmerTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StemmerTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *StemmerTokenFilter) UnmarshalJSON(data []byte) error

type StepKey 

type StepKey struct {
	// Action The optional action to which the index will be moved.
	Action *string `json:"action,omitempty"`
	// Name The optional step name to which the index will be moved.
	Name  *string `json:"name,omitempty"`
	Phase string  `json:"phase"`
}

StepKey type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/move_to_step/types.ts#L20-L31

func NewStepKey added in v8.5.0 

func NewStepKey() *StepKey

NewStepKey returns a StepKey.

func (*StepKey) UnmarshalJSON added in v8.9.0 

func (s *StepKey) UnmarshalJSON(data []byte) error

type StopAnalyzer 

type StopAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
	Version       *string   `json:"version,omitempty"`
}

StopAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L338-L343

func NewStopAnalyzer added in v8.5.0 

func NewStopAnalyzer() *StopAnalyzer

NewStopAnalyzer returns a StopAnalyzer.

func (StopAnalyzer) MarshalJSON added in v8.9.0 

func (s StopAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StopAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *StopAnalyzer) UnmarshalJSON(data []byte) error

type StopTokenFilter 

type StopTokenFilter struct {
	// IgnoreCase If `true`, stop word matching is case insensitive. For example, if `true`, a
	// stop word of the matches and removes `The`, `THE`, or `the`. Defaults to
	// `false`.
	IgnoreCase *bool `json:"ignore_case,omitempty"`
	// RemoveTrailing If `true`, the last token of a stream is removed if it’s a stop word.
	// Defaults to `true`.
	RemoveTrailing *bool `json:"remove_trailing,omitempty"`
	// Stopwords Language value, such as `_arabic_` or `_thai_`. Defaults to `_english_`.
	Stopwords StopWords `json:"stopwords,omitempty"`
	// StopwordsPath Path to a file that contains a list of stop words to remove.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each stop word in the file must be separated by a line
	// break.
	StopwordsPath *string `json:"stopwords_path,omitempty"`
	Type          string  `json:"type,omitempty"`
	Version       *string `json:"version,omitempty"`
}

StopTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L125-L136

func NewStopTokenFilter added in v8.5.0 

func NewStopTokenFilter() *StopTokenFilter

NewStopTokenFilter returns a StopTokenFilter.

func (StopTokenFilter) MarshalJSON added in v8.9.0 

func (s StopTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*StopTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *StopTokenFilter) UnmarshalJSON(data []byte) error

type StopWords 

type StopWords any

StopWords holds the union for the following types: 

stopwordlanguage.StopWordLanguage
[]string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/StopWords.ts#L60-L66

type Storage 

type Storage struct {
	// AllowMmap You can restrict the use of the mmapfs and the related hybridfs store type
	// via the setting node.store.allow_mmap.
	// This is a boolean setting indicating whether or not memory-mapping is
	// allowed. The default is to allow it. This
	// setting is useful, for example, if you are in an environment where you can
	// not control the ability to create a lot
	// of memory maps so you need disable the ability to use memory-mapping.
	AllowMmap *bool                   `json:"allow_mmap,omitempty"`
	Type      storagetype.StorageType `json:"type"`
}

Storage type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L534-L543

func NewStorage added in v8.5.0 

func NewStorage() *Storage

NewStorage returns a Storage.

func (*Storage) UnmarshalJSON added in v8.7.1 

func (s *Storage) UnmarshalJSON(data []byte) error

type StoreStats 

type StoreStats struct {
	// Reserved A prediction of how much larger the shard stores will eventually grow due to
	// ongoing peer recoveries, restoring snapshots, and similar activities.
	Reserved ByteSize `json:"reserved,omitempty"`
	// ReservedInBytes A prediction, in bytes, of how much larger the shard stores will eventually
	// grow due to ongoing peer recoveries, restoring snapshots, and similar
	// activities.
	ReservedInBytes int64 `json:"reserved_in_bytes"`
	// Size Total size of all shards assigned to selected nodes.
	Size ByteSize `json:"size,omitempty"`
	// SizeInBytes Total size, in bytes, of all shards assigned to selected nodes.
	SizeInBytes int64 `json:"size_in_bytes"`
	// TotalDataSetSize Total data set size of all shards assigned to selected nodes.
	// This includes the size of shards not stored fully on the nodes, such as the
	// cache for partially mounted indices.
	TotalDataSetSize ByteSize `json:"total_data_set_size,omitempty"`
	// TotalDataSetSizeInBytes Total data set size, in bytes, of all shards assigned to selected nodes.
	// This includes the size of shards not stored fully on the nodes, such as the
	// cache for partially mounted indices.
	TotalDataSetSizeInBytes *int64 `json:"total_data_set_size_in_bytes,omitempty"`
}

StoreStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L371-L398

func NewStoreStats added in v8.5.0 

func NewStoreStats() *StoreStats

NewStoreStats returns a StoreStats.

func (*StoreStats) UnmarshalJSON added in v8.7.1 

func (s *StoreStats) UnmarshalJSON(data []byte) error

type StoredScript 

type StoredScript struct {
	// Lang The language the script is written in.
	// For serach templates, use `mustache`.
	Lang    scriptlanguage.ScriptLanguage `json:"lang"`
	Options map[string]string             `json:"options,omitempty"`
	// Source The script source.
	// For search templates, an object containing the search template.
	Source string `json:"source"`
}

StoredScript type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Scripting.ts#L47-L59

func NewStoredScript added in v8.5.0 

func NewStoredScript() *StoredScript

NewStoredScript returns a StoredScript.

func (*StoredScript) UnmarshalJSON added in v8.9.0 

func (s *StoredScript) UnmarshalJSON(data []byte) error

type StreamResult added in v8.18.0 

type StreamResult []byte

StreamResult type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Binary.ts#L27-L27

type StringRareTermsAggregate 

type StringRareTermsAggregate struct {
	Buckets BucketsStringRareTermsBucket `json:"buckets"`
	Meta    Metadata                     `json:"meta,omitempty"`
}

StringRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L483-L487

func NewStringRareTermsAggregate added in v8.5.0 

func NewStringRareTermsAggregate() *StringRareTermsAggregate

NewStringRareTermsAggregate returns a StringRareTermsAggregate.

func (*StringRareTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *StringRareTermsAggregate) UnmarshalJSON(data []byte) error

type StringRareTermsBucket 

type StringRareTermsBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          string               `json:"key"`
}

StringRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L489-L491

func NewStringRareTermsBucket added in v8.5.0 

func NewStringRareTermsBucket() *StringRareTermsBucket

NewStringRareTermsBucket returns a StringRareTermsBucket.

func (StringRareTermsBucket) MarshalJSON 

func (s StringRareTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*StringRareTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *StringRareTermsBucket) UnmarshalJSON(data []byte) error

type StringStatsAggregate 

type StringStatsAggregate struct {
	AvgLength         *Float64            `json:"avg_length,omitempty"`
	AvgLengthAsString *string             `json:"avg_length_as_string,omitempty"`
	Count             int64               `json:"count"`
	Distribution      *map[string]Float64 `json:"distribution,omitempty"`
	Entropy           *Float64            `json:"entropy,omitempty"`
	MaxLength         *int                `json:"max_length,omitempty"`
	MaxLengthAsString *string             `json:"max_length_as_string,omitempty"`
	Meta              Metadata            `json:"meta,omitempty"`
	MinLength         *int                `json:"min_length,omitempty"`
	MinLengthAsString *string             `json:"min_length_as_string,omitempty"`
}

StringStatsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L793-L804

func NewStringStatsAggregate added in v8.5.0 

func NewStringStatsAggregate() *StringStatsAggregate

NewStringStatsAggregate returns a StringStatsAggregate.

func (*StringStatsAggregate) UnmarshalJSON added in v8.7.1 

func (s *StringStatsAggregate) UnmarshalJSON(data []byte) error

type StringStatsAggregation 

type StringStatsAggregation struct {
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// ShowDistribution Shows the probability distribution for all characters.
	ShowDistribution *bool `json:"show_distribution,omitempty"`
}

StringStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L293-L299

func NewStringStatsAggregation added in v8.5.0 

func NewStringStatsAggregation() *StringStatsAggregation

NewStringStatsAggregation returns a StringStatsAggregation.

func (*StringStatsAggregation) UnmarshalJSON added in v8.7.1 

func (s *StringStatsAggregation) UnmarshalJSON(data []byte) error

type StringTermsAggregate 

type StringTermsAggregate struct {
	Buckets                 BucketsStringTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                 `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

StringTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L424-L429

func NewStringTermsAggregate added in v8.5.0 

func NewStringTermsAggregate() *StringTermsAggregate

NewStringTermsAggregate returns a StringTermsAggregate.

func (*StringTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *StringTermsAggregate) UnmarshalJSON(data []byte) error

type StringTermsBucket 

type StringTermsBucket struct {
	Aggregations            map[string]Aggregate `json:"-"`
	DocCount                int64                `json:"doc_count"`
	DocCountErrorUpperBound *int64               `json:"doc_count_error_upper_bound,omitempty"`
	Key                     FieldValue           `json:"key"`
}

StringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L435-L437

func NewStringTermsBucket added in v8.5.0 

func NewStringTermsBucket() *StringTermsBucket

NewStringTermsBucket returns a StringTermsBucket.

func (StringTermsBucket) MarshalJSON 

func (s StringTermsBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*StringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *StringTermsBucket) UnmarshalJSON(data []byte) error

type StringifiedEpochTimeUnitMillis 

type StringifiedEpochTimeUnitMillis any

StringifiedEpochTimeUnitMillis holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type StringifiedEpochTimeUnitSeconds 

type StringifiedEpochTimeUnitSeconds any

StringifiedEpochTimeUnitSeconds holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type StringifiedVersionNumber added in v8.5.0 

type StringifiedVersionNumber any

StringifiedVersionNumber holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type Stringifiedboolean added in v8.7.1 

type Stringifiedboolean any

Stringifiedboolean holds the union for the following types: 

bool
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type Stringifieddouble added in v8.16.0 

type Stringifieddouble any

Stringifieddouble holds the union for the following types: 

Float64
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type Stringifiedinteger added in v8.7.1 

type Stringifiedinteger any

Stringifiedinteger holds the union for the following types: 

int
string

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_spec_utils/Stringified.ts#L20-L27

type StupidBackoffSmoothingModel 

type StupidBackoffSmoothingModel struct {
	// Discount A constant factor that the lower order n-gram model is discounted by.
	Discount Float64 `json:"discount"`
}

StupidBackoffSmoothingModel type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L463-L468

func NewStupidBackoffSmoothingModel added in v8.5.0 

func NewStupidBackoffSmoothingModel() *StupidBackoffSmoothingModel

NewStupidBackoffSmoothingModel returns a StupidBackoffSmoothingModel.

func (*StupidBackoffSmoothingModel) UnmarshalJSON added in v8.7.1 

func (s *StupidBackoffSmoothingModel) UnmarshalJSON(data []byte) error

type Suggest 

type Suggest any

Suggest holds the union for the following types: 

CompletionSuggest
PhraseSuggest
TermSuggest

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L34-L40

type SuggestContext 

type SuggestContext struct {
	Name      string  `json:"name"`
	Path      *string `json:"path,omitempty"`
	Precision string  `json:"precision,omitempty"`
	Type      string  `json:"type"`
}

SuggestContext type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L43-L48

func NewSuggestContext added in v8.5.0 

func NewSuggestContext() *SuggestContext

NewSuggestContext returns a SuggestContext.

func (*SuggestContext) UnmarshalJSON added in v8.7.1 

func (s *SuggestContext) UnmarshalJSON(data []byte) error

type SuggestFuzziness 

type SuggestFuzziness struct {
	// Fuzziness The fuzziness factor.
	Fuzziness Fuzziness `json:"fuzziness,omitempty"`
	// MinLength Minimum length of the input before fuzzy suggestions are returned.
	MinLength *int `json:"min_length,omitempty"`
	// PrefixLength Minimum length of the input, which is not checked for fuzzy alternatives.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// Transpositions If set to `true`, transpositions are counted as one change instead of two.
	Transpositions *bool `json:"transpositions,omitempty"`
	// UnicodeAware If `true`, all measurements (like fuzzy edit distance, transpositions, and
	// lengths) are measured in Unicode code points instead of in bytes.
	// This is slightly slower than raw bytes.
	UnicodeAware *bool `json:"unicode_aware,omitempty"`
}

SuggestFuzziness type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L196-L224

func NewSuggestFuzziness added in v8.5.0 

func NewSuggestFuzziness() *SuggestFuzziness

NewSuggestFuzziness returns a SuggestFuzziness.

func (*SuggestFuzziness) UnmarshalJSON added in v8.7.1 

func (s *SuggestFuzziness) UnmarshalJSON(data []byte) error

type Suggester 

type Suggester struct {
	Suggesters map[string]FieldSuggester `json:"-"`
	// Text Global suggest text, to avoid repetition when the same text is used in
	// several suggesters
	Text *string `json:"text,omitempty"`
}

Suggester type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L101-L107

func NewSuggester added in v8.5.0 

func NewSuggester() *Suggester

NewSuggester returns a Suggester.

func (Suggester) MarshalJSON 

func (s Suggester) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*Suggester) UnmarshalJSON added in v8.9.0 

func (s *Suggester) UnmarshalJSON(data []byte) error

type SumAggregate 

type SumAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

SumAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L211-L216

func NewSumAggregate added in v8.5.0 

func NewSumAggregate() *SumAggregate

NewSumAggregate returns a SumAggregate.

func (*SumAggregate) UnmarshalJSON added in v8.7.1 

func (s *SumAggregate) UnmarshalJSON(data []byte) error

type SumAggregation 

type SumAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

SumAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L301-L301

func NewSumAggregation added in v8.5.0 

func NewSumAggregation() *SumAggregation

NewSumAggregation returns a SumAggregation.

func (*SumAggregation) UnmarshalJSON added in v8.7.1 

func (s *SumAggregation) UnmarshalJSON(data []byte) error

type SumBucketAggregation 

type SumBucketAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath BucketsPath `json:"buckets_path,omitempty"`
	// Format `DecimalFormat` pattern for the output value.
	// If specified, the formatted value is returned in the aggregation’s
	// `value_as_string` property.
	Format *string `json:"format,omitempty"`
	// GapPolicy Policy to apply when gaps are found in the data.
	GapPolicy *gappolicy.GapPolicy `json:"gap_policy,omitempty"`
}

SumBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/pipeline.ts#L412-L415

func NewSumBucketAggregation added in v8.5.0 

func NewSumBucketAggregation() *SumBucketAggregation

NewSumBucketAggregation returns a SumBucketAggregation.

func (*SumBucketAggregation) UnmarshalJSON added in v8.7.0 

func (s *SumBucketAggregation) UnmarshalJSON(data []byte) error

type Summary 

type Summary struct {
	Config map[policytype.PolicyType]EnrichPolicy `json:"config"`
}

Summary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/enrich/_types/Policy.ts#L24-L26

func NewSummary added in v8.5.0 

func NewSummary() *Summary

NewSummary returns a Summary.

type SummaryInfo added in v8.18.0 

type SummaryInfo struct {
	// Read A collection of statistics that summarise the results of the read operations
	// in the test.
	Read ReadSummaryInfo `json:"read"`
	// Write A collection of statistics that summarise the results of the write operations
	// in the test.
	Write WriteSummaryInfo `json:"write"`
}

SummaryInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L193-L202

func NewSummaryInfo added in v8.18.0 

func NewSummaryInfo() *SummaryInfo

NewSummaryInfo returns a SummaryInfo.

type SwedishAnalyzer added in v8.16.0 

type SwedishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

SwedishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L283-L288

func NewSwedishAnalyzer added in v8.16.0 

func NewSwedishAnalyzer() *SwedishAnalyzer

NewSwedishAnalyzer returns a SwedishAnalyzer.

func (SwedishAnalyzer) MarshalJSON added in v8.16.0 

func (s SwedishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SwedishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *SwedishAnalyzer) UnmarshalJSON(data []byte) error

type SyncContainer 

type SyncContainer struct {
	// Time Specifies that the transform uses a time field to synchronize the source and
	// destination indices.
	Time *TimeSync `json:"time,omitempty"`
}

SyncContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L169-L175

func NewSyncContainer added in v8.5.0 

func NewSyncContainer() *SyncContainer

NewSyncContainer returns a SyncContainer.

type SyncJobConnectorReference added in v8.15.0 

type SyncJobConnectorReference struct {
	Configuration ConnectorConfiguration `json:"configuration"`
	Filtering     FilteringRules         `json:"filtering"`
	Id            string                 `json:"id"`
	IndexName     string                 `json:"index_name"`
	Language      *string                `json:"language,omitempty"`
	Pipeline      *IngestPipelineParams  `json:"pipeline,omitempty"`
	ServiceType   string                 `json:"service_type"`
	SyncCursor    json.RawMessage        `json:"sync_cursor,omitempty"`
}

SyncJobConnectorReference type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/SyncJob.ts#L31-L40

func NewSyncJobConnectorReference added in v8.15.0 

func NewSyncJobConnectorReference() *SyncJobConnectorReference

NewSyncJobConnectorReference returns a SyncJobConnectorReference.

func (*SyncJobConnectorReference) UnmarshalJSON added in v8.15.0 

func (s *SyncJobConnectorReference) UnmarshalJSON(data []byte) error

type SyncRulesFeature added in v8.15.0 

type SyncRulesFeature struct {
	// Advanced Indicates whether advanced sync rules are enabled.
	Advanced *FeatureEnabled `json:"advanced,omitempty"`
	// Basic Indicates whether basic sync rules are enabled.
	Basic *FeatureEnabled `json:"basic,omitempty"`
}

SyncRulesFeature type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L219-L228

func NewSyncRulesFeature added in v8.15.0 

func NewSyncRulesFeature() *SyncRulesFeature

NewSyncRulesFeature returns a SyncRulesFeature.

type SynonymGraphTokenFilter 

type SynonymGraphTokenFilter struct {
	// Expand Expands definitions for equivalent synonym rules. Defaults to `true`.
	Expand *bool `json:"expand,omitempty"`
	// Format Sets the synonym rules format.
	Format *synonymformat.SynonymFormat `json:"format,omitempty"`
	// Lenient If `true` ignores errors while parsing the synonym rules. It is important to
	// note that only those synonym rules which cannot get parsed are ignored.
	// Defaults to the value of the `updateable` setting.
	Lenient *bool `json:"lenient,omitempty"`
	// Synonyms Used to define inline synonyms.
	Synonyms []string `json:"synonyms,omitempty"`
	// SynonymsPath Used to provide a synonym file. This path must be absolute or relative to the
	// `config` location.
	SynonymsPath *string `json:"synonyms_path,omitempty"`
	// SynonymsSet Provide a synonym set created via Synonyms Management APIs.
	SynonymsSet *string `json:"synonyms_set,omitempty"`
	// Tokenizer Controls the tokenizers that will be used to tokenize the synonym, this
	// parameter is for backwards compatibility for indices that created before 6.0.
	Tokenizer *string `json:"tokenizer,omitempty"`
	Type      string  `json:"type,omitempty"`
	// Updateable If `true` allows reloading search analyzers to pick up changes to synonym
	// files. Only to be used for search analyzers. Defaults to `false`.
	Updateable *bool   `json:"updateable,omitempty"`
	Version    *string `json:"version,omitempty"`
}

SynonymGraphTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L163-L165

func NewSynonymGraphTokenFilter added in v8.5.0 

func NewSynonymGraphTokenFilter() *SynonymGraphTokenFilter

NewSynonymGraphTokenFilter returns a SynonymGraphTokenFilter.

func (SynonymGraphTokenFilter) MarshalJSON added in v8.9.0 

func (s SynonymGraphTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SynonymGraphTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *SynonymGraphTokenFilter) UnmarshalJSON(data []byte) error

type SynonymRule added in v8.10.0 

type SynonymRule struct {
	// Id The identifier for the synonym rule.
	// If you do not specify a synonym rule ID when you create a rule, an identifier
	// is created automatically by Elasticsearch.
	Id *string `json:"id,omitempty"`
	// Synonyms The synonyms that conform the synonym rule in Solr format.
	Synonyms string `json:"synonyms"`
}

SynonymRule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/synonyms/_types/SynonymRule.ts#L26-L37

func NewSynonymRule added in v8.10.0 

func NewSynonymRule() *SynonymRule

NewSynonymRule returns a SynonymRule.

func (*SynonymRule) UnmarshalJSON added in v8.10.0 

func (s *SynonymRule) UnmarshalJSON(data []byte) error

type SynonymRuleRead added in v8.10.0 

type SynonymRuleRead struct {
	// Id Synonym Rule identifier
	Id string `json:"id"`
	// Synonyms Synonyms, in Solr format, that conform the synonym rule. See
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2
	Synonyms string `json:"synonyms"`
}

SynonymRuleRead type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/synonyms/_types/SynonymRule.ts#L40-L49

func NewSynonymRuleRead added in v8.10.0 

func NewSynonymRuleRead() *SynonymRuleRead

NewSynonymRuleRead returns a SynonymRuleRead.

func (*SynonymRuleRead) UnmarshalJSON added in v8.10.0 

func (s *SynonymRuleRead) UnmarshalJSON(data []byte) error

type SynonymTokenFilter 

type SynonymTokenFilter struct {
	// Expand Expands definitions for equivalent synonym rules. Defaults to `true`.
	Expand *bool `json:"expand,omitempty"`
	// Format Sets the synonym rules format.
	Format *synonymformat.SynonymFormat `json:"format,omitempty"`
	// Lenient If `true` ignores errors while parsing the synonym rules. It is important to
	// note that only those synonym rules which cannot get parsed are ignored.
	// Defaults to the value of the `updateable` setting.
	Lenient *bool `json:"lenient,omitempty"`
	// Synonyms Used to define inline synonyms.
	Synonyms []string `json:"synonyms,omitempty"`
	// SynonymsPath Used to provide a synonym file. This path must be absolute or relative to the
	// `config` location.
	SynonymsPath *string `json:"synonyms_path,omitempty"`
	// SynonymsSet Provide a synonym set created via Synonyms Management APIs.
	SynonymsSet *string `json:"synonyms_set,omitempty"`
	// Tokenizer Controls the tokenizers that will be used to tokenize the synonym, this
	// parameter is for backwards compatibility for indices that created before 6.0.
	Tokenizer *string `json:"tokenizer,omitempty"`
	Type      string  `json:"type,omitempty"`
	// Updateable If `true` allows reloading search analyzers to pick up changes to synonym
	// files. Only to be used for search analyzers. Defaults to `false`.
	Updateable *bool   `json:"updateable,omitempty"`
	Version    *string `json:"version,omitempty"`
}

SynonymTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L167-L169

func NewSynonymTokenFilter added in v8.5.0 

func NewSynonymTokenFilter() *SynonymTokenFilter

NewSynonymTokenFilter returns a SynonymTokenFilter.

func (SynonymTokenFilter) MarshalJSON added in v8.9.0 

func (s SynonymTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*SynonymTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *SynonymTokenFilter) UnmarshalJSON(data []byte) error

type SynonymsSetItem added in v8.10.0 

type SynonymsSetItem struct {
	// Count Number of synonym rules that the synonym set contains
	Count int `json:"count"`
	// SynonymsSet Synonyms set identifier
	SynonymsSet string `json:"synonyms_set"`
}

SynonymsSetItem type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/synonyms/get_synonyms_sets/SynonymsSetsGetResponse.ts#L36-L45

func NewSynonymsSetItem added in v8.10.0 

func NewSynonymsSetItem() *SynonymsSetItem

NewSynonymsSetItem returns a SynonymsSetItem.

func (*SynonymsSetItem) UnmarshalJSON added in v8.10.0 

func (s *SynonymsSetItem) UnmarshalJSON(data []byte) error

type SynonymsUpdateResult added in v8.10.0 

type SynonymsUpdateResult struct {
	// ReloadAnalyzersDetails Updating synonyms in a synonym set reloads the associated analyzers.
	// This information is the analyzers reloading result.
	ReloadAnalyzersDetails ReloadResult `json:"reload_analyzers_details"`
	// Result The update operation result.
	Result result.Result `json:"result"`
}

SynonymsUpdateResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/synonyms/_types/SynonymsUpdateResult.ts#L23-L34

func NewSynonymsUpdateResult added in v8.10.0 

func NewSynonymsUpdateResult() *SynonymsUpdateResult

NewSynonymsUpdateResult returns a SynonymsUpdateResult.

type TDigest 

type TDigest struct {
	// Compression Limits the maximum number of nodes used by the underlying TDigest algorithm
	// to `20 * compression`, enabling control of memory usage and approximation
	// error.
	Compression *int `json:"compression,omitempty"`
}

TDigest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L232-L237

func NewTDigest added in v8.5.0 

func NewTDigest() *TDigest

NewTDigest returns a TDigest.

func (*TDigest) UnmarshalJSON added in v8.7.1 

func (s *TDigest) UnmarshalJSON(data []byte) error

type TDigestPercentileRanksAggregate 

type TDigestPercentileRanksAggregate struct {
	Meta   Metadata    `json:"meta,omitempty"`
	Values Percentiles `json:"values"`
}

TDigestPercentileRanksAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L177-L178

func NewTDigestPercentileRanksAggregate added in v8.5.0 

func NewTDigestPercentileRanksAggregate() *TDigestPercentileRanksAggregate

NewTDigestPercentileRanksAggregate returns a TDigestPercentileRanksAggregate.

func (*TDigestPercentileRanksAggregate) UnmarshalJSON added in v8.7.1 

func (s *TDigestPercentileRanksAggregate) UnmarshalJSON(data []byte) error

type TDigestPercentilesAggregate 

type TDigestPercentilesAggregate struct {
	Meta   Metadata    `json:"meta,omitempty"`
	Values Percentiles `json:"values"`
}

TDigestPercentilesAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L174-L175

func NewTDigestPercentilesAggregate added in v8.5.0 

func NewTDigestPercentilesAggregate() *TDigestPercentilesAggregate

NewTDigestPercentilesAggregate returns a TDigestPercentilesAggregate.

func (*TDigestPercentilesAggregate) UnmarshalJSON added in v8.7.1 

func (s *TDigestPercentilesAggregate) UnmarshalJSON(data []byte) error

type TTestAggregate 

type TTestAggregate struct {
	Meta          Metadata `json:"meta,omitempty"`
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

TTestAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L838-L845

func NewTTestAggregate added in v8.5.0 

func NewTTestAggregate() *TTestAggregate

NewTTestAggregate returns a TTestAggregate.

func (*TTestAggregate) UnmarshalJSON added in v8.7.1 

func (s *TTestAggregate) UnmarshalJSON(data []byte) error

type TTestAggregation 

type TTestAggregation struct {
	// A Test population A.
	A *TestPopulation `json:"a,omitempty"`
	// B Test population B.
	B *TestPopulation `json:"b,omitempty"`
	// Type The type of test.
	Type *ttesttype.TTestType `json:"type,omitempty"`
}

TTestAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L303-L317

func NewTTestAggregation added in v8.5.0 

func NewTTestAggregation() *TTestAggregation

NewTTestAggregation returns a TTestAggregation.

type TableValuesContainer added in v8.16.0 

type TableValuesContainer struct {
	Float64 [][]Float64 `json:"double,omitempty"`
	Int     [][]int     `json:"integer,omitempty"`
	Int64   [][]int64   `json:"long,omitempty"`
	Keyword [][]string  `json:"keyword,omitempty"`
}

TableValuesContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/esql/_types/TableValuesContainer.ts#L22-L28

func NewTableValuesContainer added in v8.16.0 

func NewTableValuesContainer() *TableValuesContainer

NewTableValuesContainer returns a TableValuesContainer.

type TableValuesIntegerValue added in v8.16.0 

type TableValuesIntegerValue []int

TableValuesIntegerValue type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/esql/_types/TableValuesContainer.ts#L30-L30

type TableValuesKeywordValue added in v8.16.0 

type TableValuesKeywordValue []string

TableValuesKeywordValue type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/esql/_types/TableValuesContainer.ts#L31-L31

type TableValuesLongDouble added in v8.16.0 

type TableValuesLongDouble []Float64

TableValuesLongDouble type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/esql/_types/TableValuesContainer.ts#L33-L33

type TableValuesLongValue added in v8.16.0 

type TableValuesLongValue []int64

TableValuesLongValue type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/esql/_types/TableValuesContainer.ts#L32-L32

type TargetMeanEncodingPreprocessor 

type TargetMeanEncodingPreprocessor struct {
	DefaultValue Float64            `json:"default_value"`
	FeatureName  string             `json:"feature_name"`
	Field        string             `json:"field"`
	TargetMap    map[string]Float64 `json:"target_map"`
}

TargetMeanEncodingPreprocessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L49-L54

func NewTargetMeanEncodingPreprocessor added in v8.5.0 

func NewTargetMeanEncodingPreprocessor() *TargetMeanEncodingPreprocessor

NewTargetMeanEncodingPreprocessor returns a TargetMeanEncodingPreprocessor.

func (*TargetMeanEncodingPreprocessor) UnmarshalJSON added in v8.7.1 

func (s *TargetMeanEncodingPreprocessor) UnmarshalJSON(data []byte) error

type TaskFailure 

type TaskFailure struct {
	NodeId string     `json:"node_id"`
	Reason ErrorCause `json:"reason"`
	Status string     `json:"status"`
	TaskId int64      `json:"task_id"`
}

TaskFailure type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Errors.ts#L67-L72

func NewTaskFailure added in v8.5.0 

func NewTaskFailure() *TaskFailure

NewTaskFailure returns a TaskFailure.

func (*TaskFailure) UnmarshalJSON added in v8.7.1 

func (s *TaskFailure) UnmarshalJSON(data []byte) error

type TaskId 

type TaskId any

TaskId holds the union for the following types: 

string
int

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L136-L136

type TaskInfo 

type TaskInfo struct {
	Action      string `json:"action"`
	Cancellable bool   `json:"cancellable"`
	Cancelled   *bool  `json:"cancelled,omitempty"`
	// Description Human readable text that identifies the particular request that the task is
	// performing.
	// For example, it might identify the search request being performed by a search
	// task.
	// Other kinds of tasks have different descriptions, like `_reindex` which has
	// the source and the destination, or `_bulk` which just has the number of
	// requests and the destination indices.
	// Many requests will have only an empty description because more detailed
	// information about the request is not easily available or particularly helpful
	// in identifying the request.
	Description        *string           `json:"description,omitempty"`
	Headers            map[string]string `json:"headers"`
	Id                 int64             `json:"id"`
	Node               string            `json:"node"`
	ParentTaskId       TaskId            `json:"parent_task_id,omitempty"`
	RunningTime        Duration          `json:"running_time,omitempty"`
	RunningTimeInNanos int64             `json:"running_time_in_nanos"`
	StartTimeInMillis  int64             `json:"start_time_in_millis"`
	// Status The internal status of the task, which varies from task to task.
	// The format also varies.
	// While the goal is to keep the status for a particular task consistent from
	// version to version, this is not always possible because sometimes the
	// implementation changes.
	// Fields might be removed from the status for a particular request so any
	// parsing you do of the status might break in minor releases.
	Status json.RawMessage `json:"status,omitempty"`
	Type   string          `json:"type"`
}

TaskInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/tasks/_types/TaskInfo.ts#L32-L58

func NewTaskInfo added in v8.5.0 

func NewTaskInfo() *TaskInfo

NewTaskInfo returns a TaskInfo.

func (*TaskInfo) UnmarshalJSON added in v8.7.1 

func (s *TaskInfo) UnmarshalJSON(data []byte) error

type TaskInfos 

type TaskInfos any

TaskInfos holds the union for the following types: 

[]TaskInfo
map[string]ParentTaskInfo

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/tasks/_types/TaskListResponseBase.ts#L40-L43

type TasksRecord 

type TasksRecord struct {
	// Action The task action.
	Action *string `json:"action,omitempty"`
	// Description The task action description.
	Description *string `json:"description,omitempty"`
	// Id The identifier of the task with the node.
	Id *string `json:"id,omitempty"`
	// Ip The IP address for the node.
	Ip *string `json:"ip,omitempty"`
	// Node The node name.
	Node *string `json:"node,omitempty"`
	// NodeId The unique node identifier.
	NodeId *string `json:"node_id,omitempty"`
	// ParentTaskId The parent task identifier.
	ParentTaskId *string `json:"parent_task_id,omitempty"`
	// Port The bound transport port for the node.
	Port *string `json:"port,omitempty"`
	// RunningTime The running time.
	RunningTime *string `json:"running_time,omitempty"`
	// RunningTimeNs The running time in nanoseconds.
	RunningTimeNs *string `json:"running_time_ns,omitempty"`
	// StartTime The start time in milliseconds.
	StartTime *string `json:"start_time,omitempty"`
	// TaskId The unique task identifier.
	TaskId *string `json:"task_id,omitempty"`
	// Timestamp The start time in `HH:MM:SS` format.
	Timestamp *string `json:"timestamp,omitempty"`
	// Type The task type.
	Type *string `json:"type,omitempty"`
	// Version The Elasticsearch version.
	Version *string `json:"version,omitempty"`
	// XOpaqueId The X-Opaque-ID header.
	XOpaqueId *string `json:"x_opaque_id,omitempty"`
}

TasksRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/tasks/types.ts#L22-L101

func NewTasksRecord added in v8.5.0 

func NewTasksRecord() *TasksRecord

NewTasksRecord returns a TasksRecord.

func (*TasksRecord) UnmarshalJSON added in v8.7.1 

func (s *TasksRecord) UnmarshalJSON(data []byte) error

type Template 

type Template struct {
	Aliases  map[string]Alias `json:"aliases"`
	Mappings TypeMapping      `json:"mappings"`
	Settings IndexSettings    `json:"settings"`
}

Template type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts#L33-L37

func NewTemplate added in v8.5.0 

func NewTemplate() *Template

NewTemplate returns a Template.

type TemplateConfig added in v8.9.0 

type TemplateConfig struct {
	// Explain If `true`, returns detailed information about score calculation as part of
	// each hit.
	Explain *bool `json:"explain,omitempty"`
	// Id The ID of the search template to use. If no `source` is specified,
	// this parameter is required.
	Id *string `json:"id,omitempty"`
	// Params Key-value pairs used to replace Mustache variables in the template.
	// The key is the variable name.
	// The value is the variable value.
	Params map[string]json.RawMessage `json:"params,omitempty"`
	// Profile If `true`, the query execution is profiled.
	Profile *bool `json:"profile,omitempty"`
	// Source An inline search template. Supports the same parameters as the search API's
	// request body. It also supports Mustache variables. If no `id` is specified,
	// this
	// parameter is required.
	Source *string `json:"source,omitempty"`
}

TemplateConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/msearch_template/types.ts#L28-L54

func NewTemplateConfig added in v8.9.0 

func NewTemplateConfig() *TemplateConfig

NewTemplateConfig returns a TemplateConfig.

func (*TemplateConfig) UnmarshalJSON added in v8.9.0 

func (s *TemplateConfig) UnmarshalJSON(data []byte) error

type TemplateMapping 

type TemplateMapping struct {
	Aliases       map[string]Alias           `json:"aliases"`
	IndexPatterns []string                   `json:"index_patterns"`
	Mappings      TypeMapping                `json:"mappings"`
	Order         int                        `json:"order"`
	Settings      map[string]json.RawMessage `json:"settings"`
	Version       *int64                     `json:"version,omitempty"`
}

TemplateMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/TemplateMapping.ts#L27-L34

func NewTemplateMapping added in v8.5.0 

func NewTemplateMapping() *TemplateMapping

NewTemplateMapping returns a TemplateMapping.

func (*TemplateMapping) UnmarshalJSON added in v8.7.1 

func (s *TemplateMapping) UnmarshalJSON(data []byte) error

type TemplatesRecord 

type TemplatesRecord struct {
	// ComposedOf The component templates that comprise the index template.
	ComposedOf *string `json:"composed_of,omitempty"`
	// IndexPatterns The template index patterns.
	IndexPatterns *string `json:"index_patterns,omitempty"`
	// Name The template name.
	Name *string `json:"name,omitempty"`
	// Order The template application order or priority number.
	Order *string `json:"order,omitempty"`
	// Version The template version.
	Version *string `json:"version,omitempty"`
}

TemplatesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/templates/types.ts#L22-L48

func NewTemplatesRecord added in v8.5.0 

func NewTemplatesRecord() *TemplatesRecord

NewTemplatesRecord returns a TemplatesRecord.

func (*TemplatesRecord) UnmarshalJSON added in v8.7.1 

func (s *TemplatesRecord) UnmarshalJSON(data []byte) error

type Term 

type Term struct {
	DocFreq  *int               `json:"doc_freq,omitempty"`
	Score    *Float64           `json:"score,omitempty"`
	TermFreq int                `json:"term_freq"`
	Tokens   []TermVectorsToken `json:"tokens,omitempty"`
	Ttf      *int               `json:"ttf,omitempty"`
}

Term type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/termvectors/types.ts#L34-L40

func NewTerm added in v8.5.0 

func NewTerm() *Term

NewTerm returns a Term.

func (*Term) UnmarshalJSON added in v8.7.1 

func (s *Term) UnmarshalJSON(data []byte) error

type TermQuery 

type TermQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// CaseInsensitive Allows ASCII case insensitive matching of the value with the indexed field
	// values when set to `true`.
	// When `false`, the case sensitivity of matching depends on the underlying
	// field’s mapping.
	CaseInsensitive *bool   `json:"case_insensitive,omitempty"`
	QueryName_      *string `json:"_name,omitempty"`
	// Value Term you wish to find in the provided field.
	Value FieldValue `json:"value"`
}

TermQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L238-L255

func NewTermQuery added in v8.5.0 

func NewTermQuery() *TermQuery

NewTermQuery returns a TermQuery.

func (*TermQuery) UnmarshalJSON added in v8.7.1 

func (s *TermQuery) UnmarshalJSON(data []byte) error

type TermRangeQuery added in v8.15.0 

type TermRangeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	From  *string  `json:"from,omitempty"`
	// Gt Greater than.
	Gt *string `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte *string `json:"gte,omitempty"`
	// Lt Less than.
	Lt *string `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        *string `json:"lte,omitempty"`
	QueryName_ *string `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	To       *string                      `json:"to,omitempty"`
}

TermRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L174-L174

func NewTermRangeQuery added in v8.15.0 

func NewTermRangeQuery() *TermRangeQuery

NewTermRangeQuery returns a TermRangeQuery.

func (*TermRangeQuery) UnmarshalJSON added in v8.15.0 

func (s *TermRangeQuery) UnmarshalJSON(data []byte) error

type TermSuggest 

type TermSuggest struct {
	Length  int                 `json:"length"`
	Offset  int                 `json:"offset"`
	Options []TermSuggestOption `json:"options"`
	Text    string              `json:"text"`
}

TermSuggest type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L64-L69

func NewTermSuggest added in v8.5.0 

func NewTermSuggest() *TermSuggest

NewTermSuggest returns a TermSuggest.

func (*TermSuggest) UnmarshalJSON added in v8.7.1 

func (s *TermSuggest) UnmarshalJSON(data []byte) error

type TermSuggestOption 

type TermSuggestOption struct {
	CollateMatch *bool   `json:"collate_match,omitempty"`
	Freq         int64   `json:"freq"`
	Highlighted  *string `json:"highlighted,omitempty"`
	Score        Float64 `json:"score"`
	Text         string  `json:"text"`
}

TermSuggestOption type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L93-L99

func NewTermSuggestOption added in v8.5.0 

func NewTermSuggestOption() *TermSuggestOption

NewTermSuggestOption returns a TermSuggestOption.

func (*TermSuggestOption) UnmarshalJSON added in v8.7.1 

func (s *TermSuggestOption) UnmarshalJSON(data []byte) error

type TermSuggester 

type TermSuggester struct {
	// Analyzer The analyzer to analyze the suggest text with.
	// Defaults to the search analyzer of the suggest field.
	Analyzer *string `json:"analyzer,omitempty"`
	// Field The field to fetch the candidate suggestions from.
	// Needs to be set globally or per suggestion.
	Field          string `json:"field"`
	LowercaseTerms *bool  `json:"lowercase_terms,omitempty"`
	// MaxEdits The maximum edit distance candidate suggestions can have in order to be
	// considered as a suggestion.
	// Can only be `1` or `2`.
	MaxEdits *int `json:"max_edits,omitempty"`
	// MaxInspections A factor that is used to multiply with the shard_size in order to inspect
	// more candidate spelling corrections on the shard level.
	// Can improve accuracy at the cost of performance.
	MaxInspections *int `json:"max_inspections,omitempty"`
	// MaxTermFreq The maximum threshold in number of documents in which a suggest text token
	// can exist in order to be included.
	// Can be a relative percentage number (for example `0.4`) or an absolute number
	// to represent document frequencies.
	// If a value higher than 1 is specified, then fractional can not be specified.
	MaxTermFreq *float32 `json:"max_term_freq,omitempty"`
	// MinDocFreq The minimal threshold in number of documents a suggestion should appear in.
	// This can improve quality by only suggesting high frequency terms.
	// Can be specified as an absolute number or as a relative percentage of number
	// of documents.
	// If a value higher than 1 is specified, then the number cannot be fractional.
	MinDocFreq *float32 `json:"min_doc_freq,omitempty"`
	// MinWordLength The minimum length a suggest text term must have in order to be included.
	MinWordLength *int `json:"min_word_length,omitempty"`
	// PrefixLength The number of minimal prefix characters that must match in order be a
	// candidate for suggestions.
	// Increasing this number improves spellcheck performance.
	PrefixLength *int `json:"prefix_length,omitempty"`
	// ShardSize Sets the maximum number of suggestions to be retrieved from each individual
	// shard.
	ShardSize *int `json:"shard_size,omitempty"`
	// Size The maximum corrections to be returned per suggest text token.
	Size *int `json:"size,omitempty"`
	// Sort Defines how suggestions should be sorted per suggest text term.
	Sort *suggestsort.SuggestSort `json:"sort,omitempty"`
	// StringDistance The string distance implementation to use for comparing how similar suggested
	// terms are.
	StringDistance *stringdistance.StringDistance `json:"string_distance,omitempty"`
	// SuggestMode Controls what suggestions are included or controls for what suggest text
	// terms, suggestions should be suggested.
	SuggestMode *suggestmode.SuggestMode `json:"suggest_mode,omitempty"`
	// Text The suggest text.
	// Needs to be set globally or per suggestion.
	Text *string `json:"text,omitempty"`
}

TermSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/suggester.ts#L506-L568

func NewTermSuggester added in v8.5.0 

func NewTermSuggester() *TermSuggester

NewTermSuggester returns a TermSuggester.

func (*TermSuggester) UnmarshalJSON added in v8.7.1 

func (s *TermSuggester) UnmarshalJSON(data []byte) error

type TermVector 

type TermVector struct {
	FieldStatistics *FieldStatistics `json:"field_statistics,omitempty"`
	Terms           map[string]Term  `json:"terms"`
}

TermVector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/termvectors/types.ts#L23-L26

func NewTermVector added in v8.5.0 

func NewTermVector() *TermVector

NewTermVector returns a TermVector.

type TermVectorsFilter added in v8.5.0 

type TermVectorsFilter struct {
	// MaxDocFreq Ignore words which occur in more than this many docs.
	// Defaults to unbounded.
	MaxDocFreq *int `json:"max_doc_freq,omitempty"`
	// MaxNumTerms The maximum number of terms that must be returned per field.
	MaxNumTerms *int `json:"max_num_terms,omitempty"`
	// MaxTermFreq Ignore words with more than this frequency in the source doc.
	// It defaults to unbounded.
	MaxTermFreq *int `json:"max_term_freq,omitempty"`
	// MaxWordLength The maximum word length above which words will be ignored.
	// Defaults to unbounded.
	MaxWordLength *int `json:"max_word_length,omitempty"`
	// MinDocFreq Ignore terms which do not occur in at least this many docs.
	MinDocFreq *int `json:"min_doc_freq,omitempty"`
	// MinTermFreq Ignore words with less than this frequency in the source doc.
	MinTermFreq *int `json:"min_term_freq,omitempty"`
	// MinWordLength The minimum word length below which words will be ignored.
	MinWordLength *int `json:"min_word_length,omitempty"`
}

TermVectorsFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/termvectors/types.ts#L49-L86

func NewTermVectorsFilter added in v8.5.0 

func NewTermVectorsFilter() *TermVectorsFilter

NewTermVectorsFilter returns a TermVectorsFilter.

func (*TermVectorsFilter) UnmarshalJSON added in v8.7.1 

func (s *TermVectorsFilter) UnmarshalJSON(data []byte) error

type TermVectorsResult 

type TermVectorsResult struct {
	Error       *ErrorCause           `json:"error,omitempty"`
	Found       *bool                 `json:"found,omitempty"`
	Id_         *string               `json:"_id,omitempty"`
	Index_      string                `json:"_index"`
	TermVectors map[string]TermVector `json:"term_vectors,omitempty"`
	Took        *int64                `json:"took,omitempty"`
	Version_    *int64                `json:"_version,omitempty"`
}

TermVectorsResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/mtermvectors/types.ts#L96-L104

func NewTermVectorsResult added in v8.5.0 

func NewTermVectorsResult() *TermVectorsResult

NewTermVectorsResult returns a TermVectorsResult.

func (*TermVectorsResult) UnmarshalJSON added in v8.7.1 

func (s *TermVectorsResult) UnmarshalJSON(data []byte) error

type TermVectorsToken added in v8.5.0 

type TermVectorsToken struct {
	EndOffset   *int    `json:"end_offset,omitempty"`
	Payload     *string `json:"payload,omitempty"`
	Position    int     `json:"position"`
	StartOffset *int    `json:"start_offset,omitempty"`
}

TermVectorsToken type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/termvectors/types.ts#L42-L47

func NewTermVectorsToken added in v8.5.0 

func NewTermVectorsToken() *TermVectorsToken

NewTermVectorsToken returns a TermVectorsToken.

func (*TermVectorsToken) UnmarshalJSON added in v8.7.1 

func (s *TermVectorsToken) UnmarshalJSON(data []byte) error

type TerminateProcessor added in v8.16.0 

type TerminateProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
}

TerminateProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1541-L1541

func NewTerminateProcessor added in v8.16.0 

func NewTerminateProcessor() *TerminateProcessor

NewTerminateProcessor returns a TerminateProcessor.

func (*TerminateProcessor) UnmarshalJSON added in v8.16.0 

func (s *TerminateProcessor) UnmarshalJSON(data []byte) error

type TermsAggregateBaseDoubleTermsBucket 

type TermsAggregateBaseDoubleTermsBucket struct {
	Buckets                 BucketsDoubleTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                 `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseDoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L417-L422

func NewTermsAggregateBaseDoubleTermsBucket added in v8.5.0 

func NewTermsAggregateBaseDoubleTermsBucket() *TermsAggregateBaseDoubleTermsBucket

NewTermsAggregateBaseDoubleTermsBucket returns a TermsAggregateBaseDoubleTermsBucket.

func (*TermsAggregateBaseDoubleTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregateBaseDoubleTermsBucket) UnmarshalJSON(data []byte) error

type TermsAggregateBaseLongTermsBucket 

type TermsAggregateBaseLongTermsBucket struct {
	Buckets                 BucketsLongTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata               `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L417-L422

func NewTermsAggregateBaseLongTermsBucket added in v8.5.0 

func NewTermsAggregateBaseLongTermsBucket() *TermsAggregateBaseLongTermsBucket

NewTermsAggregateBaseLongTermsBucket returns a TermsAggregateBaseLongTermsBucket.

func (*TermsAggregateBaseLongTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregateBaseLongTermsBucket) UnmarshalJSON(data []byte) error

type TermsAggregateBaseMultiTermsBucket 

type TermsAggregateBaseMultiTermsBucket struct {
	Buckets                 BucketsMultiTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                  `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                `json:"meta,omitempty"`
	SumOtherDocCount        *int64                  `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseMultiTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L417-L422

func NewTermsAggregateBaseMultiTermsBucket added in v8.5.0 

func NewTermsAggregateBaseMultiTermsBucket() *TermsAggregateBaseMultiTermsBucket

NewTermsAggregateBaseMultiTermsBucket returns a TermsAggregateBaseMultiTermsBucket.

func (*TermsAggregateBaseMultiTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregateBaseMultiTermsBucket) UnmarshalJSON(data []byte) error

type TermsAggregateBaseStringTermsBucket 

type TermsAggregateBaseStringTermsBucket struct {
	Buckets                 BucketsStringTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata                 `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L417-L422

func NewTermsAggregateBaseStringTermsBucket added in v8.5.0 

func NewTermsAggregateBaseStringTermsBucket() *TermsAggregateBaseStringTermsBucket

NewTermsAggregateBaseStringTermsBucket returns a TermsAggregateBaseStringTermsBucket.

func (*TermsAggregateBaseStringTermsBucket) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregateBaseStringTermsBucket) UnmarshalJSON(data []byte) error

type TermsAggregateBaseVoid 

type TermsAggregateBaseVoid struct {
	Buckets                 BucketsVoid `json:"buckets"`
	DocCountErrorUpperBound *int64      `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata    `json:"meta,omitempty"`
	SumOtherDocCount        *int64      `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L417-L422

func NewTermsAggregateBaseVoid added in v8.5.0 

func NewTermsAggregateBaseVoid() *TermsAggregateBaseVoid

NewTermsAggregateBaseVoid returns a TermsAggregateBaseVoid.

func (*TermsAggregateBaseVoid) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregateBaseVoid) UnmarshalJSON(data []byte) error

type TermsAggregation 

type TermsAggregation struct {
	// CollectMode Determines how child aggregations should be calculated: breadth-first or
	// depth-first.
	CollectMode *termsaggregationcollectmode.TermsAggregationCollectMode `json:"collect_mode,omitempty"`
	// Exclude Values to exclude.
	// Accepts regular expressions and partitions.
	Exclude []string `json:"exclude,omitempty"`
	// ExecutionHint Determines whether the aggregation will use field values directly or global
	// ordinals.
	ExecutionHint *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	// Field The field from which to return terms.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Include Values to include.
	// Accepts regular expressions and partitions.
	Include TermsInclude `json:"include,omitempty"`
	// MinDocCount Only return values that are found in more than `min_doc_count` hits.
	MinDocCount *int `json:"min_doc_count,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing       Missing                    `json:"missing,omitempty"`
	MissingBucket *bool                      `json:"missing_bucket,omitempty"`
	MissingOrder  *missingorder.MissingOrder `json:"missing_order,omitempty"`
	// Order Specifies the sort order of the buckets.
	// Defaults to sorting by descending document count.
	Order  AggregateOrder `json:"order,omitempty"`
	Script *Script        `json:"script,omitempty"`
	// ShardMinDocCount Regulates the certainty a shard has if the term should actually be added to
	// the candidate list or not with respect to the `min_doc_count`.
	// Terms will only be considered if their local shard frequency within the set
	// is higher than the `shard_min_doc_count`.
	ShardMinDocCount *int64 `json:"shard_min_doc_count,omitempty"`
	// ShardSize The number of candidate terms produced by each shard.
	// By default, `shard_size` will be automatically estimated based on the number
	// of shards and the `size` parameter.
	ShardSize *int `json:"shard_size,omitempty"`
	// ShowTermDocCountError Set to `true` to return the `doc_count_error_upper_bound`, which is an upper
	// bound to the error on the `doc_count` returned by each shard.
	ShowTermDocCountError *bool `json:"show_term_doc_count_error,omitempty"`
	// Size The number of buckets returned out of the overall terms list.
	Size *int `json:"size,omitempty"`
	// ValueType Coerced unmapped fields into the specified type.
	ValueType *string `json:"value_type,omitempty"`
}

TermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L963-L1031

func NewTermsAggregation added in v8.5.0 

func NewTermsAggregation() *TermsAggregation

NewTermsAggregation returns a TermsAggregation.

func (*TermsAggregation) UnmarshalJSON added in v8.7.0 

func (s *TermsAggregation) UnmarshalJSON(data []byte) error

type TermsExclude 

type TermsExclude []string

TermsExclude type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1077-L1078

type TermsGrouping 

type TermsGrouping struct {
	// Fields The set of fields that you wish to collect terms for.
	// This array can contain fields that are both keyword and numerics.
	// Order does not matter.
	Fields []string `json:"fields"`
}

TermsGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/rollup/_types/Groupings.ts#L75-L82

func NewTermsGrouping added in v8.5.0 

func NewTermsGrouping() *TermsGrouping

NewTermsGrouping returns a TermsGrouping.

func (*TermsGrouping) UnmarshalJSON added in v8.7.1 

func (s *TermsGrouping) UnmarshalJSON(data []byte) error

type TermsInclude 

type TermsInclude any

TermsInclude holds the union for the following types: 

string
[]string
TermsPartition

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1074-L1075

type TermsLookup 

type TermsLookup struct {
	Id      string  `json:"id"`
	Index   string  `json:"index"`
	Path    string  `json:"path"`
	Routing *string `json:"routing,omitempty"`
}

TermsLookup type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L270-L275

func NewTermsLookup added in v8.5.0 

func NewTermsLookup() *TermsLookup

NewTermsLookup returns a TermsLookup.

func (*TermsLookup) UnmarshalJSON added in v8.7.1 

func (s *TermsLookup) UnmarshalJSON(data []byte) error

type TermsPartition 

type TermsPartition struct {
	// NumPartitions The number of partitions.
	NumPartitions int64 `json:"num_partitions"`
	// Partition The partition number for this request.
	Partition int64 `json:"partition"`
}

TermsPartition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1080-L1089

func NewTermsPartition added in v8.5.0 

func NewTermsPartition() *TermsPartition

NewTermsPartition returns a TermsPartition.

func (*TermsPartition) UnmarshalJSON added in v8.7.1 

func (s *TermsPartition) UnmarshalJSON(data []byte) error

type TermsQuery 

type TermsQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32                   `json:"boost,omitempty"`
	QueryName_ *string                    `json:"_name,omitempty"`
	TermsQuery map[string]TermsQueryField `json:"-"`
}

TermsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L257-L263

func NewTermsQuery added in v8.5.0 

func NewTermsQuery() *TermsQuery

NewTermsQuery returns a TermsQuery.

func (TermsQuery) MarshalJSON 

func (s TermsQuery) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*TermsQuery) UnmarshalJSON added in v8.7.1 

func (s *TermsQuery) UnmarshalJSON(data []byte) error

type TermsQueryField 

type TermsQueryField any

TermsQueryField holds the union for the following types: 

[]FieldValue
TermsLookup

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L265-L268

type TermsSetQuery 

type TermsSetQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// MinimumShouldMatch Specification describing number of matching terms required to return a
	// document.
	MinimumShouldMatch MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	// MinimumShouldMatchField Numeric field containing the number of matching terms required to return a
	// document.
	MinimumShouldMatchField *string `json:"minimum_should_match_field,omitempty"`
	// MinimumShouldMatchScript Custom script containing the number of matching terms required to return a
	// document.
	MinimumShouldMatchScript *Script `json:"minimum_should_match_script,omitempty"`
	QueryName_               *string `json:"_name,omitempty"`
	// Terms Array of terms you wish to find in the provided field.
	Terms []string `json:"terms"`
}

TermsSetQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L277-L299

func NewTermsSetQuery added in v8.5.0 

func NewTermsSetQuery() *TermsSetQuery

NewTermsSetQuery returns a TermsSetQuery.

func (*TermsSetQuery) UnmarshalJSON added in v8.7.1 

func (s *TermsSetQuery) UnmarshalJSON(data []byte) error

type TestPopulation 

type TestPopulation struct {
	// Field The field to aggregate.
	Field string `json:"field"`
	// Filter A filter used to define a set of records to run unpaired t-test on.
	Filter *Query  `json:"filter,omitempty"`
	Script *Script `json:"script,omitempty"`
}

TestPopulation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L319-L329

func NewTestPopulation added in v8.5.0 

func NewTestPopulation() *TestPopulation

NewTestPopulation returns a TestPopulation.

func (*TestPopulation) UnmarshalJSON added in v8.7.1 

func (s *TestPopulation) UnmarshalJSON(data []byte) error

type TextClassificationInferenceOptions 

type TextClassificationInferenceOptions struct {
	// ClassificationLabels Classification labels to apply other than the stored labels. Must have the
	// same deminsions as the default configured labels
	ClassificationLabels []string `json:"classification_labels,omitempty"`
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   *Vocabulary                  `json:"vocabulary,omitempty"`
}

TextClassificationInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L202-L214

func NewTextClassificationInferenceOptions added in v8.5.0 

func NewTextClassificationInferenceOptions() *TextClassificationInferenceOptions

NewTextClassificationInferenceOptions returns a TextClassificationInferenceOptions.

func (*TextClassificationInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *TextClassificationInferenceOptions) UnmarshalJSON(data []byte) error

type TextClassificationInferenceUpdateOptions 

type TextClassificationInferenceUpdateOptions struct {
	// ClassificationLabels Classification labels to apply other than the stored labels. Must have the
	// same deminsions as the default configured labels
	ClassificationLabels []string `json:"classification_labels,omitempty"`
	// NumTopClasses Specifies the number of top class predictions to return. Defaults to 0.
	NumTopClasses *int `json:"num_top_classes,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

TextClassificationInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L382-L391

func NewTextClassificationInferenceUpdateOptions added in v8.5.0 

func NewTextClassificationInferenceUpdateOptions() *TextClassificationInferenceUpdateOptions

NewTextClassificationInferenceUpdateOptions returns a TextClassificationInferenceUpdateOptions.

func (*TextClassificationInferenceUpdateOptions) UnmarshalJSON added in v8.7.1 

func (s *TextClassificationInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type TextEmbedding added in v8.7.0 

type TextEmbedding struct {
	ModelId   string `json:"model_id"`
	ModelText string `json:"model_text"`
}

TextEmbedding type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Knn.ts#L94-L97

func NewTextEmbedding added in v8.7.0 

func NewTextEmbedding() *TextEmbedding

NewTextEmbedding returns a TextEmbedding.

func (*TextEmbedding) UnmarshalJSON added in v8.9.0 

func (s *TextEmbedding) UnmarshalJSON(data []byte) error

type TextEmbeddingByteResult added in v8.13.0 

type TextEmbeddingByteResult struct {
	Embedding []byte `json:"embedding"`
}

TextEmbeddingByteResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L53-L58

func NewTextEmbeddingByteResult added in v8.13.0 

func NewTextEmbeddingByteResult() *TextEmbeddingByteResult

NewTextEmbeddingByteResult returns a TextEmbeddingByteResult.

func (*TextEmbeddingByteResult) UnmarshalJSON added in v8.13.0 

func (s *TextEmbeddingByteResult) UnmarshalJSON(data []byte) error

type TextEmbeddingInferenceOptions 

type TextEmbeddingInferenceOptions struct {
	// EmbeddingSize The number of dimensions in the embedding output
	EmbeddingSize *int `json:"embedding_size,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   Vocabulary                   `json:"vocabulary"`
}

TextEmbeddingInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L252-L262

func NewTextEmbeddingInferenceOptions added in v8.5.0 

func NewTextEmbeddingInferenceOptions() *TextEmbeddingInferenceOptions

NewTextEmbeddingInferenceOptions returns a TextEmbeddingInferenceOptions.

func (*TextEmbeddingInferenceOptions) UnmarshalJSON added in v8.8.0 

func (s *TextEmbeddingInferenceOptions) UnmarshalJSON(data []byte) error

type TextEmbeddingInferenceResult added in v8.18.1 

type TextEmbeddingInferenceResult struct {
	TextEmbedding      []TextEmbeddingResult     `json:"text_embedding,omitempty"`
	TextEmbeddingBytes []TextEmbeddingByteResult `json:"text_embedding_bytes,omitempty"`
}

TextEmbeddingInferenceResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L67-L74

func NewTextEmbeddingInferenceResult added in v8.18.1 

func NewTextEmbeddingInferenceResult() *TextEmbeddingInferenceResult

NewTextEmbeddingInferenceResult returns a TextEmbeddingInferenceResult.

type TextEmbeddingInferenceUpdateOptions 

type TextEmbeddingInferenceUpdateOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string                       `json:"results_field,omitempty"`
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

TextEmbeddingInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L411-L415

func NewTextEmbeddingInferenceUpdateOptions added in v8.5.0 

func NewTextEmbeddingInferenceUpdateOptions() *TextEmbeddingInferenceUpdateOptions

NewTextEmbeddingInferenceUpdateOptions returns a TextEmbeddingInferenceUpdateOptions.

func (*TextEmbeddingInferenceUpdateOptions) UnmarshalJSON added in v8.9.0 

func (s *TextEmbeddingInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type TextEmbeddingResult added in v8.12.0 

type TextEmbeddingResult struct {
	Embedding []float32 `json:"embedding"`
}

TextEmbeddingResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/Results.ts#L60-L65

func NewTextEmbeddingResult added in v8.12.0 

func NewTextEmbeddingResult() *TextEmbeddingResult

NewTextEmbeddingResult returns a TextEmbeddingResult.

func (*TextEmbeddingResult) UnmarshalJSON added in v8.12.0 

func (s *TextEmbeddingResult) UnmarshalJSON(data []byte) error

type TextExpansionInferenceOptions added in v8.8.0 

type TextExpansionInferenceOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
	Vocabulary   Vocabulary                   `json:"vocabulary"`
}

TextExpansionInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L264-L271

func NewTextExpansionInferenceOptions added in v8.8.0 

func NewTextExpansionInferenceOptions() *TextExpansionInferenceOptions

NewTextExpansionInferenceOptions returns a TextExpansionInferenceOptions.

func (*TextExpansionInferenceOptions) UnmarshalJSON added in v8.9.0 

func (s *TextExpansionInferenceOptions) UnmarshalJSON(data []byte) error

type TextExpansionInferenceUpdateOptions added in v8.8.0 

type TextExpansionInferenceUpdateOptions struct {
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string                       `json:"results_field,omitempty"`
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

TextExpansionInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L417-L421

func NewTextExpansionInferenceUpdateOptions added in v8.8.0 

func NewTextExpansionInferenceUpdateOptions() *TextExpansionInferenceUpdateOptions

NewTextExpansionInferenceUpdateOptions returns a TextExpansionInferenceUpdateOptions.

func (*TextExpansionInferenceUpdateOptions) UnmarshalJSON added in v8.9.0 

func (s *TextExpansionInferenceUpdateOptions) UnmarshalJSON(data []byte) error

type TextExpansionQuery added in v8.8.0 

type TextExpansionQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// ModelId The text expansion NLP model to use
	ModelId string `json:"model_id"`
	// ModelText The query text
	ModelText string `json:"model_text"`
	// PruningConfig Token pruning configurations
	PruningConfig *TokenPruningConfig `json:"pruning_config,omitempty"`
	QueryName_    *string             `json:"_name,omitempty"`
}

TextExpansionQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/TextExpansionQuery.ts#L23-L36

func NewTextExpansionQuery added in v8.8.0 

func NewTextExpansionQuery() *TextExpansionQuery

NewTextExpansionQuery returns a TextExpansionQuery.

func (*TextExpansionQuery) UnmarshalJSON added in v8.8.0 

func (s *TextExpansionQuery) UnmarshalJSON(data []byte) error

type TextIndexPrefixes 

type TextIndexPrefixes struct {
	MaxChars int `json:"max_chars"`
	MinChars int `json:"min_chars"`
}

TextIndexPrefixes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L290-L293

func NewTextIndexPrefixes added in v8.5.0 

func NewTextIndexPrefixes() *TextIndexPrefixes

NewTextIndexPrefixes returns a TextIndexPrefixes.

func (*TextIndexPrefixes) UnmarshalJSON added in v8.7.1 

func (s *TextIndexPrefixes) UnmarshalJSON(data []byte) error

type TextProperty 

type TextProperty struct {
	Analyzer                 *string                        `json:"analyzer,omitempty"`
	Boost                    *Float64                       `json:"boost,omitempty"`
	CopyTo                   []string                       `json:"copy_to,omitempty"`
	Dynamic                  *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EagerGlobalOrdinals      *bool                          `json:"eager_global_ordinals,omitempty"`
	Fielddata                *bool                          `json:"fielddata,omitempty"`
	FielddataFrequencyFilter *FielddataFrequencyFilter      `json:"fielddata_frequency_filter,omitempty"`
	Fields                   map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove              *int                           `json:"ignore_above,omitempty"`
	Index                    *bool                          `json:"index,omitempty"`
	IndexOptions             *indexoptions.IndexOptions     `json:"index_options,omitempty"`
	IndexPhrases             *bool                          `json:"index_phrases,omitempty"`
	IndexPrefixes            *TextIndexPrefixes             `json:"index_prefixes,omitempty"`
	// Meta Metadata about the field.
	Meta                 map[string]string                                `json:"meta,omitempty"`
	Norms                *bool                                            `json:"norms,omitempty"`
	PositionIncrementGap *int                                             `json:"position_increment_gap,omitempty"`
	Properties           map[string]Property                              `json:"properties,omitempty"`
	SearchAnalyzer       *string                                          `json:"search_analyzer,omitempty"`
	SearchQuoteAnalyzer  *string                                          `json:"search_quote_analyzer,omitempty"`
	Similarity           *string                                          `json:"similarity,omitempty"`
	Store                *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep  *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	TermVector           *termvectoroption.TermVectorOption               `json:"term_vector,omitempty"`
	Type                 string                                           `json:"type,omitempty"`
}

TextProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L295-L312

func NewTextProperty added in v8.5.0 

func NewTextProperty() *TextProperty

NewTextProperty returns a TextProperty.

func (TextProperty) MarshalJSON added in v8.9.0 

func (s TextProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*TextProperty) UnmarshalJSON added in v8.7.0 

func (s *TextProperty) UnmarshalJSON(data []byte) error

type TextSimilarityReranker added in v8.16.0 

type TextSimilarityReranker struct {
	// Field The document field to be used for text similarity comparisons. This field
	// should contain the text that will be evaluated against the inference_text
	Field *string `json:"field,omitempty"`
	// Filter Query to filter the documents that can match.
	Filter []Query `json:"filter,omitempty"`
	// InferenceId Unique identifier of the inference endpoint created using the inference API.
	InferenceId *string `json:"inference_id,omitempty"`
	// InferenceText The text snippet used as the basis for similarity comparison
	InferenceText *string `json:"inference_text,omitempty"`
	// MinScore Minimum _score for matching documents. Documents with a lower _score are not
	// included in the top documents.
	MinScore *float32 `json:"min_score,omitempty"`
	// Name_ Retriever name.
	Name_ *string `json:"_name,omitempty"`
	// RankWindowSize This value determines how many documents we will consider from the nested
	// retriever.
	RankWindowSize *int `json:"rank_window_size,omitempty"`
	// Retriever The nested retriever which will produce the first-level results, that will
	// later be used for reranking.
	Retriever *RetrieverContainer `json:"retriever,omitempty"`
}

TextSimilarityReranker type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Retriever.ts#L140-L151

func NewTextSimilarityReranker added in v8.16.0 

func NewTextSimilarityReranker() *TextSimilarityReranker

NewTextSimilarityReranker returns a TextSimilarityReranker.

func (*TextSimilarityReranker) UnmarshalJSON added in v8.16.0 

func (s *TextSimilarityReranker) UnmarshalJSON(data []byte) error

type TextToAnalyze 

type TextToAnalyze []string

TextToAnalyze type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L69-L69

type ThaiAnalyzer added in v8.16.0 

type ThaiAnalyzer struct {
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

ThaiAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L297-L301

func NewThaiAnalyzer added in v8.16.0 

func NewThaiAnalyzer() *ThaiAnalyzer

NewThaiAnalyzer returns a ThaiAnalyzer.

func (ThaiAnalyzer) MarshalJSON added in v8.16.0 

func (s ThaiAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ThaiAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *ThaiAnalyzer) UnmarshalJSON(data []byte) error

type ThaiTokenizer added in v8.16.0 

type ThaiTokenizer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

ThaiTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L126-L128

func NewThaiTokenizer added in v8.16.0 

func NewThaiTokenizer() *ThaiTokenizer

NewThaiTokenizer returns a ThaiTokenizer.

func (ThaiTokenizer) MarshalJSON added in v8.16.0 

func (s ThaiTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*ThaiTokenizer) UnmarshalJSON added in v8.16.0 

func (s *ThaiTokenizer) UnmarshalJSON(data []byte) error

type ThreadCount 

type ThreadCount struct {
	// Active Number of active threads in the thread pool.
	Active *int64 `json:"active,omitempty"`
	// Completed Number of tasks completed by the thread pool executor.
	Completed *int64 `json:"completed,omitempty"`
	// Largest Highest number of active threads in the thread pool.
	Largest *int64 `json:"largest,omitempty"`
	// Queue Number of tasks in queue for the thread pool.
	Queue *int64 `json:"queue,omitempty"`
	// Rejected Number of tasks rejected by the thread pool executor.
	Rejected *int64 `json:"rejected,omitempty"`
	// Threads Number of threads in the thread pool.
	Threads *int64 `json:"threads,omitempty"`
}

ThreadCount type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1075-L1100

func NewThreadCount added in v8.5.0 

func NewThreadCount() *ThreadCount

NewThreadCount returns a ThreadCount.

func (*ThreadCount) UnmarshalJSON added in v8.7.1 

func (s *ThreadCount) UnmarshalJSON(data []byte) error

type ThreadPoolRecord 

type ThreadPoolRecord struct {
	// Active The number of active threads in the current thread pool.
	Active *string `json:"active,omitempty"`
	// Completed The number of completed tasks.
	Completed *string `json:"completed,omitempty"`
	// Core The core number of active threads allowed in a scaling thread pool.
	Core *string `json:"core,omitempty"`
	// EphemeralNodeId The ephemeral node identifier.
	EphemeralNodeId *string `json:"ephemeral_node_id,omitempty"`
	// Host The host name for the current node.
	Host *string `json:"host,omitempty"`
	// Ip The IP address for the current node.
	Ip *string `json:"ip,omitempty"`
	// KeepAlive The thread keep alive time.
	KeepAlive *string `json:"keep_alive,omitempty"`
	// Largest The highest number of active threads in the current thread pool.
	Largest *string `json:"largest,omitempty"`
	// Max The maximum number of active threads allowed in a scaling thread pool.
	Max *string `json:"max,omitempty"`
	// Name The thread pool name.
	Name *string `json:"name,omitempty"`
	// NodeId The persistent node identifier.
	NodeId *string `json:"node_id,omitempty"`
	// NodeName The node name.
	NodeName *string `json:"node_name,omitempty"`
	// Pid The process identifier.
	Pid *string `json:"pid,omitempty"`
	// PoolSize The number of threads in the current thread pool.
	PoolSize *string `json:"pool_size,omitempty"`
	// Port The bound transport port for the current node.
	Port *string `json:"port,omitempty"`
	// Queue The number of tasks currently in queue.
	Queue *string `json:"queue,omitempty"`
	// QueueSize The maximum number of tasks permitted in the queue.
	QueueSize *string `json:"queue_size,omitempty"`
	// Rejected The number of rejected tasks.
	Rejected *string `json:"rejected,omitempty"`
	// Size The number of active threads allowed in a fixed thread pool.
	Size *string `json:"size,omitempty"`
	// Type The thread pool type.
	// Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and
	// `scaling`.
	Type *string `json:"type,omitempty"`
}

ThreadPoolRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/thread_pool/types.ts#L22-L124

func NewThreadPoolRecord added in v8.5.0 

func NewThreadPoolRecord() *ThreadPoolRecord

NewThreadPoolRecord returns a ThreadPoolRecord.

func (*ThreadPoolRecord) UnmarshalJSON added in v8.7.1 

func (s *ThreadPoolRecord) UnmarshalJSON(data []byte) error

type ThrottleState 

type ThrottleState struct {
	Reason    string   `json:"reason"`
	Timestamp DateTime `json:"timestamp"`
}

ThrottleState type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L120-L123

func NewThrottleState added in v8.5.0 

func NewThrottleState() *ThrottleState

NewThrottleState returns a ThrottleState.

func (*ThrottleState) UnmarshalJSON added in v8.7.1 

func (s *ThrottleState) UnmarshalJSON(data []byte) error

type TimeHttpHistogram added in v8.16.0 

type TimeHttpHistogram struct {
	Count    int64  `json:"count"`
	GeMillis *int64 `json:"ge_millis,omitempty"`
	LtMillis *int64 `json:"lt_millis,omitempty"`
}

TimeHttpHistogram type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L708-L712

func NewTimeHttpHistogram added in v8.16.0 

func NewTimeHttpHistogram() *TimeHttpHistogram

NewTimeHttpHistogram returns a TimeHttpHistogram.

func (*TimeHttpHistogram) UnmarshalJSON added in v8.16.0 

func (s *TimeHttpHistogram) UnmarshalJSON(data []byte) error

type TimeOfMonth 

type TimeOfMonth struct {
	At []string `json:"at"`
	On []int    `json:"on"`
}

TimeOfMonth type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L111-L114

func NewTimeOfMonth added in v8.5.0 

func NewTimeOfMonth() *TimeOfMonth

NewTimeOfMonth returns a TimeOfMonth.

type TimeOfWeek 

type TimeOfWeek struct {
	At []string  `json:"at"`
	On []day.Day `json:"on"`
}

TimeOfWeek type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L116-L119

func NewTimeOfWeek added in v8.5.0 

func NewTimeOfWeek() *TimeOfWeek

NewTimeOfWeek returns a TimeOfWeek.

type TimeOfYear 

type TimeOfYear struct {
	At  []string      `json:"at"`
	Int []month.Month `json:"int"`
	On  []int         `json:"on"`
}

TimeOfYear type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Schedule.ts#L121-L125

func NewTimeOfYear added in v8.5.0 

func NewTimeOfYear() *TimeOfYear

NewTimeOfYear returns a TimeOfYear.

type TimeSeriesAggregate added in v8.16.0 

type TimeSeriesAggregate struct {
	Buckets BucketsTimeSeriesBucket `json:"buckets"`
	Meta    Metadata                `json:"meta,omitempty"`
}

TimeSeriesAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L730-L731

func NewTimeSeriesAggregate added in v8.16.0 

func NewTimeSeriesAggregate() *TimeSeriesAggregate

NewTimeSeriesAggregate returns a TimeSeriesAggregate.

func (*TimeSeriesAggregate) UnmarshalJSON added in v8.16.0 

func (s *TimeSeriesAggregate) UnmarshalJSON(data []byte) error

type TimeSeriesAggregation added in v8.16.0 

type TimeSeriesAggregation struct {
	// Keyed Set to `true` to associate a unique string key with each bucket and returns
	// the ranges as a hash rather than an array.
	Keyed *bool `json:"keyed,omitempty"`
	// Size The maximum number of results to return.
	Size *int `json:"size,omitempty"`
}

TimeSeriesAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1033-L1046

func NewTimeSeriesAggregation added in v8.16.0 

func NewTimeSeriesAggregation() *TimeSeriesAggregation

NewTimeSeriesAggregation returns a TimeSeriesAggregation.

func (*TimeSeriesAggregation) UnmarshalJSON added in v8.16.0 

func (s *TimeSeriesAggregation) UnmarshalJSON(data []byte) error

type TimeSeriesBucket added in v8.16.0 

type TimeSeriesBucket struct {
	Aggregations map[string]Aggregate  `json:"-"`
	DocCount     int64                 `json:"doc_count"`
	Key          map[string]FieldValue `json:"key"`
}

TimeSeriesBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L733-L735

func NewTimeSeriesBucket added in v8.16.0 

func NewTimeSeriesBucket() *TimeSeriesBucket

NewTimeSeriesBucket returns a TimeSeriesBucket.

func (TimeSeriesBucket) MarshalJSON added in v8.16.0 

func (s TimeSeriesBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*TimeSeriesBucket) UnmarshalJSON added in v8.16.0 

func (s *TimeSeriesBucket) UnmarshalJSON(data []byte) error

type TimeSync 

type TimeSync struct {
	// Delay The time delay between the current time and the latest input data time.
	Delay Duration `json:"delay,omitempty"`
	// Field The date field that is used to identify new documents in the source. In
	// general, it’s a good idea to use a field
	// that contains the ingest timestamp. If you use a different field, you might
	// need to set the delay such that it
	// accounts for data transmission delays.
	Field string `json:"field"`
}

TimeSync type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L177-L189

func NewTimeSync added in v8.5.0 

func NewTimeSync() *TimeSync

NewTimeSync returns a TimeSync.

func (*TimeSync) UnmarshalJSON added in v8.7.1 

func (s *TimeSync) UnmarshalJSON(data []byte) error

type TimingStats 

type TimingStats struct {
	// ElapsedTime Runtime of the analysis in milliseconds.
	ElapsedTime int64 `json:"elapsed_time"`
	// IterationTime Runtime of the latest iteration of the analysis in milliseconds.
	IterationTime *int64 `json:"iteration_time,omitempty"`
}

TimingStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L564-L569

func NewTimingStats added in v8.5.0 

func NewTimingStats() *TimingStats

NewTimingStats returns a TimingStats.

func (*TimingStats) UnmarshalJSON added in v8.7.1 

func (s *TimingStats) UnmarshalJSON(data []byte) error

type TokenCountProperty 

type TokenCountProperty struct {
	Analyzer                 *string                        `json:"analyzer,omitempty"`
	Boost                    *Float64                       `json:"boost,omitempty"`
	CopyTo                   []string                       `json:"copy_to,omitempty"`
	DocValues                *bool                          `json:"doc_values,omitempty"`
	Dynamic                  *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	EnablePositionIncrements *bool                          `json:"enable_position_increments,omitempty"`
	Fields                   map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove              *int                           `json:"ignore_above,omitempty"`
	Index                    *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *Float64                                         `json:"null_value,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

TokenCountProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/specialized.ts#L94-L101

func NewTokenCountProperty added in v8.5.0 

func NewTokenCountProperty() *TokenCountProperty

NewTokenCountProperty returns a TokenCountProperty.

func (TokenCountProperty) MarshalJSON added in v8.9.0 

func (s TokenCountProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*TokenCountProperty) UnmarshalJSON added in v8.7.0 

func (s *TokenCountProperty) UnmarshalJSON(data []byte) error

type TokenDetail 

type TokenDetail struct {
	Name   string                `json:"name"`
	Tokens []ExplainAnalyzeToken `json:"tokens"`
}

TokenDetail type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/analyze/types.ts#L71-L74

func NewTokenDetail added in v8.5.0 

func NewTokenDetail() *TokenDetail

NewTokenDetail returns a TokenDetail.

func (*TokenDetail) UnmarshalJSON added in v8.9.0 

func (s *TokenDetail) UnmarshalJSON(data []byte) error

type TokenFilter 

type TokenFilter any

TokenFilter holds the union for the following types: 

string
TokenFilterDefinition

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L538-L543

type TokenFilterDefinition 

type TokenFilterDefinition any

TokenFilterDefinition holds the union for the following types: 

ApostropheTokenFilter
ArabicNormalizationTokenFilter
AsciiFoldingTokenFilter
CjkBigramTokenFilter
CjkWidthTokenFilter
ClassicTokenFilter
CommonGramsTokenFilter
ConditionTokenFilter
DecimalDigitTokenFilter
DelimitedPayloadTokenFilter
EdgeNGramTokenFilter
ElisionTokenFilter
FingerprintTokenFilter
FlattenGraphTokenFilter
GermanNormalizationTokenFilter
HindiNormalizationTokenFilter
HunspellTokenFilter
HyphenationDecompounderTokenFilter
IndicNormalizationTokenFilter
KeepTypesTokenFilter
KeepWordsTokenFilter
KeywordMarkerTokenFilter
KeywordRepeatTokenFilter
KStemTokenFilter
LengthTokenFilter
LimitTokenCountTokenFilter
LowercaseTokenFilter
MinHashTokenFilter
MultiplexerTokenFilter
NGramTokenFilter
NoriPartOfSpeechTokenFilter
PatternCaptureTokenFilter
PatternReplaceTokenFilter
PersianNormalizationTokenFilter
PorterStemTokenFilter
PredicateTokenFilter
RemoveDuplicatesTokenFilter
ReverseTokenFilter
ScandinavianFoldingTokenFilter
ScandinavianNormalizationTokenFilter
SerbianNormalizationTokenFilter
ShingleTokenFilter
SnowballTokenFilter
SoraniNormalizationTokenFilter
StemmerOverrideTokenFilter
StemmerTokenFilter
StopTokenFilter
SynonymGraphTokenFilter
SynonymTokenFilter
TrimTokenFilter
TruncateTokenFilter
UniqueTokenFilter
UppercaseTokenFilter
WordDelimiterGraphTokenFilter
WordDelimiterTokenFilter
JaStopTokenFilter
KuromojiStemmerTokenFilter
KuromojiReadingFormTokenFilter
KuromojiPartOfSpeechTokenFilter
IcuCollationTokenFilter
IcuFoldingTokenFilter
IcuNormalizationTokenFilter
IcuTransformTokenFilter
PhoneticTokenFilter
DictionaryDecompounderTokenFilter

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L545-L614

type TokenPruningConfig added in v8.13.0 

type TokenPruningConfig struct {
	// OnlyScorePrunedTokens Whether to only score pruned tokens, vs only scoring kept tokens.
	OnlyScorePrunedTokens *bool `json:"only_score_pruned_tokens,omitempty"`
	// TokensFreqRatioThreshold Tokens whose frequency is more than this threshold times the average
	// frequency of all tokens in the specified field are considered outliers and
	// pruned.
	TokensFreqRatioThreshold *int `json:"tokens_freq_ratio_threshold,omitempty"`
	// TokensWeightThreshold Tokens whose weight is less than this threshold are considered nonsignificant
	// and pruned.
	TokensWeightThreshold *float32 `json:"tokens_weight_threshold,omitempty"`
}

TokenPruningConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/TokenPruningConfig.ts#L22-L35

func NewTokenPruningConfig added in v8.13.0 

func NewTokenPruningConfig() *TokenPruningConfig

NewTokenPruningConfig returns a TokenPruningConfig.

func (*TokenPruningConfig) UnmarshalJSON added in v8.13.0 

func (s *TokenPruningConfig) UnmarshalJSON(data []byte) error

type TokenizationConfigContainer 

type TokenizationConfigContainer struct {
	// Bert Indicates BERT tokenization and its options
	Bert *NlpBertTokenizationConfig `json:"bert,omitempty"`
	// BertJa Indicates BERT Japanese tokenization and its options
	BertJa *NlpBertTokenizationConfig `json:"bert_ja,omitempty"`
	// Mpnet Indicates MPNET tokenization and its options
	Mpnet *NlpBertTokenizationConfig `json:"mpnet,omitempty"`
	// Roberta Indicates RoBERTa tokenization and its options
	Roberta    *NlpRobertaTokenizationConfig `json:"roberta,omitempty"`
	XlmRoberta *XlmRobertaTokenizationConfig `json:"xlm_roberta,omitempty"`
}

TokenizationConfigContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L135-L158

func NewTokenizationConfigContainer added in v8.5.0 

func NewTokenizationConfigContainer() *TokenizationConfigContainer

NewTokenizationConfigContainer returns a TokenizationConfigContainer.

type Tokenizer 

type Tokenizer any

Tokenizer holds the union for the following types: 

string
TokenizerDefinition

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L140-L145

type TokenizerDefinition 

type TokenizerDefinition any

TokenizerDefinition holds the union for the following types: 

CharGroupTokenizer
ClassicTokenizer
EdgeNGramTokenizer
KeywordTokenizer
LetterTokenizer
LowercaseTokenizer
NGramTokenizer
PathHierarchyTokenizer
PatternTokenizer
SimplePatternTokenizer
SimplePatternSplitTokenizer
StandardTokenizer
ThaiTokenizer
UaxEmailUrlTokenizer
WhitespaceTokenizer
IcuTokenizer
KuromojiTokenizer
NoriTokenizer

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L147-L170

type ToolCall added in v8.18.0 

type ToolCall struct {
	// Function The function that the model called.
	Function ToolCallFunction `json:"function"`
	// Id The identifier of the tool call.
	Id string `json:"id"`
	// Type The type of the tool call.
	Type string `json:"type"`
}

ToolCall type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L151-L167

func NewToolCall added in v8.18.0 

func NewToolCall() *ToolCall

NewToolCall returns a ToolCall.

func (*ToolCall) UnmarshalJSON added in v8.18.0 

func (s *ToolCall) UnmarshalJSON(data []byte) error

type ToolCallFunction added in v8.18.0 

type ToolCallFunction struct {
	// Arguments The arguments to call the function with in JSON format.
	Arguments string `json:"arguments"`
	// Name The name of the function to call.
	Name string `json:"name"`
}

ToolCallFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L137-L149

func NewToolCallFunction added in v8.18.0 

func NewToolCallFunction() *ToolCallFunction

NewToolCallFunction returns a ToolCallFunction.

func (*ToolCallFunction) UnmarshalJSON added in v8.18.0 

func (s *ToolCallFunction) UnmarshalJSON(data []byte) error

type TopClassEntry 

type TopClassEntry struct {
	ClassName        string  `json:"class_name"`
	ClassProbability Float64 `json:"class_probability"`
	ClassScore       Float64 `json:"class_score"`
}

TopClassEntry type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L459-L463

func NewTopClassEntry added in v8.5.0 

func NewTopClassEntry() *TopClassEntry

NewTopClassEntry returns a TopClassEntry.

func (*TopClassEntry) UnmarshalJSON added in v8.7.1 

func (s *TopClassEntry) UnmarshalJSON(data []byte) error

type TopHit added in v8.9.0 

type TopHit struct {
	Count int64           `json:"count"`
	Value json.RawMessage `json:"value,omitempty"`
}

TopHit type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/text_structure/_types/Structure.ts#L35-L38

func NewTopHit added in v8.9.0 

func NewTopHit() *TopHit

NewTopHit returns a TopHit.

func (*TopHit) UnmarshalJSON added in v8.9.0 

func (s *TopHit) UnmarshalJSON(data []byte) error

type TopHitsAggregate 

type TopHitsAggregate struct {
	Hits HitsMetadata `json:"hits"`
	Meta Metadata     `json:"meta,omitempty"`
}

TopHitsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L747-L753

func NewTopHitsAggregate added in v8.5.0 

func NewTopHitsAggregate() *TopHitsAggregate

NewTopHitsAggregate returns a TopHitsAggregate.

func (*TopHitsAggregate) UnmarshalJSON added in v8.7.1 

func (s *TopHitsAggregate) UnmarshalJSON(data []byte) error

type TopHitsAggregation 

type TopHitsAggregation struct {
	// DocvalueFields Fields for which to return doc values.
	DocvalueFields []FieldAndFormat `json:"docvalue_fields,omitempty"`
	// Explain If `true`, returns detailed information about score computation as part of a
	// hit.
	Explain *bool `json:"explain,omitempty"`
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Fields Array of wildcard (*) patterns. The request returns values for field names
	// matching these patterns in the hits.fields property of the response.
	Fields []FieldAndFormat `json:"fields,omitempty"`
	// From Starting document offset.
	From *int `json:"from,omitempty"`
	// Highlight Specifies the highlighter to use for retrieving highlighted snippets from one
	// or more fields in the search results.
	Highlight *Highlight `json:"highlight,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// ScriptFields Returns the result of one or more script evaluations for each hit.
	ScriptFields map[string]ScriptField `json:"script_fields,omitempty"`
	// SeqNoPrimaryTerm If `true`, returns sequence number and primary term of the last modification
	// of each hit.
	SeqNoPrimaryTerm *bool `json:"seq_no_primary_term,omitempty"`
	// Size The maximum number of top matching hits to return per bucket.
	Size *int `json:"size,omitempty"`
	// Sort Sort order of the top matching hits.
	// By default, the hits are sorted by the score of the main query.
	Sort []SortCombinations `json:"sort,omitempty"`
	// Source_ Selects the fields of the source that are returned.
	Source_ SourceConfig `json:"_source,omitempty"`
	// StoredFields Returns values for the specified stored fields (fields that use the `store`
	// mapping option).
	StoredFields []string `json:"stored_fields,omitempty"`
	// TrackScores If `true`, calculates and returns document scores, even if the scores are not
	// used for sorting.
	TrackScores *bool `json:"track_scores,omitempty"`
	// Version If `true`, returns document version as part of a hit.
	Version *bool `json:"version,omitempty"`
}

TopHitsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L346-L406

func NewTopHitsAggregation added in v8.5.0 

func NewTopHitsAggregation() *TopHitsAggregation

NewTopHitsAggregation returns a TopHitsAggregation.

func (*TopHitsAggregation) UnmarshalJSON added in v8.7.1 

func (s *TopHitsAggregation) UnmarshalJSON(data []byte) error

type TopLeftBottomRightGeoBounds 

type TopLeftBottomRightGeoBounds struct {
	BottomRight GeoLocation `json:"bottom_right"`
	TopLeft     GeoLocation `json:"top_left"`
}

TopLeftBottomRightGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L161-L164

func NewTopLeftBottomRightGeoBounds added in v8.5.0 

func NewTopLeftBottomRightGeoBounds() *TopLeftBottomRightGeoBounds

NewTopLeftBottomRightGeoBounds returns a TopLeftBottomRightGeoBounds.

func (*TopLeftBottomRightGeoBounds) UnmarshalJSON added in v8.7.1 

func (s *TopLeftBottomRightGeoBounds) UnmarshalJSON(data []byte) error

type TopMetrics 

type TopMetrics struct {
	Metrics map[string]FieldValue `json:"metrics"`
	Sort    []FieldValue          `json:"sort"`
}

TopMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L832-L836

func NewTopMetrics added in v8.5.0 

func NewTopMetrics() *TopMetrics

NewTopMetrics returns a TopMetrics.

type TopMetricsAggregate 

type TopMetricsAggregate struct {
	Meta Metadata     `json:"meta,omitempty"`
	Top  []TopMetrics `json:"top"`
}

TopMetricsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L827-L830

func NewTopMetricsAggregate added in v8.5.0 

func NewTopMetricsAggregate() *TopMetricsAggregate

NewTopMetricsAggregate returns a TopMetricsAggregate.

func (*TopMetricsAggregate) UnmarshalJSON added in v8.7.1 

func (s *TopMetricsAggregate) UnmarshalJSON(data []byte) error

type TopMetricsAggregation 

type TopMetricsAggregation struct {
	// Field The field on which to run the aggregation.
	Field *string `json:"field,omitempty"`
	// Metrics The fields of the top document to return.
	Metrics []TopMetricsValue `json:"metrics,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
	// Size The number of top documents from which to return metrics.
	Size *int `json:"size,omitempty"`
	// Sort The sort order of the documents.
	Sort []SortCombinations `json:"sort,omitempty"`
}

TopMetricsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L408-L425

func NewTopMetricsAggregation added in v8.5.0 

func NewTopMetricsAggregation() *TopMetricsAggregation

NewTopMetricsAggregation returns a TopMetricsAggregation.

func (*TopMetricsAggregation) UnmarshalJSON added in v8.7.1 

func (s *TopMetricsAggregation) UnmarshalJSON(data []byte) error

type TopMetricsValue 

type TopMetricsValue struct {
	// Field A field to return as a metric.
	Field string `json:"field"`
}

TopMetricsValue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L427-L432

func NewTopMetricsValue added in v8.5.0 

func NewTopMetricsValue() *TopMetricsValue

NewTopMetricsValue returns a TopMetricsValue.

func (*TopMetricsValue) UnmarshalJSON added in v8.7.1 

func (s *TopMetricsValue) UnmarshalJSON(data []byte) error

type TopRightBottomLeftGeoBounds 

type TopRightBottomLeftGeoBounds struct {
	BottomLeft GeoLocation `json:"bottom_left"`
	TopRight   GeoLocation `json:"top_right"`
}

TopRightBottomLeftGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L166-L169

func NewTopRightBottomLeftGeoBounds added in v8.5.0 

func NewTopRightBottomLeftGeoBounds() *TopRightBottomLeftGeoBounds

NewTopRightBottomLeftGeoBounds returns a TopRightBottomLeftGeoBounds.

func (*TopRightBottomLeftGeoBounds) UnmarshalJSON added in v8.7.1 

func (s *TopRightBottomLeftGeoBounds) UnmarshalJSON(data []byte) error

type TotalFeatureImportance 

type TotalFeatureImportance struct {
	// Classes If the trained model is a classification model, feature importance statistics
	// are gathered per target class value.
	Classes []TotalFeatureImportanceClass `json:"classes"`
	// FeatureName The feature for which this importance was calculated.
	FeatureName string `json:"feature_name"`
	// Importance A collection of feature importance statistics related to the training data
	// set for this particular feature.
	Importance []TotalFeatureImportanceStatistics `json:"importance"`
}

TotalFeatureImportance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L290-L297

func NewTotalFeatureImportance added in v8.5.0 

func NewTotalFeatureImportance() *TotalFeatureImportance

NewTotalFeatureImportance returns a TotalFeatureImportance.

func (*TotalFeatureImportance) UnmarshalJSON added in v8.7.1 

func (s *TotalFeatureImportance) UnmarshalJSON(data []byte) error

type TotalFeatureImportanceClass 

type TotalFeatureImportanceClass struct {
	// ClassName The target class value. Could be a string, boolean, or number.
	ClassName string `json:"class_name"`
	// Importance A collection of feature importance statistics related to the training data
	// set for this particular feature.
	Importance []TotalFeatureImportanceStatistics `json:"importance"`
}

TotalFeatureImportanceClass type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L299-L304

func NewTotalFeatureImportanceClass added in v8.5.0 

func NewTotalFeatureImportanceClass() *TotalFeatureImportanceClass

NewTotalFeatureImportanceClass returns a TotalFeatureImportanceClass.

func (*TotalFeatureImportanceClass) UnmarshalJSON added in v8.7.1 

func (s *TotalFeatureImportanceClass) UnmarshalJSON(data []byte) error

type TotalFeatureImportanceStatistics 

type TotalFeatureImportanceStatistics struct {
	// Max The maximum importance value across all the training data for this feature.
	Max int `json:"max"`
	// MeanMagnitude The average magnitude of this feature across all the training data. This
	// value is the average of the absolute values of the importance for this
	// feature.
	MeanMagnitude Float64 `json:"mean_magnitude"`
	// Min The minimum importance value across all the training data for this feature.
	Min int `json:"min"`
}

TotalFeatureImportanceStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L306-L313

func NewTotalFeatureImportanceStatistics added in v8.5.0 

func NewTotalFeatureImportanceStatistics() *TotalFeatureImportanceStatistics

NewTotalFeatureImportanceStatistics returns a TotalFeatureImportanceStatistics.

func (*TotalFeatureImportanceStatistics) UnmarshalJSON added in v8.7.1 

func (s *TotalFeatureImportanceStatistics) UnmarshalJSON(data []byte) error

type TotalHits 

type TotalHits struct {
	Relation totalhitsrelation.TotalHitsRelation `json:"relation"`
	Value    int64                               `json:"value"`
}

TotalHits type.

https://github.com/elastic/elasticsearch-specification/blob/18d160a8583deec1bbef274d2c0e563a0cd20e2f/specification/_global/search/_types/hits.ts#L94-L97

func NewTotalHits added in v8.5.0 

func NewTotalHits() *TotalHits

NewTotalHits returns a TotalHits.

func (*TotalHits) UnmarshalJSON added in v8.7.0 

func (t *TotalHits) UnmarshalJSON(data []byte) error

UnmarshalJSON implements Unmarshaler interface, it handles the shortcut for total hits.

type TotalUserProfiles 

type TotalUserProfiles struct {
	Relation string `json:"relation"`
	Value    int64  `json:"value"`
}

TotalUserProfiles type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/suggest_user_profiles/Response.ts#L24-L27

func NewTotalUserProfiles added in v8.5.0 

func NewTotalUserProfiles() *TotalUserProfiles

NewTotalUserProfiles returns a TotalUserProfiles.

func (*TotalUserProfiles) UnmarshalJSON added in v8.7.1 

func (s *TotalUserProfiles) UnmarshalJSON(data []byte) error

type TrackHits 

type TrackHits any

TrackHits holds the union for the following types: 

bool
int

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/search/_types/hits.ts#L144-L152

type TrainedModel 

type TrainedModel struct {
	// Ensemble The definition for an ensemble model
	Ensemble *Ensemble `json:"ensemble,omitempty"`
	// Tree The definition for a binary decision tree.
	Tree *TrainedModelTree `json:"tree,omitempty"`
	// TreeNode The definition of a node in a tree.
	// There are two major types of nodes: leaf nodes and not-leaf nodes.
	// - Leaf nodes only need node_index and leaf_value defined.
	// - All other nodes need split_feature, left_child, right_child, threshold,
	// decision_type, and default_left defined.
	TreeNode *TrainedModelTreeNode `json:"tree_node,omitempty"`
}

TrainedModel type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L60-L72

func NewTrainedModel added in v8.5.0 

func NewTrainedModel() *TrainedModel

NewTrainedModel returns a TrainedModel.

type TrainedModelAssignment 

type TrainedModelAssignment struct {
	AdaptiveAllocations *AdaptiveAllocationsSettings `json:"adaptive_allocations,omitempty"`
	// AssignmentState The overall assignment state.
	AssignmentState        deploymentassignmentstate.DeploymentAssignmentState `json:"assignment_state"`
	MaxAssignedAllocations *int                                                `json:"max_assigned_allocations,omitempty"`
	Reason                 *string                                             `json:"reason,omitempty"`
	// RoutingTable The allocation state for each node.
	RoutingTable map[string]TrainedModelAssignmentRoutingTable `json:"routing_table"`
	// StartTime The timestamp when the deployment started.
	StartTime      DateTime                             `json:"start_time"`
	TaskParameters TrainedModelAssignmentTaskParameters `json:"task_parameters"`
}

TrainedModelAssignment type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L472-L489

func NewTrainedModelAssignment added in v8.5.0 

func NewTrainedModelAssignment() *TrainedModelAssignment

NewTrainedModelAssignment returns a TrainedModelAssignment.

func (*TrainedModelAssignment) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelAssignment) UnmarshalJSON(data []byte) error

type TrainedModelAssignmentRoutingStateAndReason added in v8.18.0 

type TrainedModelAssignmentRoutingStateAndReason struct {
	// Reason The reason for the current state. It is usually populated only when the
	// `routing_state` is `failed`.
	Reason *string `json:"reason,omitempty"`
	// RoutingState The current routing state.
	RoutingState routingstate.RoutingState `json:"routing_state"`
}

TrainedModelAssignmentRoutingStateAndReason type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L431-L441

func NewTrainedModelAssignmentRoutingStateAndReason added in v8.18.0 

func NewTrainedModelAssignmentRoutingStateAndReason() *TrainedModelAssignmentRoutingStateAndReason

NewTrainedModelAssignmentRoutingStateAndReason returns a TrainedModelAssignmentRoutingStateAndReason.

func (*TrainedModelAssignmentRoutingStateAndReason) UnmarshalJSON added in v8.18.0 

func (s *TrainedModelAssignmentRoutingStateAndReason) UnmarshalJSON(data []byte) error

type TrainedModelAssignmentRoutingTable 

type TrainedModelAssignmentRoutingTable struct {
	// CurrentAllocations Current number of allocations.
	CurrentAllocations int `json:"current_allocations"`
	// Reason The reason for the current state. It is usually populated only when the
	// `routing_state` is `failed`.
	Reason *string `json:"reason,omitempty"`
	// RoutingState The current routing state.
	RoutingState routingstate.RoutingState `json:"routing_state"`
	// TargetAllocations Target number of allocations.
	TargetAllocations int `json:"target_allocations"`
}

TrainedModelAssignmentRoutingTable type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L443-L461

func NewTrainedModelAssignmentRoutingTable added in v8.5.0 

func NewTrainedModelAssignmentRoutingTable() *TrainedModelAssignmentRoutingTable

NewTrainedModelAssignmentRoutingTable returns a TrainedModelAssignmentRoutingTable.

func (*TrainedModelAssignmentRoutingTable) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelAssignmentRoutingTable) UnmarshalJSON(data []byte) error

type TrainedModelAssignmentTaskParameters 

type TrainedModelAssignmentTaskParameters struct {
	// CacheSize The size of the trained model cache.
	CacheSize ByteSize `json:"cache_size,omitempty"`
	// DeploymentId The unique identifier for the trained model deployment.
	DeploymentId string `json:"deployment_id"`
	// ModelBytes The size of the trained model in bytes.
	ModelBytes ByteSize `json:"model_bytes"`
	// ModelId The unique identifier for the trained model.
	ModelId string `json:"model_id"`
	// NumberOfAllocations The total number of allocations this model is assigned across ML nodes.
	NumberOfAllocations      int                               `json:"number_of_allocations"`
	PerAllocationMemoryBytes ByteSize                          `json:"per_allocation_memory_bytes"`
	PerDeploymentMemoryBytes ByteSize                          `json:"per_deployment_memory_bytes"`
	Priority                 trainingpriority.TrainingPriority `json:"priority"`
	// QueueCapacity Number of inference requests are allowed in the queue at a time.
	QueueCapacity int `json:"queue_capacity"`
	// ThreadsPerAllocation Number of threads per allocation.
	ThreadsPerAllocation int `json:"threads_per_allocation"`
}

TrainedModelAssignmentTaskParameters type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L370-L406

func NewTrainedModelAssignmentTaskParameters added in v8.5.0 

func NewTrainedModelAssignmentTaskParameters() *TrainedModelAssignmentTaskParameters

NewTrainedModelAssignmentTaskParameters returns a TrainedModelAssignmentTaskParameters.

func (*TrainedModelAssignmentTaskParameters) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelAssignmentTaskParameters) UnmarshalJSON(data []byte) error

type TrainedModelConfig 

type TrainedModelConfig struct {
	CompressedDefinition *string `json:"compressed_definition,omitempty"`
	// CreateTime The time when the trained model was created.
	CreateTime DateTime `json:"create_time,omitempty"`
	// CreatedBy Information on the creator of the trained model.
	CreatedBy *string `json:"created_by,omitempty"`
	// DefaultFieldMap Any field map described in the inference configuration takes precedence.
	DefaultFieldMap map[string]string `json:"default_field_map,omitempty"`
	// Description The free-text description of the trained model.
	Description *string `json:"description,omitempty"`
	// EstimatedHeapMemoryUsageBytes The estimated heap usage in bytes to keep the trained model in memory.
	EstimatedHeapMemoryUsageBytes *int `json:"estimated_heap_memory_usage_bytes,omitempty"`
	// EstimatedOperations The estimated number of operations to use the trained model.
	EstimatedOperations *int `json:"estimated_operations,omitempty"`
	// FullyDefined True if the full model definition is present.
	FullyDefined *bool `json:"fully_defined,omitempty"`
	// InferenceConfig The default configuration for inference. This can be either a regression,
	// classification, or one of the many NLP focused configurations. It must match
	// the underlying definition.trained_model's target_type. For pre-packaged
	// models such as ELSER the config is not required.
	InferenceConfig *InferenceConfigCreateContainer `json:"inference_config,omitempty"`
	// Input The input field names for the model definition.
	Input TrainedModelConfigInput `json:"input"`
	// LicenseLevel The license level of the trained model.
	LicenseLevel *string               `json:"license_level,omitempty"`
	Location     *TrainedModelLocation `json:"location,omitempty"`
	// Metadata An object containing metadata about the trained model. For example, models
	// created by data frame analytics contain analysis_config and input objects.
	Metadata *TrainedModelConfigMetadata `json:"metadata,omitempty"`
	// ModelId Identifier for the trained model.
	ModelId        string              `json:"model_id"`
	ModelPackage   *ModelPackageConfig `json:"model_package,omitempty"`
	ModelSizeBytes ByteSize            `json:"model_size_bytes,omitempty"`
	// ModelType The model type
	ModelType            *trainedmodeltype.TrainedModelType `json:"model_type,omitempty"`
	PlatformArchitecture *string                            `json:"platform_architecture,omitempty"`
	PrefixStrings        *TrainedModelPrefixStrings         `json:"prefix_strings,omitempty"`
	// Tags A comma delimited string of tags. A trained model can have many tags, or
	// none.
	Tags []string `json:"tags"`
	// Version The Elasticsearch version number in which the trained model was created.
	Version *string `json:"version,omitempty"`
}

TrainedModelConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L203-L240

func NewTrainedModelConfig added in v8.5.0 

func NewTrainedModelConfig() *TrainedModelConfig

NewTrainedModelConfig returns a TrainedModelConfig.

func (*TrainedModelConfig) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelConfig) UnmarshalJSON(data []byte) error

type TrainedModelConfigInput 

type TrainedModelConfigInput struct {
	// FieldNames An array of input field names for the model.
	FieldNames []string `json:"field_names"`
}

TrainedModelConfigInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L242-L245

func NewTrainedModelConfigInput added in v8.5.0 

func NewTrainedModelConfigInput() *TrainedModelConfigInput

NewTrainedModelConfigInput returns a TrainedModelConfigInput.

type TrainedModelConfigMetadata 

type TrainedModelConfigMetadata struct {
	// FeatureImportanceBaseline An object that contains the baseline for feature importance values. For
	// regression analysis, it is a single value. For classification analysis, there
	// is a value for each class.
	FeatureImportanceBaseline map[string]string `json:"feature_importance_baseline,omitempty"`
	// Hyperparameters List of the available hyperparameters optimized during the
	// fine_parameter_tuning phase as well as specified by the user.
	Hyperparameters []Hyperparameter `json:"hyperparameters,omitempty"`
	ModelAliases    []string         `json:"model_aliases,omitempty"`
	// TotalFeatureImportance An array of the total feature importance for each feature used from the
	// training data set. This array of objects is returned if data frame analytics
	// trained the model and the request includes total_feature_importance in the
	// include request parameter.
	TotalFeatureImportance []TotalFeatureImportance `json:"total_feature_importance,omitempty"`
}

TrainedModelConfigMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L247-L255

func NewTrainedModelConfigMetadata added in v8.5.0 

func NewTrainedModelConfigMetadata() *TrainedModelConfigMetadata

NewTrainedModelConfigMetadata returns a TrainedModelConfigMetadata.

type TrainedModelDeploymentAllocationStatus 

type TrainedModelDeploymentAllocationStatus struct {
	// AllocationCount The current number of nodes where the model is allocated.
	AllocationCount int `json:"allocation_count"`
	// State The detailed allocation state related to the nodes.
	State deploymentallocationstate.DeploymentAllocationState `json:"state"`
	// TargetAllocationCount The desired number of nodes for model allocation.
	TargetAllocationCount int `json:"target_allocation_count"`
}

TrainedModelDeploymentAllocationStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L463-L470

func NewTrainedModelDeploymentAllocationStatus added in v8.5.0 

func NewTrainedModelDeploymentAllocationStatus() *TrainedModelDeploymentAllocationStatus

NewTrainedModelDeploymentAllocationStatus returns a TrainedModelDeploymentAllocationStatus.

func (*TrainedModelDeploymentAllocationStatus) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelDeploymentAllocationStatus) UnmarshalJSON(data []byte) error

type TrainedModelDeploymentNodesStats 

type TrainedModelDeploymentNodesStats struct {
	// AverageInferenceTimeMs The average time for each inference call to complete on this node.
	AverageInferenceTimeMs Float64 `json:"average_inference_time_ms,omitempty"`
	// AverageInferenceTimeMsExcludingCacheHits The average time for each inference call to complete on this node, excluding
	// cache
	AverageInferenceTimeMsExcludingCacheHits Float64 `json:"average_inference_time_ms_excluding_cache_hits,omitempty"`
	AverageInferenceTimeMsLastMinute         Float64 `json:"average_inference_time_ms_last_minute,omitempty"`
	// ErrorCount The number of errors when evaluating the trained model.
	ErrorCount                       *int   `json:"error_count,omitempty"`
	InferenceCacheHitCount           *int64 `json:"inference_cache_hit_count,omitempty"`
	InferenceCacheHitCountLastMinute *int64 `json:"inference_cache_hit_count_last_minute,omitempty"`
	// InferenceCount The total number of inference calls made against this node for this model.
	InferenceCount *int64 `json:"inference_count,omitempty"`
	// LastAccess The epoch time stamp of the last inference call for the model on this node.
	LastAccess *int64 `json:"last_access,omitempty"`
	// Node Information pertaining to the node.
	Node DiscoveryNode `json:"node,omitempty"`
	// NumberOfAllocations The number of allocations assigned to this node.
	NumberOfAllocations *int `json:"number_of_allocations,omitempty"`
	// NumberOfPendingRequests The number of inference requests queued to be processed.
	NumberOfPendingRequests *int  `json:"number_of_pending_requests,omitempty"`
	PeakThroughputPerMinute int64 `json:"peak_throughput_per_minute"`
	// RejectedExecutionCount The number of inference requests that were not processed because the queue
	// was full.
	RejectedExecutionCount *int `json:"rejected_execution_count,omitempty"`
	// RoutingState The current routing state and reason for the current routing state for this
	// allocation.
	RoutingState TrainedModelAssignmentRoutingStateAndReason `json:"routing_state"`
	// StartTime The epoch timestamp when the allocation started.
	StartTime *int64 `json:"start_time,omitempty"`
	// ThreadsPerAllocation The number of threads used by each allocation during inference.
	ThreadsPerAllocation *int `json:"threads_per_allocation,omitempty"`
	ThroughputLastMinute int  `json:"throughput_last_minute"`
	// TimeoutCount The number of inference requests that timed out before being processed.
	TimeoutCount *int `json:"timeout_count,omitempty"`
}

TrainedModelDeploymentNodesStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L156-L201

func NewTrainedModelDeploymentNodesStats added in v8.5.0 

func NewTrainedModelDeploymentNodesStats() *TrainedModelDeploymentNodesStats

NewTrainedModelDeploymentNodesStats returns a TrainedModelDeploymentNodesStats.

func (*TrainedModelDeploymentNodesStats) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelDeploymentNodesStats) UnmarshalJSON(data []byte) error

type TrainedModelDeploymentStats 

type TrainedModelDeploymentStats struct {
	AdaptiveAllocations *AdaptiveAllocationsSettings `json:"adaptive_allocations,omitempty"`
	// AllocationStatus The detailed allocation status for the deployment.
	AllocationStatus *TrainedModelDeploymentAllocationStatus `json:"allocation_status,omitempty"`
	CacheSize        ByteSize                                `json:"cache_size,omitempty"`
	// DeploymentId The unique identifier for the trained model deployment.
	DeploymentId string `json:"deployment_id"`
	// ErrorCount The sum of `error_count` for all nodes in the deployment.
	ErrorCount *int `json:"error_count,omitempty"`
	// InferenceCount The sum of `inference_count` for all nodes in the deployment.
	InferenceCount *int `json:"inference_count,omitempty"`
	// ModelId The unique identifier for the trained model.
	ModelId string `json:"model_id"`
	// Nodes The deployment stats for each node that currently has the model allocated.
	// In serverless, stats are reported for a single unnamed virtual node.
	Nodes []TrainedModelDeploymentNodesStats `json:"nodes"`
	// NumberOfAllocations The number of allocations requested.
	NumberOfAllocations     *int                              `json:"number_of_allocations,omitempty"`
	PeakThroughputPerMinute int64                             `json:"peak_throughput_per_minute"`
	Priority                trainingpriority.TrainingPriority `json:"priority"`
	// QueueCapacity The number of inference requests that can be queued before new requests are
	// rejected.
	QueueCapacity *int `json:"queue_capacity,omitempty"`
	// Reason The reason for the current deployment state. Usually only populated when
	// the model is not deployed to a node.
	Reason *string `json:"reason,omitempty"`
	// RejectedExecutionCount The sum of `rejected_execution_count` for all nodes in the deployment.
	// Individual nodes reject an inference request if the inference queue is full.
	// The queue size is controlled by the `queue_capacity` setting in the start
	// trained model deployment API.
	RejectedExecutionCount *int `json:"rejected_execution_count,omitempty"`
	// StartTime The epoch timestamp when the deployment started.
	StartTime int64 `json:"start_time"`
	// State The overall state of the deployment.
	State *deploymentassignmentstate.DeploymentAssignmentState `json:"state,omitempty"`
	// ThreadsPerAllocation The number of threads used be each allocation during inference.
	ThreadsPerAllocation *int `json:"threads_per_allocation,omitempty"`
	// TimeoutCount The sum of `timeout_count` for all nodes in the deployment.
	TimeoutCount *int `json:"timeout_count,omitempty"`
}

TrainedModelDeploymentStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L62-L107

func NewTrainedModelDeploymentStats added in v8.5.0 

func NewTrainedModelDeploymentStats() *TrainedModelDeploymentStats

NewTrainedModelDeploymentStats returns a TrainedModelDeploymentStats.

func (*TrainedModelDeploymentStats) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelDeploymentStats) UnmarshalJSON(data []byte) error

type TrainedModelEntities 

type TrainedModelEntities struct {
	ClassName        string  `json:"class_name"`
	ClassProbability Float64 `json:"class_probability"`
	EndPos           int     `json:"end_pos"`
	Entity           string  `json:"entity"`
	StartPos         int     `json:"start_pos"`
}

TrainedModelEntities type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L452-L458

func NewTrainedModelEntities added in v8.5.0 

func NewTrainedModelEntities() *TrainedModelEntities

NewTrainedModelEntities returns a TrainedModelEntities.

func (*TrainedModelEntities) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelEntities) UnmarshalJSON(data []byte) error

type TrainedModelInferenceClassImportance 

type TrainedModelInferenceClassImportance struct {
	ClassName  string  `json:"class_name"`
	Importance Float64 `json:"importance"`
}

TrainedModelInferenceClassImportance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L465-L468

func NewTrainedModelInferenceClassImportance added in v8.5.0 

func NewTrainedModelInferenceClassImportance() *TrainedModelInferenceClassImportance

NewTrainedModelInferenceClassImportance returns a TrainedModelInferenceClassImportance.

func (*TrainedModelInferenceClassImportance) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelInferenceClassImportance) UnmarshalJSON(data []byte) error

type TrainedModelInferenceFeatureImportance 

type TrainedModelInferenceFeatureImportance struct {
	Classes     []TrainedModelInferenceClassImportance `json:"classes,omitempty"`
	FeatureName string                                 `json:"feature_name"`
	Importance  *Float64                               `json:"importance,omitempty"`
}

TrainedModelInferenceFeatureImportance type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L470-L474

func NewTrainedModelInferenceFeatureImportance added in v8.5.0 

func NewTrainedModelInferenceFeatureImportance() *TrainedModelInferenceFeatureImportance

NewTrainedModelInferenceFeatureImportance returns a TrainedModelInferenceFeatureImportance.

func (*TrainedModelInferenceFeatureImportance) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelInferenceFeatureImportance) UnmarshalJSON(data []byte) error

type TrainedModelInferenceStats 

type TrainedModelInferenceStats struct {
	// CacheMissCount The number of times the model was loaded for inference and was not retrieved
	// from the cache.
	// If this number is close to the `inference_count`, the cache is not being
	// appropriately used.
	// This can be solved by increasing the cache size or its time-to-live (TTL).
	// Refer to general machine learning settings for the appropriate settings.
	CacheMissCount int `json:"cache_miss_count"`
	// FailureCount The number of failures when using the model for inference.
	FailureCount int `json:"failure_count"`
	// InferenceCount The total number of times the model has been called for inference.
	// This is across all inference contexts, including all pipelines.
	InferenceCount int `json:"inference_count"`
	// MissingAllFieldsCount The number of inference calls where all the training features for the model
	// were missing.
	MissingAllFieldsCount int `json:"missing_all_fields_count"`
	// Timestamp The time when the statistics were last updated.
	Timestamp int64 `json:"timestamp"`
}

TrainedModelInferenceStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L127-L147

func NewTrainedModelInferenceStats added in v8.5.0 

func NewTrainedModelInferenceStats() *TrainedModelInferenceStats

NewTrainedModelInferenceStats returns a TrainedModelInferenceStats.

func (*TrainedModelInferenceStats) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelInferenceStats) UnmarshalJSON(data []byte) error

type TrainedModelLocation 

type TrainedModelLocation struct {
	Index TrainedModelLocationIndex `json:"index"`
}

TrainedModelLocation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L491-L493

func NewTrainedModelLocation added in v8.5.0 

func NewTrainedModelLocation() *TrainedModelLocation

NewTrainedModelLocation returns a TrainedModelLocation.

type TrainedModelLocationIndex 

type TrainedModelLocationIndex struct {
	Name string `json:"name"`
}

TrainedModelLocationIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L495-L497

func NewTrainedModelLocationIndex added in v8.5.0 

func NewTrainedModelLocationIndex() *TrainedModelLocationIndex

NewTrainedModelLocationIndex returns a TrainedModelLocationIndex.

func (*TrainedModelLocationIndex) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelLocationIndex) UnmarshalJSON(data []byte) error

type TrainedModelPrefixStrings added in v8.13.0 

type TrainedModelPrefixStrings struct {
	// Ingest String prepended to input at ingest
	Ingest *string `json:"ingest,omitempty"`
	// Search String prepended to input at search
	Search *string `json:"search,omitempty"`
}

TrainedModelPrefixStrings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L499-L508

func NewTrainedModelPrefixStrings added in v8.13.0 

func NewTrainedModelPrefixStrings() *TrainedModelPrefixStrings

NewTrainedModelPrefixStrings returns a TrainedModelPrefixStrings.

func (*TrainedModelPrefixStrings) UnmarshalJSON added in v8.13.0 

func (s *TrainedModelPrefixStrings) UnmarshalJSON(data []byte) error

type TrainedModelSizeStats 

type TrainedModelSizeStats struct {
	// ModelSizeBytes The size of the model in bytes.
	ModelSizeBytes ByteSize `json:"model_size_bytes"`
	// RequiredNativeMemoryBytes The amount of memory required to load the model in bytes.
	RequiredNativeMemoryBytes ByteSize `json:"required_native_memory_bytes"`
}

TrainedModelSizeStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L149-L154

func NewTrainedModelSizeStats added in v8.5.0 

func NewTrainedModelSizeStats() *TrainedModelSizeStats

NewTrainedModelSizeStats returns a TrainedModelSizeStats.

func (*TrainedModelSizeStats) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelSizeStats) UnmarshalJSON(data []byte) error

type TrainedModelStats 

type TrainedModelStats struct {
	// DeploymentStats A collection of deployment stats, which is present when the models are
	// deployed.
	DeploymentStats *TrainedModelDeploymentStats `json:"deployment_stats,omitempty"`
	// InferenceStats A collection of inference stats fields.
	InferenceStats *TrainedModelInferenceStats `json:"inference_stats,omitempty"`
	// Ingest A collection of ingest stats for the model across all nodes.
	// The values are summations of the individual node statistics.
	// The format matches the ingest section in the nodes stats API.
	Ingest map[string]json.RawMessage `json:"ingest,omitempty"`
	// ModelId The unique identifier of the trained model.
	ModelId string `json:"model_id"`
	// ModelSizeStats A collection of model size stats.
	ModelSizeStats TrainedModelSizeStats `json:"model_size_stats"`
	// PipelineCount The number of ingest pipelines that currently refer to the model.
	PipelineCount int `json:"pipeline_count"`
}

TrainedModelStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/TrainedModel.ts#L42-L60

func NewTrainedModelStats added in v8.5.0 

func NewTrainedModelStats() *TrainedModelStats

NewTrainedModelStats returns a TrainedModelStats.

func (*TrainedModelStats) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelStats) UnmarshalJSON(data []byte) error

type TrainedModelTree 

type TrainedModelTree struct {
	ClassificationLabels []string               `json:"classification_labels,omitempty"`
	FeatureNames         []string               `json:"feature_names"`
	TargetType           *string                `json:"target_type,omitempty"`
	TreeStructure        []TrainedModelTreeNode `json:"tree_structure"`
}

TrainedModelTree type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L74-L79

func NewTrainedModelTree added in v8.5.0 

func NewTrainedModelTree() *TrainedModelTree

NewTrainedModelTree returns a TrainedModelTree.

func (*TrainedModelTree) UnmarshalJSON added in v8.9.0 

func (s *TrainedModelTree) UnmarshalJSON(data []byte) error

type TrainedModelTreeNode 

type TrainedModelTreeNode struct {
	DecisionType *string  `json:"decision_type,omitempty"`
	DefaultLeft  *bool    `json:"default_left,omitempty"`
	LeafValue    *Float64 `json:"leaf_value,omitempty"`
	LeftChild    *int     `json:"left_child,omitempty"`
	NodeIndex    int      `json:"node_index"`
	RightChild   *int     `json:"right_child,omitempty"`
	SplitFeature *int     `json:"split_feature,omitempty"`
	SplitGain    *int     `json:"split_gain,omitempty"`
	Threshold    *Float64 `json:"threshold,omitempty"`
}

TrainedModelTreeNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L81-L91

func NewTrainedModelTreeNode added in v8.5.0 

func NewTrainedModelTreeNode() *TrainedModelTreeNode

NewTrainedModelTreeNode returns a TrainedModelTreeNode.

func (*TrainedModelTreeNode) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelTreeNode) UnmarshalJSON(data []byte) error

type TrainedModelsRecord 

type TrainedModelsRecord struct {
	// CreateTime The time the model was created.
	CreateTime DateTime `json:"create_time,omitempty"`
	// CreatedBy Information about the creator of the model.
	CreatedBy *string `json:"created_by,omitempty"`
	// DataFrameAnalysis The analysis used by the data frame to build the model.
	DataFrameAnalysis *string `json:"data_frame.analysis,omitempty"`
	// DataFrameCreateTime The time the data frame analytics job was created.
	DataFrameCreateTime *string `json:"data_frame.create_time,omitempty"`
	// DataFrameId The identifier for the data frame analytics job that created the model.
	// Only displayed if the job is still available.
	DataFrameId *string `json:"data_frame.id,omitempty"`
	// DataFrameSourceIndex The source index used to train in the data frame analysis.
	DataFrameSourceIndex *string `json:"data_frame.source_index,omitempty"`
	// Description A description of the model.
	Description *string `json:"description,omitempty"`
	// HeapSize The estimated heap size to keep the model in memory.
	HeapSize ByteSize `json:"heap_size,omitempty"`
	// Id The model identifier.
	Id *string `json:"id,omitempty"`
	// IngestCount The total number of documents that are processed by the model.
	IngestCount *string `json:"ingest.count,omitempty"`
	// IngestCurrent The total number of documents that are currently being handled by the model.
	IngestCurrent *string `json:"ingest.current,omitempty"`
	// IngestFailed The total number of failed ingest attempts with the model.
	IngestFailed *string `json:"ingest.failed,omitempty"`
	// IngestPipelines The number of pipelines that are referencing the model.
	IngestPipelines *string `json:"ingest.pipelines,omitempty"`
	// IngestTime The total time spent processing documents with thie model.
	IngestTime *string `json:"ingest.time,omitempty"`
	// License The license level of the model.
	License *string `json:"license,omitempty"`
	// Operations The estimated number of operations to use the model.
	// This number helps to measure the computational complexity of the model.
	Operations *string `json:"operations,omitempty"`
	Type       *string `json:"type,omitempty"`
	// Version The version of Elasticsearch when the model was created.
	Version *string `json:"version,omitempty"`
}

TrainedModelsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/ml_trained_models/types.ts#L23-L115

func NewTrainedModelsRecord added in v8.5.0 

func NewTrainedModelsRecord() *TrainedModelsRecord

NewTrainedModelsRecord returns a TrainedModelsRecord.

func (*TrainedModelsRecord) UnmarshalJSON added in v8.7.1 

func (s *TrainedModelsRecord) UnmarshalJSON(data []byte) error

type TransformAuthorization 

type TransformAuthorization struct {
	// ApiKey If an API key was used for the most recent update to the transform, its name
	// and identifier are listed in the response.
	ApiKey *ApiKeyAuthorization `json:"api_key,omitempty"`
	// Roles If a user ID was used for the most recent update to the transform, its roles
	// at the time of the update are listed in the response.
	Roles []string `json:"roles,omitempty"`
	// ServiceAccount If a service account was used for the most recent update to the transform,
	// the account name is listed in the response.
	ServiceAccount *string `json:"service_account,omitempty"`
}

TransformAuthorization type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/Authorization.ts#L59-L71

func NewTransformAuthorization added in v8.5.0 

func NewTransformAuthorization() *TransformAuthorization

NewTransformAuthorization returns a TransformAuthorization.

func (*TransformAuthorization) UnmarshalJSON added in v8.9.0 

func (s *TransformAuthorization) UnmarshalJSON(data []byte) error

type TransformContainer 

type TransformContainer struct {
	Chain  []TransformContainer `json:"chain,omitempty"`
	Script *ScriptTransform     `json:"script,omitempty"`
	Search *SearchTransform     `json:"search,omitempty"`
}

TransformContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Transform.ts#L27-L34

func NewTransformContainer added in v8.5.0 

func NewTransformContainer() *TransformContainer

NewTransformContainer returns a TransformContainer.

type TransformDestination added in v8.5.0 

type TransformDestination struct {
	// Index The destination index for the transform. The mappings of the destination
	// index are deduced based on the source
	// fields when possible. If alternate mappings are required, use the create
	// index API prior to starting the
	// transform.
	Index *string `json:"index,omitempty"`
	// Pipeline The unique identifier for an ingest pipeline.
	Pipeline *string `json:"pipeline,omitempty"`
}

TransformDestination type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L34-L45

func NewTransformDestination added in v8.5.0 

func NewTransformDestination() *TransformDestination

NewTransformDestination returns a TransformDestination.

func (*TransformDestination) UnmarshalJSON added in v8.7.1 

func (s *TransformDestination) UnmarshalJSON(data []byte) error

type TransformHealthIssue added in v8.18.0 

type TransformHealthIssue struct {
	// Count Number of times this issue has occurred since it started
	Count int `json:"count"`
	// Details Details about the issue
	Details              *string  `json:"details,omitempty"`
	FirstOccurenceString DateTime `json:"first_occurence_string,omitempty"`
	// FirstOccurrence The timestamp this issue occurred for for the first time
	FirstOccurrence *int64 `json:"first_occurrence,omitempty"`
	// Issue A description of the issue
	Issue string `json:"issue"`
	// Type The type of the issue
	Type string `json:"type"`
}

TransformHealthIssue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L51-L63

func NewTransformHealthIssue added in v8.18.0 

func NewTransformHealthIssue() *TransformHealthIssue

NewTransformHealthIssue returns a TransformHealthIssue.

func (*TransformHealthIssue) UnmarshalJSON added in v8.18.0 

func (s *TransformHealthIssue) UnmarshalJSON(data []byte) error

type TransformIndexerStats 

type TransformIndexerStats struct {
	DeleteTimeInMs                     *int64  `json:"delete_time_in_ms,omitempty"`
	DocumentsDeleted                   *int64  `json:"documents_deleted,omitempty"`
	DocumentsIndexed                   int64   `json:"documents_indexed"`
	DocumentsProcessed                 int64   `json:"documents_processed"`
	ExponentialAvgCheckpointDurationMs Float64 `json:"exponential_avg_checkpoint_duration_ms"`
	ExponentialAvgDocumentsIndexed     Float64 `json:"exponential_avg_documents_indexed"`
	ExponentialAvgDocumentsProcessed   Float64 `json:"exponential_avg_documents_processed"`
	IndexFailures                      int64   `json:"index_failures"`
	IndexTimeInMs                      int64   `json:"index_time_in_ms"`
	IndexTotal                         int64   `json:"index_total"`
	PagesProcessed                     int64   `json:"pages_processed"`
	ProcessingTimeInMs                 int64   `json:"processing_time_in_ms"`
	ProcessingTotal                    int64   `json:"processing_total"`
	SearchFailures                     int64   `json:"search_failures"`
	SearchTimeInMs                     int64   `json:"search_time_in_ms"`
	SearchTotal                        int64   `json:"search_total"`
	TriggerCount                       int64   `json:"trigger_count"`
}

TransformIndexerStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L73-L91

func NewTransformIndexerStats added in v8.5.0 

func NewTransformIndexerStats() *TransformIndexerStats

NewTransformIndexerStats returns a TransformIndexerStats.

func (*TransformIndexerStats) UnmarshalJSON added in v8.7.1 

func (s *TransformIndexerStats) UnmarshalJSON(data []byte) error

type TransformProgress 

type TransformProgress struct {
	DocsIndexed     int64    `json:"docs_indexed"`
	DocsProcessed   int64    `json:"docs_processed"`
	DocsRemaining   *int64   `json:"docs_remaining,omitempty"`
	PercentComplete *Float64 `json:"percent_complete,omitempty"`
	TotalDocs       *int64   `json:"total_docs,omitempty"`
}

TransformProgress type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L65-L71

func NewTransformProgress added in v8.5.0 

func NewTransformProgress() *TransformProgress

NewTransformProgress returns a TransformProgress.

func (*TransformProgress) UnmarshalJSON added in v8.7.1 

func (s *TransformProgress) UnmarshalJSON(data []byte) error

type TransformSource added in v8.5.0 

type TransformSource struct {
	// Index The source indices for the transform. It can be a single index, an index
	// pattern (for example, `"my-index-*""`), an
	// array of indices (for example, `["my-index-000001", "my-index-000002"]`), or
	// an array of index patterns (for
	// example, `["my-index-*", "my-other-index-*"]`. For remote indices use the
	// syntax `"remote_name:index_name"`. If
	// any indices are in remote clusters then the master node and at least one
	// transform node must have the `remote_cluster_client` node role.
	Index []string `json:"index"`
	// Query A query clause that retrieves a subset of data from the source index.
	Query *Query `json:"query,omitempty"`
	// RuntimeMappings Definitions of search-time runtime fields that can be used by the transform.
	// For search runtime fields all data
	// nodes, including remote nodes, must be 7.12 or later.
	RuntimeMappings RuntimeFields `json:"runtime_mappings,omitempty"`
}

TransformSource type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/_types/Transform.ts#L146-L165

func NewTransformSource added in v8.5.0 

func NewTransformSource() *TransformSource

NewTransformSource returns a TransformSource.

func (*TransformSource) UnmarshalJSON added in v8.7.1 

func (s *TransformSource) UnmarshalJSON(data []byte) error

type TransformStats 

type TransformStats struct {
	Checkpointing Checkpointing         `json:"checkpointing"`
	Health        *TransformStatsHealth `json:"health,omitempty"`
	Id            string                `json:"id"`
	Node          *NodeAttributes       `json:"node,omitempty"`
	Reason        *string               `json:"reason,omitempty"`
	State         string                `json:"state"`
	Stats         TransformIndexerStats `json:"stats"`
}

TransformStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L31-L42

func NewTransformStats added in v8.5.0 

func NewTransformStats() *TransformStats

NewTransformStats returns a TransformStats.

func (*TransformStats) UnmarshalJSON added in v8.7.1 

func (s *TransformStats) UnmarshalJSON(data []byte) error

type TransformStatsHealth added in v8.7.0 

type TransformStatsHealth struct {
	// Issues If a non-healthy status is returned, contains a list of issues of the
	// transform.
	Issues []TransformHealthIssue    `json:"issues,omitempty"`
	Status healthstatus.HealthStatus `json:"status"`
}

TransformStatsHealth type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform_stats/types.ts#L44-L49

func NewTransformStatsHealth added in v8.7.0 

func NewTransformStatsHealth() *TransformStatsHealth

NewTransformStatsHealth returns a TransformStatsHealth.

type TransformSummary 

type TransformSummary struct {
	// Authorization The security privileges that the transform uses to run its queries. If
	// Elastic Stack security features were disabled at the time of the most recent
	// update to the transform, this property is omitted.
	Authorization *TransformAuthorization `json:"authorization,omitempty"`
	// CreateTime The time the transform was created.
	CreateTime       *int64   `json:"create_time,omitempty"`
	CreateTimeString DateTime `json:"create_time_string,omitempty"`
	// Description Free text description of the transform.
	Description *string `json:"description,omitempty"`
	// Dest The destination for the transform.
	Dest      ReindexDestination `json:"dest"`
	Frequency Duration           `json:"frequency,omitempty"`
	Id        string             `json:"id"`
	Latest    *Latest            `json:"latest,omitempty"`
	Meta_     Metadata           `json:"_meta,omitempty"`
	// Pivot The pivot method transforms the data by aggregating and grouping it.
	Pivot           *Pivot                    `json:"pivot,omitempty"`
	RetentionPolicy *RetentionPolicyContainer `json:"retention_policy,omitempty"`
	// Settings Defines optional transform settings.
	Settings *Settings `json:"settings,omitempty"`
	// Source The source of the data for the transform.
	Source TransformSource `json:"source"`
	// Sync Defines the properties transforms require to run continuously.
	Sync *SyncContainer `json:"sync,omitempty"`
	// Version The version of Elasticsearch that existed on the node when the transform was
	// created.
	Version *string `json:"version,omitempty"`
}

TransformSummary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/transform/get_transform/types.ts#L33-L62

func NewTransformSummary added in v8.5.0 

func NewTransformSummary() *TransformSummary

NewTransformSummary returns a TransformSummary.

func (*TransformSummary) UnmarshalJSON added in v8.7.1 

func (s *TransformSummary) UnmarshalJSON(data []byte) error

type TransformsRecord 

type TransformsRecord struct {
	// ChangesLastDetectionTime The timestamp when changes were last detected in the source indices.
	ChangesLastDetectionTime *string `json:"changes_last_detection_time,omitempty"`
	// Checkpoint The sequence number for the checkpoint.
	Checkpoint *string `json:"checkpoint,omitempty"`
	// CheckpointDurationTimeExpAvg The exponential moving average of the duration of the checkpoint, in
	// milliseconds.
	CheckpointDurationTimeExpAvg *string `json:"checkpoint_duration_time_exp_avg,omitempty"`
	// CheckpointProgress The progress of the next checkpoint that is currently in progress.
	CheckpointProgress *string `json:"checkpoint_progress,omitempty"`
	// CreateTime The time the transform was created.
	CreateTime *string `json:"create_time,omitempty"`
	// DeleteTime The total time spent deleting documents, in milliseconds.
	DeleteTime *string `json:"delete_time,omitempty"`
	// Description The description of the transform.
	Description *string `json:"description,omitempty"`
	// DestIndex The destination index for the transform.
	DestIndex *string `json:"dest_index,omitempty"`
	// DocsPerSecond The number of input documents per second.
	DocsPerSecond *string `json:"docs_per_second,omitempty"`
	// DocumentsDeleted The number of documents deleted from the destination index due to the
	// retention policy for the transform.
	DocumentsDeleted *string `json:"documents_deleted,omitempty"`
	// DocumentsIndexed The number of documents that have been indexed into the destination index for
	// the transform.
	DocumentsIndexed *string `json:"documents_indexed,omitempty"`
	// DocumentsProcessed The number of documents that have been processed from the source index of the
	// transform.
	DocumentsProcessed *string `json:"documents_processed,omitempty"`
	// Frequency The interval between checks for changes in the source indices when the
	// transform is running continuously.
	Frequency *string `json:"frequency,omitempty"`
	// Id The transform identifier.
	Id *string `json:"id,omitempty"`
	// IndexFailure The total number of indexing failures.
	IndexFailure *string `json:"index_failure,omitempty"`
	// IndexTime The total time spent indexing documents, in milliseconds.
	IndexTime *string `json:"index_time,omitempty"`
	// IndexTotal The total number of index operations done by the transform.
	IndexTotal *string `json:"index_total,omitempty"`
	// IndexedDocumentsExpAvg The exponential moving average of the number of new documents that have been
	// indexed.
	IndexedDocumentsExpAvg *string `json:"indexed_documents_exp_avg,omitempty"`
	// LastSearchTime The timestamp of the last search in the source indices.
	// This field is shown only if the transform is running.
	LastSearchTime *string `json:"last_search_time,omitempty"`
	// MaxPageSearchSize The initial page size that is used for the composite aggregation for each
	// checkpoint.
	MaxPageSearchSize *string `json:"max_page_search_size,omitempty"`
	// PagesProcessed The number of search or bulk index operations processed.
	// Documents are processed in batches instead of individually.
	PagesProcessed *string `json:"pages_processed,omitempty"`
	// Pipeline The unique identifier for the ingest pipeline.
	Pipeline *string `json:"pipeline,omitempty"`
	// ProcessedDocumentsExpAvg The exponential moving average of the number of documents that have been
	// processed.
	ProcessedDocumentsExpAvg *string `json:"processed_documents_exp_avg,omitempty"`
	// ProcessingTime The total time spent processing results, in milliseconds.
	ProcessingTime *string `json:"processing_time,omitempty"`
	// Reason If a transform has a `failed` state, these details describe the reason for
	// failure.
	Reason *string `json:"reason,omitempty"`
	// SearchFailure The total number of search failures.
	SearchFailure *string `json:"search_failure,omitempty"`
	// SearchTime The total amount of search time, in milliseconds.
	SearchTime *string `json:"search_time,omitempty"`
	// SearchTotal The total number of search operations on the source index for the transform.
	SearchTotal *string `json:"search_total,omitempty"`
	// SourceIndex The source indices for the transform.
	SourceIndex *string `json:"source_index,omitempty"`
	// State The status of the transform.
	// Returned values include:
	// `aborting`: The transform is aborting.
	// `failed: The transform failed. For more information about the failure, check
	// the `reason` field.
	// `indexing`: The transform is actively processing data and creating new
	// documents.
	// `started`: The transform is running but not actively indexing data.
	// `stopped`: The transform is stopped.
	// `stopping`: The transform is stopping.
	State *string `json:"state,omitempty"`
	// TransformType The type of transform: `batch` or `continuous`.
	TransformType *string `json:"transform_type,omitempty"`
	// TriggerCount The number of times the transform has been triggered by the scheduler.
	// For example, the scheduler triggers the transform indexer to check for
	// updates or ingest new data at an interval specified in the `frequency`
	// property.
	TriggerCount *string `json:"trigger_count,omitempty"`
	// Version The version of Elasticsearch that existed on the node when the transform was
	// created.
	Version *string `json:"version,omitempty"`
}

TransformsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cat/transforms/types.ts#L22-L197

func NewTransformsRecord added in v8.5.0 

func NewTransformsRecord() *TransformsRecord

NewTransformsRecord returns a TransformsRecord.

func (*TransformsRecord) UnmarshalJSON added in v8.7.1 

func (s *TransformsRecord) UnmarshalJSON(data []byte) error

type Translog 

type Translog struct {
	// Durability Whether or not to `fsync` and commit the translog after every index, delete,
	// update, or bulk request.
	Durability *translogdurability.TranslogDurability `json:"durability,omitempty"`
	// FlushThresholdSize The translog stores all operations that are not yet safely persisted in
	// Lucene (i.e., are not
	// part of a Lucene commit point). Although these operations are available for
	// reads, they will need
	// to be replayed if the shard was stopped and had to be recovered. This setting
	// controls the
	// maximum total size of these operations, to prevent recoveries from taking too
	// long. Once the
	// maximum size has been reached a flush will happen, generating a new Lucene
	// commit point.
	FlushThresholdSize ByteSize           `json:"flush_threshold_size,omitempty"`
	Retention          *TranslogRetention `json:"retention,omitempty"`
	// SyncInterval How often the translog is fsynced to disk and committed, regardless of write
	// operations.
	// Values less than 100ms are not allowed.
	SyncInterval Duration `json:"sync_interval,omitempty"`
}

Translog type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L355-L377

func NewTranslog added in v8.5.0 

func NewTranslog() *Translog

NewTranslog returns a Translog.

func (*Translog) UnmarshalJSON added in v8.7.1 

func (s *Translog) UnmarshalJSON(data []byte) error

type TranslogRetention 

type TranslogRetention struct {
	// Age This controls the maximum duration for which translog files are kept by each
	// shard. Keeping more
	// translog files increases the chance of performing an operation based sync
	// when recovering replicas. If
	// the translog files are not sufficient, replica recovery will fall back to a
	// file based sync. This setting
	// is ignored, and should not be set, if soft deletes are enabled. Soft deletes
	// are enabled by default in
	// indices created in Elasticsearch versions 7.0.0 and later.
	Age Duration `json:"age,omitempty"`
	// Size This controls the total size of translog files to keep for each shard.
	// Keeping more translog files increases
	// the chance of performing an operation based sync when recovering a replica.
	// If the translog files are not
	// sufficient, replica recovery will fall back to a file based sync. This
	// setting is ignored, and should not be
	// set, if soft deletes are enabled. Soft deletes are enabled by default in
	// indices created in Elasticsearch
	// versions 7.0.0 and later.
	Size ByteSize `json:"size,omitempty"`
}

TranslogRetention type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/_types/IndexSettings.ts#L396-L415

func NewTranslogRetention added in v8.5.0 

func NewTranslogRetention() *TranslogRetention

NewTranslogRetention returns a TranslogRetention.

func (*TranslogRetention) UnmarshalJSON added in v8.7.1 

func (s *TranslogRetention) UnmarshalJSON(data []byte) error

type TranslogStats 

type TranslogStats struct {
	EarliestLastModifiedAge int64   `json:"earliest_last_modified_age"`
	Operations              int64   `json:"operations"`
	Size                    *string `json:"size,omitempty"`
	SizeInBytes             int64   `json:"size_in_bytes"`
	UncommittedOperations   int     `json:"uncommitted_operations"`
	UncommittedSize         *string `json:"uncommitted_size,omitempty"`
	UncommittedSizeInBytes  int64   `json:"uncommitted_size_in_bytes"`
}

TranslogStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L400-L408

func NewTranslogStats added in v8.5.0 

func NewTranslogStats() *TranslogStats

NewTranslogStats returns a TranslogStats.

func (*TranslogStats) UnmarshalJSON added in v8.7.1 

func (s *TranslogStats) UnmarshalJSON(data []byte) error

type TranslogStatus 

type TranslogStatus struct {
	Percent           Percentage `json:"percent"`
	Recovered         int64      `json:"recovered"`
	Total             int64      `json:"total"`
	TotalOnStart      int64      `json:"total_on_start"`
	TotalTime         Duration   `json:"total_time,omitempty"`
	TotalTimeInMillis int64      `json:"total_time_in_millis"`
}

TranslogStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L102-L109

func NewTranslogStatus added in v8.5.0 

func NewTranslogStatus() *TranslogStatus

NewTranslogStatus returns a TranslogStatus.

func (*TranslogStatus) UnmarshalJSON added in v8.7.1 

func (s *TranslogStatus) UnmarshalJSON(data []byte) error

type Transport 

type Transport struct {
	// InboundHandlingTimeHistogram The distribution of the time spent handling each inbound message on a
	// transport thread, represented as a histogram.
	InboundHandlingTimeHistogram []TransportHistogram `json:"inbound_handling_time_histogram,omitempty"`
	// OutboundHandlingTimeHistogram The distribution of the time spent sending each outbound transport message on
	// a transport thread, represented as a histogram.
	OutboundHandlingTimeHistogram []TransportHistogram `json:"outbound_handling_time_histogram,omitempty"`
	// RxCount Total number of RX (receive) packets received by the node during internal
	// cluster communication.
	RxCount *int64 `json:"rx_count,omitempty"`
	// RxSize Size of RX packets received by the node during internal cluster
	// communication.
	RxSize *string `json:"rx_size,omitempty"`
	// RxSizeInBytes Size, in bytes, of RX packets received by the node during internal cluster
	// communication.
	RxSizeInBytes *int64 `json:"rx_size_in_bytes,omitempty"`
	// ServerOpen Current number of inbound TCP connections used for internal communication
	// between nodes.
	ServerOpen *int `json:"server_open,omitempty"`
	// TotalOutboundConnections The cumulative number of outbound transport connections that this node has
	// opened since it started.
	// Each transport connection may comprise multiple TCP connections but is only
	// counted once in this statistic.
	// Transport connections are typically long-lived so this statistic should
	// remain constant in a stable cluster.
	TotalOutboundConnections *int64 `json:"total_outbound_connections,omitempty"`
	// TxCount Total number of TX (transmit) packets sent by the node during internal
	// cluster communication.
	TxCount *int64 `json:"tx_count,omitempty"`
	// TxSize Size of TX packets sent by the node during internal cluster communication.
	TxSize *string `json:"tx_size,omitempty"`
	// TxSizeInBytes Size, in bytes, of TX packets sent by the node during internal cluster
	// communication.
	TxSizeInBytes *int64 `json:"tx_size_in_bytes,omitempty"`
}

Transport type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1118-L1161

func NewTransport added in v8.5.0 

func NewTransport() *Transport

NewTransport returns a Transport.

func (*Transport) UnmarshalJSON added in v8.7.1 

func (s *Transport) UnmarshalJSON(data []byte) error

type TransportHistogram 

type TransportHistogram struct {
	// Count The number of times a transport thread took a period of time within the
	// bounds of this bucket to handle an inbound message.
	Count *int64 `json:"count,omitempty"`
	// GeMillis The inclusive lower bound of the bucket in milliseconds. May be omitted on
	// the first bucket if this bucket has no lower bound.
	GeMillis *int64 `json:"ge_millis,omitempty"`
	// LtMillis The exclusive upper bound of the bucket in milliseconds.
	// May be omitted on the last bucket if this bucket has no upper bound.
	LtMillis *int64 `json:"lt_millis,omitempty"`
}

TransportHistogram type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/nodes/_types/Stats.ts#L1163-L1177

func NewTransportHistogram added in v8.5.0 

func NewTransportHistogram() *TransportHistogram

NewTransportHistogram returns a TransportHistogram.

func (*TransportHistogram) UnmarshalJSON added in v8.7.1 

func (s *TransportHistogram) UnmarshalJSON(data []byte) error

type TriggerContainer 

type TriggerContainer struct {
	Schedule *ScheduleContainer `json:"schedule,omitempty"`
}

TriggerContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Trigger.ts#L23-L28

func NewTriggerContainer added in v8.5.0 

func NewTriggerContainer() *TriggerContainer

NewTriggerContainer returns a TriggerContainer.

type TriggerEventContainer 

type TriggerEventContainer struct {
	Schedule *ScheduleTriggerEvent `json:"schedule,omitempty"`
}

TriggerEventContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Trigger.ts#L32-L37

func NewTriggerEventContainer added in v8.5.0 

func NewTriggerEventContainer() *TriggerEventContainer

NewTriggerEventContainer returns a TriggerEventContainer.

type TriggerEventResult 

type TriggerEventResult struct {
	Manual        TriggerEventContainer `json:"manual"`
	TriggeredTime DateTime              `json:"triggered_time"`
	Type          string                `json:"type"`
}

TriggerEventResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Trigger.ts#L39-L43

func NewTriggerEventResult added in v8.5.0 

func NewTriggerEventResult() *TriggerEventResult

NewTriggerEventResult returns a TriggerEventResult.

func (*TriggerEventResult) UnmarshalJSON added in v8.7.1 

func (s *TriggerEventResult) UnmarshalJSON(data []byte) error

type TrimProcessor 

type TrimProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The string-valued field to trim whitespace from.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the trimmed value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

TrimProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1543-L1559

func NewTrimProcessor added in v8.5.0 

func NewTrimProcessor() *TrimProcessor

NewTrimProcessor returns a TrimProcessor.

func (*TrimProcessor) UnmarshalJSON added in v8.7.1 

func (s *TrimProcessor) UnmarshalJSON(data []byte) error

type TrimTokenFilter 

type TrimTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

TrimTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L430-L432

func NewTrimTokenFilter added in v8.5.0 

func NewTrimTokenFilter() *TrimTokenFilter

NewTrimTokenFilter returns a TrimTokenFilter.

func (TrimTokenFilter) MarshalJSON added in v8.9.0 

func (s TrimTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*TrimTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *TrimTokenFilter) UnmarshalJSON(data []byte) error

type TruncateTokenFilter 

type TruncateTokenFilter struct {
	// Length Character limit for each token. Tokens exceeding this limit are truncated.
	// Defaults to `10`.
	Length  *int    `json:"length,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

TruncateTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L434-L438

func NewTruncateTokenFilter added in v8.5.0 

func NewTruncateTokenFilter() *TruncateTokenFilter

NewTruncateTokenFilter returns a TruncateTokenFilter.

func (TruncateTokenFilter) MarshalJSON added in v8.9.0 

func (s TruncateTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*TruncateTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *TruncateTokenFilter) UnmarshalJSON(data []byte) error

type TurkishAnalyzer added in v8.16.0 

type TurkishAnalyzer struct {
	StemExclusion []string  `json:"stem_exclusion,omitempty"`
	Stopwords     StopWords `json:"stopwords,omitempty"`
	StopwordsPath *string   `json:"stopwords_path,omitempty"`
	Type          string    `json:"type,omitempty"`
}

TurkishAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L290-L295

func NewTurkishAnalyzer added in v8.16.0 

func NewTurkishAnalyzer() *TurkishAnalyzer

NewTurkishAnalyzer returns a TurkishAnalyzer.

func (TurkishAnalyzer) MarshalJSON added in v8.16.0 

func (s TurkishAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*TurkishAnalyzer) UnmarshalJSON added in v8.16.0 

func (s *TurkishAnalyzer) UnmarshalJSON(data []byte) error

type TypeFieldMappings 

type TypeFieldMappings struct {
	Mappings map[string]FieldMapping `json:"mappings"`
}

TypeFieldMappings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_field_mapping/types.ts#L24-L26

func NewTypeFieldMappings added in v8.5.0 

func NewTypeFieldMappings() *TypeFieldMappings

NewTypeFieldMappings returns a TypeFieldMappings.

type TypeMapping 

type TypeMapping struct {
	AllField             *AllField                      `json:"all_field,omitempty"`
	DataStreamTimestamp_ *DataStreamTimestamp           `json:"_data_stream_timestamp,omitempty"`
	DateDetection        *bool                          `json:"date_detection,omitempty"`
	Dynamic              *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	DynamicDateFormats   []string                       `json:"dynamic_date_formats,omitempty"`
	DynamicTemplates     []map[string]DynamicTemplate   `json:"dynamic_templates,omitempty"`
	Enabled              *bool                          `json:"enabled,omitempty"`
	FieldNames_          *FieldNamesField               `json:"_field_names,omitempty"`
	IndexField           *IndexField                    `json:"index_field,omitempty"`
	Meta_                Metadata                       `json:"_meta,omitempty"`
	NumericDetection     *bool                          `json:"numeric_detection,omitempty"`
	Properties           map[string]Property            `json:"properties,omitempty"`
	Routing_             *RoutingField                  `json:"_routing,omitempty"`
	Runtime              map[string]RuntimeField        `json:"runtime,omitempty"`
	Size_                *SizeField                     `json:"_size,omitempty"`
	Source_              *SourceField                   `json:"_source,omitempty"`
	Subobjects           *subobjects.Subobjects         `json:"subobjects,omitempty"`
}

TypeMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/TypeMapping.ts#L34-L57

func NewTypeMapping added in v8.5.0 

func NewTypeMapping() *TypeMapping

NewTypeMapping returns a TypeMapping.

func (*TypeMapping) UnmarshalJSON added in v8.7.0 

func (s *TypeMapping) UnmarshalJSON(data []byte) error

type TypeQuery 

type TypeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Value      string   `json:"value"`
}

TypeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L301-L303

func NewTypeQuery added in v8.5.0 

func NewTypeQuery() *TypeQuery

NewTypeQuery returns a TypeQuery.

func (*TypeQuery) UnmarshalJSON added in v8.7.1 

func (s *TypeQuery) UnmarshalJSON(data []byte) error

type UaxEmailUrlTokenizer 

type UaxEmailUrlTokenizer struct {
	MaxTokenLength *int    `json:"max_token_length,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

UaxEmailUrlTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L130-L133

func NewUaxEmailUrlTokenizer added in v8.5.0 

func NewUaxEmailUrlTokenizer() *UaxEmailUrlTokenizer

NewUaxEmailUrlTokenizer returns a UaxEmailUrlTokenizer.

func (UaxEmailUrlTokenizer) MarshalJSON added in v8.9.0 

func (s UaxEmailUrlTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*UaxEmailUrlTokenizer) UnmarshalJSON added in v8.7.1 

func (s *UaxEmailUrlTokenizer) UnmarshalJSON(data []byte) error

type UnassignedInformation 

type UnassignedInformation struct {
	AllocationStatus         *string                                                 `json:"allocation_status,omitempty"`
	At                       DateTime                                                `json:"at"`
	Delayed                  *bool                                                   `json:"delayed,omitempty"`
	Details                  *string                                                 `json:"details,omitempty"`
	FailedAllocationAttempts *int                                                    `json:"failed_allocation_attempts,omitempty"`
	LastAllocationStatus     *string                                                 `json:"last_allocation_status,omitempty"`
	Reason                   unassignedinformationreason.UnassignedInformationReason `json:"reason"`
}

UnassignedInformation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/allocation_explain/types.ts#L128-L136

func NewUnassignedInformation added in v8.5.0 

func NewUnassignedInformation() *UnassignedInformation

NewUnassignedInformation returns a UnassignedInformation.

func (*UnassignedInformation) UnmarshalJSON added in v8.7.1 

func (s *UnassignedInformation) UnmarshalJSON(data []byte) error

type UniqueTokenFilter 

type UniqueTokenFilter struct {
	// OnlyOnSamePosition If `true`, only remove duplicate tokens in the same position. Defaults to
	// `false`.
	OnlyOnSamePosition *bool   `json:"only_on_same_position,omitempty"`
	Type               string  `json:"type,omitempty"`
	Version            *string `json:"version,omitempty"`
}

UniqueTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L440-L444

func NewUniqueTokenFilter added in v8.5.0 

func NewUniqueTokenFilter() *UniqueTokenFilter

NewUniqueTokenFilter returns a UniqueTokenFilter.

func (UniqueTokenFilter) MarshalJSON added in v8.9.0 

func (s UniqueTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*UniqueTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *UniqueTokenFilter) UnmarshalJSON(data []byte) error

type UnmappedRareTermsAggregate 

type UnmappedRareTermsAggregate struct {
	Buckets BucketsVoid `json:"buckets"`
	Meta    Metadata    `json:"meta,omitempty"`
}

UnmappedRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L493-L499

func NewUnmappedRareTermsAggregate added in v8.5.0 

func NewUnmappedRareTermsAggregate() *UnmappedRareTermsAggregate

NewUnmappedRareTermsAggregate returns a UnmappedRareTermsAggregate.

func (*UnmappedRareTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *UnmappedRareTermsAggregate) UnmarshalJSON(data []byte) error

type UnmappedSamplerAggregate 

type UnmappedSamplerAggregate struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Meta         Metadata             `json:"meta,omitempty"`
}

UnmappedSamplerAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L561-L562

func NewUnmappedSamplerAggregate added in v8.5.0 

func NewUnmappedSamplerAggregate() *UnmappedSamplerAggregate

NewUnmappedSamplerAggregate returns a UnmappedSamplerAggregate.

func (UnmappedSamplerAggregate) MarshalJSON 

func (s UnmappedSamplerAggregate) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*UnmappedSamplerAggregate) UnmarshalJSON added in v8.7.0 

func (s *UnmappedSamplerAggregate) UnmarshalJSON(data []byte) error

type UnmappedSignificantTermsAggregate 

type UnmappedSignificantTermsAggregate struct {
	BgCount  *int64      `json:"bg_count,omitempty"`
	Buckets  BucketsVoid `json:"buckets"`
	DocCount *int64      `json:"doc_count,omitempty"`
	Meta     Metadata    `json:"meta,omitempty"`
}

UnmappedSignificantTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L690-L696

func NewUnmappedSignificantTermsAggregate added in v8.5.0 

func NewUnmappedSignificantTermsAggregate() *UnmappedSignificantTermsAggregate

NewUnmappedSignificantTermsAggregate returns a UnmappedSignificantTermsAggregate.

func (*UnmappedSignificantTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *UnmappedSignificantTermsAggregate) UnmarshalJSON(data []byte) error

type UnmappedTermsAggregate 

type UnmappedTermsAggregate struct {
	Buckets                 BucketsVoid `json:"buckets"`
	DocCountErrorUpperBound *int64      `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    Metadata    `json:"meta,omitempty"`
	SumOtherDocCount        *int64      `json:"sum_other_doc_count,omitempty"`
}

UnmappedTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L463-L469

func NewUnmappedTermsAggregate added in v8.5.0 

func NewUnmappedTermsAggregate() *UnmappedTermsAggregate

NewUnmappedTermsAggregate returns a UnmappedTermsAggregate.

func (*UnmappedTermsAggregate) UnmarshalJSON added in v8.7.0 

func (s *UnmappedTermsAggregate) UnmarshalJSON(data []byte) error

type UnratedDocument 

type UnratedDocument struct {
	Id_    string `json:"_id"`
	Index_ string `json:"_index"`
}

UnratedDocument type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/rank_eval/types.ts#L150-L153

func NewUnratedDocument added in v8.5.0 

func NewUnratedDocument() *UnratedDocument

NewUnratedDocument returns a UnratedDocument.

func (*UnratedDocument) UnmarshalJSON added in v8.7.1 

func (s *UnratedDocument) UnmarshalJSON(data []byte) error

type UnsignedLongNumberProperty 

type UnsignedLongNumberProperty struct {
	Boost           *Float64                       `json:"boost,omitempty"`
	Coerce          *bool                          `json:"coerce,omitempty"`
	CopyTo          []string                       `json:"copy_to,omitempty"`
	DocValues       *bool                          `json:"doc_values,omitempty"`
	Dynamic         *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields          map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove     *int                           `json:"ignore_above,omitempty"`
	IgnoreMalformed *bool                          `json:"ignore_malformed,omitempty"`
	Index           *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *uint64                                          `json:"null_value,omitempty"`
	OnScriptError       *onscripterror.OnScriptError                     `json:"on_script_error,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Script              *Script                                          `json:"script,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	// TimeSeriesDimension For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesDimension *bool `json:"time_series_dimension,omitempty"`
	// TimeSeriesMetric For internal use by Elastic only. Marks the field as a time series dimension.
	// Defaults to false.
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

UnsignedLongNumberProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L190-L193

func NewUnsignedLongNumberProperty added in v8.5.0 

func NewUnsignedLongNumberProperty() *UnsignedLongNumberProperty

NewUnsignedLongNumberProperty returns a UnsignedLongNumberProperty.

func (UnsignedLongNumberProperty) MarshalJSON added in v8.9.0 

func (s UnsignedLongNumberProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*UnsignedLongNumberProperty) UnmarshalJSON added in v8.7.0 

func (s *UnsignedLongNumberProperty) UnmarshalJSON(data []byte) error

type UntypedDecayFunction added in v8.15.0 

type UntypedDecayFunction struct {
	DecayFunctionBase map[string]DecayPlacement `json:"-"`
	// MultiValueMode Determines how the distance is calculated when a field used for computing the
	// decay contains multiple values.
	MultiValueMode *multivaluemode.MultiValueMode `json:"multi_value_mode,omitempty"`
}

UntypedDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/compound.ts#L204-L207

func NewUntypedDecayFunction added in v8.15.0 

func NewUntypedDecayFunction() *UntypedDecayFunction

NewUntypedDecayFunction returns a UntypedDecayFunction.

func (UntypedDecayFunction) MarshalJSON added in v8.15.0 

func (s UntypedDecayFunction) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

type UntypedDistanceFeatureQuery added in v8.15.0 

type UntypedDistanceFeatureQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Field Name of the field used to calculate distances. This field must meet the
	// following criteria:
	// be a `date`, `date_nanos` or `geo_point` field;
	// have an `index` mapping parameter value of `true`, which is the default;
	// have an `doc_values` mapping parameter value of `true`, which is the default.
	Field string `json:"field"`
	// Origin Date or point of origin used to calculate distances.
	// If the `field` value is a `date` or `date_nanos` field, the `origin` value
	// must be a date.
	// Date Math, such as `now-1h`, is supported.
	// If the field value is a `geo_point` field, the `origin` value must be a
	// geopoint.
	Origin json.RawMessage `json:"origin,omitempty"`
	// Pivot Distance from the `origin` at which relevance scores receive half of the
	// `boost` value.
	// If the `field` value is a `date` or `date_nanos` field, the `pivot` value
	// must be a time unit, such as `1h` or `10d`. If the `field` value is a
	// `geo_point` field, the `pivot` value must be a distance unit, such as `1km`
	// or `12m`.
	Pivot      json.RawMessage `json:"pivot,omitempty"`
	QueryName_ *string         `json:"_name,omitempty"`
}

UntypedDistanceFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/specialized.ts#L61-L64

func NewUntypedDistanceFeatureQuery added in v8.15.0 

func NewUntypedDistanceFeatureQuery() *UntypedDistanceFeatureQuery

NewUntypedDistanceFeatureQuery returns a UntypedDistanceFeatureQuery.

func (*UntypedDistanceFeatureQuery) UnmarshalJSON added in v8.15.0 

func (s *UntypedDistanceFeatureQuery) UnmarshalJSON(data []byte) error

type UntypedRangeQuery added in v8.15.0 

type UntypedRangeQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Format Date format used to convert `date` values in the query.
	Format *string          `json:"format,omitempty"`
	From   *json.RawMessage `json:"from,omitempty"`
	// Gt Greater than.
	Gt json.RawMessage `json:"gt,omitempty"`
	// Gte Greater than or equal to.
	Gte json.RawMessage `json:"gte,omitempty"`
	// Lt Less than.
	Lt json.RawMessage `json:"lt,omitempty"`
	// Lte Less than or equal to.
	Lte        json.RawMessage `json:"lte,omitempty"`
	QueryName_ *string         `json:"_name,omitempty"`
	// Relation Indicates how the range query matches values for `range` fields.
	Relation *rangerelation.RangeRelation `json:"relation,omitempty"`
	// TimeZone Coordinated Universal Time (UTC) offset or IANA time zone used to convert
	// `date` values in the query to UTC.
	TimeZone *string          `json:"time_zone,omitempty"`
	To       *json.RawMessage `json:"to,omitempty"`
}

UntypedRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L150-L159

func NewUntypedRangeQuery added in v8.15.0 

func NewUntypedRangeQuery() *UntypedRangeQuery

NewUntypedRangeQuery returns a UntypedRangeQuery.

func (*UntypedRangeQuery) UnmarshalJSON added in v8.15.0 

func (s *UntypedRangeQuery) UnmarshalJSON(data []byte) error

type UpdateAction added in v8.9.0 

type UpdateAction struct {
	// DetectNoop If true, the `result` in the response is set to 'noop' when no changes to the
	// document occur.
	DetectNoop *bool `json:"detect_noop,omitempty"`
	// Doc A partial update to an existing document.
	Doc json.RawMessage `json:"doc,omitempty"`
	// DocAsUpsert Set to `true` to use the contents of `doc` as the value of `upsert`.
	DocAsUpsert *bool `json:"doc_as_upsert,omitempty"`
	// Script The script to run to update the document.
	Script *Script `json:"script,omitempty"`
	// ScriptedUpsert Set to `true` to run the script whether or not the document exists.
	ScriptedUpsert *bool `json:"scripted_upsert,omitempty"`
	// Source_ If `false`, source retrieval is turned off.
	// You can also specify a comma-separated list of the fields you want to
	// retrieve.
	Source_ SourceConfig `json:"_source,omitempty"`
	// Upsert If the document does not already exist, the contents of `upsert` are inserted
	// as a new document.
	// If the document exists, the `script` is run.
	Upsert json.RawMessage `json:"upsert,omitempty"`
}

UpdateAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L182-L217

func NewUpdateAction added in v8.9.0 

func NewUpdateAction() *UpdateAction

NewUpdateAction returns a UpdateAction.

func (*UpdateAction) UnmarshalJSON added in v8.9.0 

func (s *UpdateAction) UnmarshalJSON(data []byte) error

type UpdateByQueryRethrottleNode 

type UpdateByQueryRethrottleNode struct {
	Attributes       map[string]string   `json:"attributes"`
	Host             string              `json:"host"`
	Ip               string              `json:"ip"`
	Name             string              `json:"name"`
	Roles            []noderole.NodeRole `json:"roles,omitempty"`
	Tasks            map[string]TaskInfo `json:"tasks"`
	TransportAddress string              `json:"transport_address"`
}

UpdateByQueryRethrottleNode type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts#L25-L27

func NewUpdateByQueryRethrottleNode added in v8.5.0 

func NewUpdateByQueryRethrottleNode() *UpdateByQueryRethrottleNode

NewUpdateByQueryRethrottleNode returns a UpdateByQueryRethrottleNode.

func (*UpdateByQueryRethrottleNode) UnmarshalJSON added in v8.7.1 

func (s *UpdateByQueryRethrottleNode) UnmarshalJSON(data []byte) error

type UpdateOperation added in v8.9.0 

type UpdateOperation struct {
	// Id_ The document ID.
	Id_           *string `json:"_id,omitempty"`
	IfPrimaryTerm *int64  `json:"if_primary_term,omitempty"`
	IfSeqNo       *int64  `json:"if_seq_no,omitempty"`
	// Index_ The name of the index or index alias to perform the action on.
	Index_ *string `json:"_index,omitempty"`
	// RequireAlias If `true`, the request's actions must target an index alias.
	RequireAlias *bool `json:"require_alias,omitempty"`
	// RetryOnConflict The number of times an update should be retried in the case of a version
	// conflict.
	RetryOnConflict *int `json:"retry_on_conflict,omitempty"`
	// Routing A custom value used to route operations to a specific shard.
	Routing     *string                  `json:"routing,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

UpdateOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L146-L156

func NewUpdateOperation added in v8.9.0 

func NewUpdateOperation() *UpdateOperation

NewUpdateOperation returns a UpdateOperation.

func (*UpdateOperation) UnmarshalJSON added in v8.9.0 

func (s *UpdateOperation) UnmarshalJSON(data []byte) error

type UppercaseProcessor 

type UppercaseProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to make uppercase.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

UppercaseProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1561-L1577

func NewUppercaseProcessor added in v8.5.0 

func NewUppercaseProcessor() *UppercaseProcessor

NewUppercaseProcessor returns a UppercaseProcessor.

func (*UppercaseProcessor) UnmarshalJSON added in v8.7.1 

func (s *UppercaseProcessor) UnmarshalJSON(data []byte) error

type UppercaseTokenFilter 

type UppercaseTokenFilter struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

UppercaseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L446-L448

func NewUppercaseTokenFilter added in v8.5.0 

func NewUppercaseTokenFilter() *UppercaseTokenFilter

NewUppercaseTokenFilter returns a UppercaseTokenFilter.

func (UppercaseTokenFilter) MarshalJSON added in v8.9.0 

func (s UppercaseTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*UppercaseTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *UppercaseTokenFilter) UnmarshalJSON(data []byte) error

type UriPartsProcessor added in v8.16.0 

type UriPartsProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field Field containing the URI string.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// KeepOriginal If `true`, the processor copies the unparsed URI to
	// `<target_field>.original`.
	KeepOriginal *bool `json:"keep_original,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// RemoveIfSuccessful If `true`, the processor removes the `field` after parsing the URI string.
	// If parsing fails, the processor does not remove the `field`.
	RemoveIfSuccessful *bool `json:"remove_if_successful,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField Output field for the URI object.
	TargetField *string `json:"target_field,omitempty"`
}

UriPartsProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1597-L1623

func NewUriPartsProcessor added in v8.16.0 

func NewUriPartsProcessor() *UriPartsProcessor

NewUriPartsProcessor returns a UriPartsProcessor.

func (*UriPartsProcessor) UnmarshalJSON added in v8.16.0 

func (s *UriPartsProcessor) UnmarshalJSON(data []byte) error

type UrlDecodeProcessor 

type UrlDecodeProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// Field The field to decode.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist or is `null`, the processor quietly
	// exits without modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field to assign the converted value to.
	// By default, the field is updated in-place.
	TargetField *string `json:"target_field,omitempty"`
}

UrlDecodeProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L1579-L1595

func NewUrlDecodeProcessor added in v8.5.0 

func NewUrlDecodeProcessor() *UrlDecodeProcessor

NewUrlDecodeProcessor returns a UrlDecodeProcessor.

func (*UrlDecodeProcessor) UnmarshalJSON added in v8.7.1 

func (s *UrlDecodeProcessor) UnmarshalJSON(data []byte) error

type UsagePhase added in v8.18.0 

type UsagePhase struct {
	Actions []string `json:"actions"`
	MinAge  int64    `json:"min_age"`
}

UsagePhase type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L154-L157

func NewUsagePhase added in v8.18.0 

func NewUsagePhase() *UsagePhase

NewUsagePhase returns a UsagePhase.

func (*UsagePhase) UnmarshalJSON added in v8.18.0 

func (s *UsagePhase) UnmarshalJSON(data []byte) error

type UsagePhases added in v8.18.0 

type UsagePhases struct {
	Cold   *UsagePhase `json:"cold,omitempty"`
	Delete *UsagePhase `json:"delete,omitempty"`
	Frozen *UsagePhase `json:"frozen,omitempty"`
	Hot    *UsagePhase `json:"hot,omitempty"`
	Warm   *UsagePhase `json:"warm,omitempty"`
}

UsagePhases type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L159-L165

func NewUsagePhases added in v8.18.0 

func NewUsagePhases() *UsagePhases

NewUsagePhases returns a UsagePhases.

type UsageStatsIndex 

type UsageStatsIndex struct {
	Shards []UsageStatsShards `json:"shards"`
}

UsageStatsIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L41-L43

func NewUsageStatsIndex added in v8.5.0 

func NewUsageStatsIndex() *UsageStatsIndex

NewUsageStatsIndex returns a UsageStatsIndex.

type UsageStatsShards 

type UsageStatsShards struct {
	Routing                 ShardRouting       `json:"routing"`
	Stats                   IndicesShardsStats `json:"stats"`
	TrackingId              string             `json:"tracking_id"`
	TrackingStartedAtMillis int64              `json:"tracking_started_at_millis"`
}

UsageStatsShards type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L45-L50

func NewUsageStatsShards added in v8.5.0 

func NewUsageStatsShards() *UsageStatsShards

NewUsageStatsShards returns a UsageStatsShards.

func (*UsageStatsShards) UnmarshalJSON added in v8.7.1 

func (s *UsageStatsShards) UnmarshalJSON(data []byte) error

type User 

type User struct {
	Email      *string  `json:"email,omitempty"`
	Enabled    bool     `json:"enabled"`
	FullName   *string  `json:"full_name,omitempty"`
	Metadata   Metadata `json:"metadata"`
	ProfileUid *string  `json:"profile_uid,omitempty"`
	Roles      []string `json:"roles"`
	Username   string   `json:"username"`
}

User type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/User.ts#L23-L31

func NewUser added in v8.5.0 

func NewUser() *User

NewUser returns a User.

func (*User) UnmarshalJSON added in v8.7.1 

func (s *User) UnmarshalJSON(data []byte) error

type UserAgentProcessor 

type UserAgentProcessor struct {
	// Description Description of the processor.
	// Useful for describing the purpose of the processor or its configuration.
	Description *string `json:"description,omitempty"`
	// ExtractDeviceType Extracts device type from the user agent string on a best-effort basis.
	ExtractDeviceType *bool `json:"extract_device_type,omitempty"`
	// Field The field containing the user agent string.
	Field string `json:"field"`
	// If Conditionally execute the processor.
	If *string `json:"if,omitempty"`
	// IgnoreFailure Ignore failures for the processor.
	IgnoreFailure *bool `json:"ignore_failure,omitempty"`
	// IgnoreMissing If `true` and `field` does not exist, the processor quietly exits without
	// modifying the document.
	IgnoreMissing *bool `json:"ignore_missing,omitempty"`
	// OnFailure Handle failures for the processor.
	OnFailure []ProcessorContainer `json:"on_failure,omitempty"`
	// Properties Controls what properties are added to `target_field`.
	Properties []useragentproperty.UserAgentProperty `json:"properties,omitempty"`
	// RegexFile The name of the file in the `config/ingest-user-agent` directory containing
	// the regular expressions for parsing the user agent string. Both the directory
	// and the file have to be created before starting Elasticsearch. If not
	// specified, ingest-user-agent will use the `regexes.yaml` from uap-core it
	// ships with.
	RegexFile *string `json:"regex_file,omitempty"`
	// Tag Identifier for the processor.
	// Useful for debugging and metrics.
	Tag *string `json:"tag,omitempty"`
	// TargetField The field that will be filled with the user agent details.
	TargetField *string `json:"target_field,omitempty"`
}

UserAgentProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Processors.ts#L514-L545

func NewUserAgentProcessor added in v8.5.0 

func NewUserAgentProcessor() *UserAgentProcessor

NewUserAgentProcessor returns a UserAgentProcessor.

func (*UserAgentProcessor) UnmarshalJSON added in v8.7.1 

func (s *UserAgentProcessor) UnmarshalJSON(data []byte) error

type UserIndicesPrivileges added in v8.5.0 

type UserIndicesPrivileges struct {
	// AllowRestrictedIndices Set to `true` if using wildcard or regular expressions for patterns that
	// cover restricted indices. Implicitly, restricted indices have limited
	// privileges that can cause pattern tests to fail. If restricted indices are
	// explicitly included in the `names` list, Elasticsearch checks privileges
	// against these indices regardless of the value set for
	// `allow_restricted_indices`.
	AllowRestrictedIndices bool `json:"allow_restricted_indices"`
	// FieldSecurity The document fields that the owners of the role have read access to.
	FieldSecurity []FieldSecurity `json:"field_security,omitempty"`
	// Names A list of indices (or index name patterns) to which the permissions in this
	// entry apply.
	Names []string `json:"names"`
	// Privileges The index level privileges that owners of the role have on the specified
	// indices.
	Privileges []indexprivilege.IndexPrivilege `json:"privileges"`
	// Query Search queries that define the documents the user has access to. A document
	// within the specified indices must match these queries for it to be accessible
	// by the owners of the role.
	Query []IndicesPrivilegesQuery `json:"query,omitempty"`
}

UserIndicesPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/Privileges.ts#L292-L314

func NewUserIndicesPrivileges added in v8.5.0 

func NewUserIndicesPrivileges() *UserIndicesPrivileges

NewUserIndicesPrivileges returns a UserIndicesPrivileges.

func (*UserIndicesPrivileges) UnmarshalJSON added in v8.7.1 

func (s *UserIndicesPrivileges) UnmarshalJSON(data []byte) error

type UserProfile 

type UserProfile struct {
	Data    map[string]json.RawMessage `json:"data"`
	Enabled *bool                      `json:"enabled,omitempty"`
	Labels  map[string]json.RawMessage `json:"labels"`
	Uid     string                     `json:"uid"`
	User    UserProfileUser            `json:"user"`
}

UserProfile type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/UserProfile.ts#L41-L47

func NewUserProfile added in v8.5.0 

func NewUserProfile() *UserProfile

NewUserProfile returns a UserProfile.

func (*UserProfile) UnmarshalJSON added in v8.7.1 

func (s *UserProfile) UnmarshalJSON(data []byte) error

type UserProfileHitMetadata 

type UserProfileHitMetadata struct {
	PrimaryTerm_ int64 `json:"_primary_term"`
	SeqNo_       int64 `json:"_seq_no"`
}

UserProfileHitMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/UserProfile.ts#L27-L30

func NewUserProfileHitMetadata added in v8.5.0 

func NewUserProfileHitMetadata() *UserProfileHitMetadata

NewUserProfileHitMetadata returns a UserProfileHitMetadata.

func (*UserProfileHitMetadata) UnmarshalJSON added in v8.7.1 

func (s *UserProfileHitMetadata) UnmarshalJSON(data []byte) error

type UserProfileUser 

type UserProfileUser struct {
	Email       *string  `json:"email,omitempty"`
	FullName    *string  `json:"full_name,omitempty"`
	RealmDomain *string  `json:"realm_domain,omitempty"`
	RealmName   string   `json:"realm_name"`
	Roles       []string `json:"roles"`
	Username    string   `json:"username"`
}

UserProfileUser type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/UserProfile.ts#L32-L39

func NewUserProfileUser added in v8.5.0 

func NewUserProfileUser() *UserProfileUser

NewUserProfileUser returns a UserProfileUser.

func (*UserProfileUser) UnmarshalJSON added in v8.7.1 

func (s *UserProfileUser) UnmarshalJSON(data []byte) error

type UserProfileWithMetadata 

type UserProfileWithMetadata struct {
	Data             map[string]json.RawMessage `json:"data"`
	Doc_             UserProfileHitMetadata     `json:"_doc"`
	Enabled          *bool                      `json:"enabled,omitempty"`
	Labels           map[string]json.RawMessage `json:"labels"`
	LastSynchronized int64                      `json:"last_synchronized"`
	Uid              string                     `json:"uid"`
	User             UserProfileUser            `json:"user"`
}

UserProfileWithMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/_types/UserProfile.ts#L49-L52

func NewUserProfileWithMetadata added in v8.5.0 

func NewUserProfileWithMetadata() *UserProfileWithMetadata

NewUserProfileWithMetadata returns a UserProfileWithMetadata.

func (*UserProfileWithMetadata) UnmarshalJSON added in v8.7.1 

func (s *UserProfileWithMetadata) UnmarshalJSON(data []byte) error

type UserQueryContainer added in v8.15.0 

type UserQueryContainer struct {
	// Bool matches users matching boolean combinations of other queries.
	Bool *BoolQuery `json:"bool,omitempty"`
	// Exists Returns users that contain an indexed value for a field.
	Exists *ExistsQuery `json:"exists,omitempty"`
	// Ids Returns users based on their IDs.
	// This query uses the user document IDs stored in the `_id` field.
	Ids *IdsQuery `json:"ids,omitempty"`
	// Match Returns users that match a provided text, number, date or boolean value.
	// The provided text is analyzed before matching.
	Match map[string]MatchQuery `json:"match,omitempty"`
	// MatchAll Matches all users, giving them all a `_score` of 1.0.
	MatchAll *MatchAllQuery `json:"match_all,omitempty"`
	// Prefix Returns users that contain a specific prefix in a provided field.
	Prefix map[string]PrefixQuery `json:"prefix,omitempty"`
	// Range Returns users that contain terms within a provided range.
	Range map[string]RangeQuery `json:"range,omitempty"`
	// SimpleQueryString Returns users based on a provided query string, using a parser with a limited
	// but fault-tolerant syntax.
	SimpleQueryString *SimpleQueryStringQuery `json:"simple_query_string,omitempty"`
	// Term Returns users that contain an exact term in a provided field.
	// To return a document, the query term must exactly match the queried field's
	// value, including whitespace and capitalization.
	Term map[string]TermQuery `json:"term,omitempty"`
	// Terms Returns users that contain one or more exact terms in a provided field.
	// To return a document, one or more terms must exactly match a field value,
	// including whitespace and capitalization.
	Terms *TermsQuery `json:"terms,omitempty"`
	// Wildcard Returns users that contain terms matching a wildcard pattern.
	Wildcard map[string]WildcardQuery `json:"wildcard,omitempty"`
}

UserQueryContainer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/query_user/types.ts#L37-L101

func NewUserQueryContainer added in v8.15.0 

func NewUserQueryContainer() *UserQueryContainer

NewUserQueryContainer returns a UserQueryContainer.

func (*UserQueryContainer) UnmarshalJSON added in v8.15.0 

func (s *UserQueryContainer) UnmarshalJSON(data []byte) error

type UserRealm 

type UserRealm struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

UserRealm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/security/get_token/types.ts#L50-L53

func NewUserRealm added in v8.5.0 

func NewUserRealm() *UserRealm

NewUserRealm returns a UserRealm.

func (*UserRealm) UnmarshalJSON added in v8.7.1 

func (s *UserRealm) UnmarshalJSON(data []byte) error

type Validation added in v8.15.0 

type Validation any

Validation holds the union for the following types: 

LessThanValidation
GreaterThanValidation
ListTypeValidation
IncludedInValidation
RegexValidation

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/connector/_types/Connector.ts#L50-L56

type ValidationLoss 

type ValidationLoss struct {
	// FoldValues Validation loss values for every added decision tree during the forest
	// growing procedure.
	FoldValues []string `json:"fold_values"`
	// LossType The type of the loss metric. For example, binomial_logistic.
	LossType string `json:"loss_type"`
}

ValidationLoss type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/DataframeAnalytics.ts#L571-L576

func NewValidationLoss added in v8.5.0 

func NewValidationLoss() *ValidationLoss

NewValidationLoss returns a ValidationLoss.

func (*ValidationLoss) UnmarshalJSON added in v8.9.0 

func (s *ValidationLoss) UnmarshalJSON(data []byte) error

type ValueCountAggregate 

type ValueCountAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

ValueCountAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L231-L236

func NewValueCountAggregate added in v8.5.0 

func NewValueCountAggregate() *ValueCountAggregate

NewValueCountAggregate returns a ValueCountAggregate.

func (*ValueCountAggregate) UnmarshalJSON added in v8.7.1 

func (s *ValueCountAggregate) UnmarshalJSON(data []byte) error

type ValueCountAggregation 

type ValueCountAggregation struct {
	// Field The field on which to run the aggregation.
	Field  *string `json:"field,omitempty"`
	Format *string `json:"format,omitempty"`
	// Missing The value to apply to documents that do not have a value.
	// By default, documents without a value are ignored.
	Missing Missing `json:"missing,omitempty"`
	Script  *Script `json:"script,omitempty"`
}

ValueCountAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L434-L434

func NewValueCountAggregation added in v8.5.0 

func NewValueCountAggregation() *ValueCountAggregation

NewValueCountAggregation returns a ValueCountAggregation.

func (*ValueCountAggregation) UnmarshalJSON added in v8.7.1 

func (s *ValueCountAggregation) UnmarshalJSON(data []byte) error

type VariableWidthHistogramAggregate 

type VariableWidthHistogramAggregate struct {
	Buckets BucketsVariableWidthHistogramBucket `json:"buckets"`
	Meta    Metadata                            `json:"meta,omitempty"`
}

VariableWidthHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L402-L404

func NewVariableWidthHistogramAggregate added in v8.5.0 

func NewVariableWidthHistogramAggregate() *VariableWidthHistogramAggregate

NewVariableWidthHistogramAggregate returns a VariableWidthHistogramAggregate.

func (*VariableWidthHistogramAggregate) UnmarshalJSON added in v8.7.0 

func (s *VariableWidthHistogramAggregate) UnmarshalJSON(data []byte) error

type VariableWidthHistogramAggregation 

type VariableWidthHistogramAggregation struct {
	// Buckets The target number of buckets.
	Buckets *int `json:"buckets,omitempty"`
	// Field The name of the field.
	Field *string `json:"field,omitempty"`
	// InitialBuffer Specifies the number of individual documents that will be stored in memory on
	// a shard before the initial bucketing algorithm is run.
	// Defaults to `min(10 * shard_size, 50000)`.
	InitialBuffer *int    `json:"initial_buffer,omitempty"`
	Script        *Script `json:"script,omitempty"`
	// ShardSize The number of buckets that the coordinating node will request from each
	// shard.
	// Defaults to `buckets * 50`.
	ShardSize *int `json:"shard_size,omitempty"`
}

VariableWidthHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/bucket.ts#L1091-L1115

func NewVariableWidthHistogramAggregation added in v8.5.0 

func NewVariableWidthHistogramAggregation() *VariableWidthHistogramAggregation

NewVariableWidthHistogramAggregation returns a VariableWidthHistogramAggregation.

func (*VariableWidthHistogramAggregation) UnmarshalJSON added in v8.7.1 

func (s *VariableWidthHistogramAggregation) UnmarshalJSON(data []byte) error

type VariableWidthHistogramBucket 

type VariableWidthHistogramBucket struct {
	Aggregations map[string]Aggregate `json:"-"`
	DocCount     int64                `json:"doc_count"`
	Key          Float64              `json:"key"`
	KeyAsString  *string              `json:"key_as_string,omitempty"`
	Max          Float64              `json:"max"`
	MaxAsString  *string              `json:"max_as_string,omitempty"`
	Min          Float64              `json:"min"`
	MinAsString  *string              `json:"min_as_string,omitempty"`
}

VariableWidthHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L406-L413

func NewVariableWidthHistogramBucket added in v8.5.0 

func NewVariableWidthHistogramBucket() *VariableWidthHistogramBucket

NewVariableWidthHistogramBucket returns a VariableWidthHistogramBucket.

func (VariableWidthHistogramBucket) MarshalJSON 

func (s VariableWidthHistogramBucket) MarshalJSON() ([]byte, error)

MarhsalJSON overrides marshalling for types with additional properties

func (*VariableWidthHistogramBucket) UnmarshalJSON added in v8.7.0 

func (s *VariableWidthHistogramBucket) UnmarshalJSON(data []byte) error

type Vector 

type Vector struct {
	Available               bool `json:"available"`
	DenseVectorDimsAvgCount int  `json:"dense_vector_dims_avg_count"`
	DenseVectorFieldsCount  int  `json:"dense_vector_fields_count"`
	Enabled                 bool `json:"enabled"`
	SparseVectorFieldsCount *int `json:"sparse_vector_fields_count,omitempty"`
}

Vector type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L464-L468

func NewVector added in v8.5.0 

func NewVector() *Vector

NewVector returns a Vector.

func (*Vector) UnmarshalJSON added in v8.7.1 

func (s *Vector) UnmarshalJSON(data []byte) error

type VerifyIndex 

type VerifyIndex struct {
	CheckIndexTime         Duration `json:"check_index_time,omitempty"`
	CheckIndexTimeInMillis int64    `json:"check_index_time_in_millis"`
	TotalTime              Duration `json:"total_time,omitempty"`
	TotalTimeInMillis      int64    `json:"total_time_in_millis"`
}

VerifyIndex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/recovery/types.ts#L111-L116

func NewVerifyIndex added in v8.5.0 

func NewVerifyIndex() *VerifyIndex

NewVerifyIndex returns a VerifyIndex.

func (*VerifyIndex) UnmarshalJSON added in v8.7.1 

func (s *VerifyIndex) UnmarshalJSON(data []byte) error

type VersionProperty 

type VersionProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

VersionProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L314-L316

func NewVersionProperty added in v8.5.0 

func NewVersionProperty() *VersionProperty

NewVersionProperty returns a VersionProperty.

func (VersionProperty) MarshalJSON added in v8.9.0 

func (s VersionProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*VersionProperty) UnmarshalJSON added in v8.7.0 

func (s *VersionProperty) UnmarshalJSON(data []byte) error

type Vertex 

type Vertex struct {
	Depth  int64   `json:"depth"`
	Field  string  `json:"field"`
	Term   string  `json:"term"`
	Weight Float64 `json:"weight"`
}

Vertex type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/Vertex.ts#L23-L28

func NewVertex added in v8.5.0 

func NewVertex() *Vertex

NewVertex returns a Vertex.

func (*Vertex) UnmarshalJSON added in v8.7.1 

func (s *Vertex) UnmarshalJSON(data []byte) error

type VertexDefinition 

type VertexDefinition struct {
	// Exclude Prevents the specified terms from being included in the results.
	Exclude []string `json:"exclude,omitempty"`
	// Field Identifies a field in the documents of interest.
	Field string `json:"field"`
	// Include Identifies the terms of interest that form the starting points from which you
	// want to spider out.
	Include []VertexInclude `json:"include,omitempty"`
	// MinDocCount Specifies how many documents must contain a pair of terms before it is
	// considered to be a useful connection.
	// This setting acts as a certainty threshold.
	MinDocCount *int64 `json:"min_doc_count,omitempty"`
	// ShardMinDocCount Controls how many documents on a particular shard have to contain a pair of
	// terms before the connection is returned for global consideration.
	ShardMinDocCount *int64 `json:"shard_min_doc_count,omitempty"`
	// Size Specifies the maximum number of vertex terms returned for each field.
	Size *int `json:"size,omitempty"`
}

VertexDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/Vertex.ts#L30-L59

func NewVertexDefinition added in v8.5.0 

func NewVertexDefinition() *VertexDefinition

NewVertexDefinition returns a VertexDefinition.

func (*VertexDefinition) UnmarshalJSON added in v8.7.1 

func (s *VertexDefinition) UnmarshalJSON(data []byte) error

type VertexInclude 

type VertexInclude struct {
	Boost Float64 `json:"boost"`
	Term  string  `json:"term"`
}

VertexInclude type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/graph/_types/Vertex.ts#L61-L64

func NewVertexInclude added in v8.5.0 

func NewVertexInclude() *VertexInclude

NewVertexInclude returns a VertexInclude.

func (*VertexInclude) UnmarshalJSON added in v8.7.1 

func (s *VertexInclude) UnmarshalJSON(data []byte) error

type Vocabulary added in v8.7.0 

type Vocabulary struct {
	Index string `json:"index"`
}

Vocabulary type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L248-L250

func NewVocabulary added in v8.7.0 

func NewVocabulary() *Vocabulary

NewVocabulary returns a Vocabulary.

func (*Vocabulary) UnmarshalJSON added in v8.7.1 

func (s *Vocabulary) UnmarshalJSON(data []byte) error

type VoyageAIServiceSettings added in v8.18.0 

type VoyageAIServiceSettings struct {
	// Dimensions The number of dimensions for resulting output embeddings.
	// This setting maps to `output_dimension` in the VoyageAI documentation.
	// Only for the `text_embedding` task type.
	Dimensions *int `json:"dimensions,omitempty"`
	// EmbeddingType The data type for the embeddings to be returned.
	// This setting maps to `output_dtype` in the VoyageAI documentation.
	// Permitted values: float, int8, bit.
	// `int8` is a synonym of `byte` in the VoyageAI documentation.
	// `bit` is a synonym of `binary` in the VoyageAI documentation.
	// Only for the `text_embedding` task type.
	EmbeddingType *float32 `json:"embedding_type,omitempty"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the VoyageAI documentation for the list of available text embedding
	// and rerank models.
	ModelId string `json:"model_id"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// VoyageAI.
	// The `voyageai` service sets a default number of requests allowed per minute
	// depending on the task type.
	// For both `text_embedding` and `rerank`, it is set to `2000`.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
}

VoyageAIServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1148-L1179

func NewVoyageAIServiceSettings added in v8.18.0 

func NewVoyageAIServiceSettings() *VoyageAIServiceSettings

NewVoyageAIServiceSettings returns a VoyageAIServiceSettings.

func (*VoyageAIServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *VoyageAIServiceSettings) UnmarshalJSON(data []byte) error

type VoyageAITaskSettings added in v8.18.0 

type VoyageAITaskSettings struct {
	// InputType Type of the input text.
	// Permitted values: `ingest` (maps to `document` in the VoyageAI
	// documentation), `search` (maps to `query` in the VoyageAI documentation).
	// Only for the `text_embedding` task type.
	InputType *string `json:"input_type,omitempty"`
	// ReturnDocuments Whether to return the source documents in the response.
	// Only for the `rerank` task type.
	ReturnDocuments *bool `json:"return_documents,omitempty"`
	// TopK The number of most relevant documents to return.
	// If not specified, the reranking results of all documents will be returned.
	// Only for the `rerank` task type.
	TopK *int `json:"top_k,omitempty"`
	// Truncation Whether to truncate the input texts to fit within the context length.
	Truncation *bool `json:"truncation,omitempty"`
}

VoyageAITaskSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1181-L1205

func NewVoyageAITaskSettings added in v8.18.0 

func NewVoyageAITaskSettings() *VoyageAITaskSettings

NewVoyageAITaskSettings returns a VoyageAITaskSettings.

func (*VoyageAITaskSettings) UnmarshalJSON added in v8.18.0 

func (s *VoyageAITaskSettings) UnmarshalJSON(data []byte) error

type WaitForActiveShards 

type WaitForActiveShards any

WaitForActiveShards holds the union for the following types: 

int
waitforactiveshardoptions.WaitForActiveShardOptions

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/common.ts#L146-L147

type WaitForNodes added in v8.18.0 

type WaitForNodes any

WaitForNodes holds the union for the following types: 

string
int

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/cluster/health/types.ts#L47-L47

type WaitForSnapshotAction added in v8.15.0 

type WaitForSnapshotAction struct {
	Policy string `json:"policy"`
}

WaitForSnapshotAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ilm/_types/Phase.ts#L145-L147

func NewWaitForSnapshotAction added in v8.15.0 

func NewWaitForSnapshotAction() *WaitForSnapshotAction

NewWaitForSnapshotAction returns a WaitForSnapshotAction.

func (*WaitForSnapshotAction) UnmarshalJSON added in v8.15.0 

func (s *WaitForSnapshotAction) UnmarshalJSON(data []byte) error

type WarmerStats 

type WarmerStats struct {
	Current           int64    `json:"current"`
	Total             int64    `json:"total"`
	TotalTime         Duration `json:"total_time,omitempty"`
	TotalTimeInMillis int64    `json:"total_time_in_millis"`
}

WarmerStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Stats.ts#L410-L415

func NewWarmerStats added in v8.5.0 

func NewWarmerStats() *WarmerStats

NewWarmerStats returns a WarmerStats.

func (*WarmerStats) UnmarshalJSON added in v8.7.1 

func (s *WarmerStats) UnmarshalJSON(data []byte) error

type Watch 

type Watch struct {
	Actions                map[string]WatcherAction `json:"actions"`
	Condition              WatcherCondition         `json:"condition"`
	Input                  WatcherInput             `json:"input"`
	Metadata               Metadata                 `json:"metadata,omitempty"`
	Status                 *WatchStatus             `json:"status,omitempty"`
	ThrottlePeriod         Duration                 `json:"throttle_period,omitempty"`
	ThrottlePeriodInMillis *int64                   `json:"throttle_period_in_millis,omitempty"`
	Transform              *TransformContainer      `json:"transform,omitempty"`
	Trigger                TriggerContainer         `json:"trigger"`
}

Watch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Watch.ts#L37-L47

func NewWatch added in v8.5.0 

func NewWatch() *Watch

NewWatch returns a Watch.

func (*Watch) UnmarshalJSON added in v8.7.1 

func (s *Watch) UnmarshalJSON(data []byte) error

type WatchRecord 

type WatchRecord struct {
	Condition    WatcherCondition                `json:"condition"`
	Input        WatcherInput                    `json:"input"`
	Messages     []string                        `json:"messages"`
	Metadata     Metadata                        `json:"metadata,omitempty"`
	Node         string                          `json:"node"`
	Result       ExecutionResult                 `json:"result"`
	State        executionstatus.ExecutionStatus `json:"state"`
	Status       *WatchStatus                    `json:"status,omitempty"`
	TriggerEvent TriggerEventResult              `json:"trigger_event"`
	User         string                          `json:"user"`
	WatchId      string                          `json:"watch_id"`
}

WatchRecord type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/execute_watch/types.ts#L27-L39

func NewWatchRecord added in v8.5.0 

func NewWatchRecord() *WatchRecord

NewWatchRecord returns a WatchRecord.

func (*WatchRecord) UnmarshalJSON added in v8.7.1 

func (s *WatchRecord) UnmarshalJSON(data []byte) error

type WatchRecordQueuedStats 

type WatchRecordQueuedStats struct {
	// ExecutionTime The time the watch was run.
	// This is just before the input is being run.
	ExecutionTime DateTime `json:"execution_time"`
}

WatchRecordQueuedStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/stats/types.ts#L71-L77

func NewWatchRecordQueuedStats added in v8.5.0 

func NewWatchRecordQueuedStats() *WatchRecordQueuedStats

NewWatchRecordQueuedStats returns a WatchRecordQueuedStats.

func (*WatchRecordQueuedStats) UnmarshalJSON added in v8.7.1 

func (s *WatchRecordQueuedStats) UnmarshalJSON(data []byte) error

type WatchRecordStats 

type WatchRecordStats struct {
	ExecutedActions []string `json:"executed_actions,omitempty"`
	// ExecutionPhase The current watch execution phase.
	ExecutionPhase executionphase.ExecutionPhase `json:"execution_phase"`
	// ExecutionTime The time the watch was run.
	// This is just before the input is being run.
	ExecutionTime DateTime `json:"execution_time"`
	// TriggeredTime The time the watch was triggered by the trigger engine.
	TriggeredTime DateTime `json:"triggered_time"`
	WatchId       string   `json:"watch_id"`
	// WatchRecordId The watch record identifier.
	WatchRecordId string `json:"watch_record_id"`
}

WatchRecordStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/stats/types.ts#L79-L94

func NewWatchRecordStats added in v8.5.0 

func NewWatchRecordStats() *WatchRecordStats

NewWatchRecordStats returns a WatchRecordStats.

func (*WatchRecordStats) UnmarshalJSON added in v8.7.1 

func (s *WatchRecordStats) UnmarshalJSON(data []byte) error

type WatchStatus 

type WatchStatus struct {
	Actions          WatcherStatusActions `json:"actions"`
	ExecutionState   *string              `json:"execution_state,omitempty"`
	LastChecked      DateTime             `json:"last_checked,omitempty"`
	LastMetCondition DateTime             `json:"last_met_condition,omitempty"`
	State            ActivationState      `json:"state"`
	Version          int64                `json:"version"`
}

WatchStatus type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Watch.ts#L49-L56

func NewWatchStatus added in v8.5.0 

func NewWatchStatus() *WatchStatus

NewWatchStatus returns a WatchStatus.

func (*WatchStatus) UnmarshalJSON added in v8.7.1 

func (s *WatchStatus) UnmarshalJSON(data []byte) error

type Watcher 

type Watcher struct {
	Available bool           `json:"available"`
	Count     Counter        `json:"count"`
	Enabled   bool           `json:"enabled"`
	Execution WatcherActions `json:"execution"`
	Watch     WatcherWatch   `json:"watch"`
}

Watcher type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L470-L474

func NewWatcher added in v8.5.0 

func NewWatcher() *Watcher

NewWatcher returns a Watcher.

func (*Watcher) UnmarshalJSON added in v8.7.1 

func (s *Watcher) UnmarshalJSON(data []byte) error

type WatcherAction added in v8.5.0 

type WatcherAction struct {
	ActionType             *actiontype.ActionType `json:"action_type,omitempty"`
	Condition              *WatcherCondition      `json:"condition,omitempty"`
	Email                  *EmailAction           `json:"email,omitempty"`
	Foreach                *string                `json:"foreach,omitempty"`
	Index                  *IndexAction           `json:"index,omitempty"`
	Logging                *LoggingAction         `json:"logging,omitempty"`
	MaxIterations          *int                   `json:"max_iterations,omitempty"`
	Name                   *string                `json:"name,omitempty"`
	Pagerduty              *PagerDutyAction       `json:"pagerduty,omitempty"`
	Slack                  *SlackAction           `json:"slack,omitempty"`
	ThrottlePeriod         Duration               `json:"throttle_period,omitempty"`
	ThrottlePeriodInMillis *int64                 `json:"throttle_period_in_millis,omitempty"`
	Transform              *TransformContainer    `json:"transform,omitempty"`
	Webhook                *WebhookAction         `json:"webhook,omitempty"`
}

WatcherAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L35-L54

func NewWatcherAction added in v8.5.0 

func NewWatcherAction() *WatcherAction

NewWatcherAction returns a WatcherAction.

func (*WatcherAction) UnmarshalJSON added in v8.7.1 

func (s *WatcherAction) UnmarshalJSON(data []byte) error

type WatcherActionTotals 

type WatcherActionTotals struct {
	Total         Duration `json:"total"`
	TotalTimeInMs int64    `json:"total_time_in_ms"`
}

WatcherActionTotals type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L422-L425

func NewWatcherActionTotals added in v8.5.0 

func NewWatcherActionTotals() *WatcherActionTotals

NewWatcherActionTotals returns a WatcherActionTotals.

func (*WatcherActionTotals) UnmarshalJSON added in v8.7.1 

func (s *WatcherActionTotals) UnmarshalJSON(data []byte) error

type WatcherActions 

type WatcherActions struct {
	Actions map[string]WatcherActionTotals `json:"actions"`
}

WatcherActions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L406-L408

func NewWatcherActions added in v8.5.0 

func NewWatcherActions() *WatcherActions

NewWatcherActions returns a WatcherActions.

type WatcherCondition added in v8.5.0 

type WatcherCondition struct {
	Always       *AlwaysCondition                                  `json:"always,omitempty"`
	ArrayCompare map[string]ArrayCompareCondition                  `json:"array_compare,omitempty"`
	Compare      map[string]map[conditionop.ConditionOp]FieldValue `json:"compare,omitempty"`
	Never        *NeverCondition                                   `json:"never,omitempty"`
	Script       *ScriptCondition                                  `json:"script,omitempty"`
}

WatcherCondition type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Conditions.ts#L50-L62

func NewWatcherCondition added in v8.5.0 

func NewWatcherCondition() *WatcherCondition

NewWatcherCondition returns a WatcherCondition.

type WatcherInput added in v8.5.0 

type WatcherInput struct {
	Chain  *ChainInput                `json:"chain,omitempty"`
	Http   *HttpInput                 `json:"http,omitempty"`
	Search *SearchInput               `json:"search,omitempty"`
	Simple map[string]json.RawMessage `json:"simple,omitempty"`
}

WatcherInput type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Input.ts#L87-L95

func NewWatcherInput added in v8.5.0 

func NewWatcherInput() *WatcherInput

NewWatcherInput returns a WatcherInput.

type WatcherNodeStats 

type WatcherNodeStats struct {
	// CurrentWatches The current executing watches metric gives insight into the watches that are
	// currently being executed by Watcher.
	// Additional information is shared per watch that is currently executing.
	// This information includes the `watch_id`, the time its execution started and
	// its current execution phase.
	// To include this metric, the `metric` option should be set to
	// `current_watches` or `_all`.
	// In addition you can also specify the `emit_stacktraces=true` parameter, which
	// adds stack traces for each watch that is being run.
	// These stack traces can give you more insight into an execution of a watch.
	CurrentWatches      []WatchRecordStats  `json:"current_watches,omitempty"`
	ExecutionThreadPool ExecutionThreadPool `json:"execution_thread_pool"`
	NodeId              string              `json:"node_id"`
	// QueuedWatches Watcher moderates the execution of watches such that their execution won't
	// put too much pressure on the node and its resources.
	// If too many watches trigger concurrently and there isn't enough capacity to
	// run them all, some of the watches are queued, waiting for the current running
	// watches to finish.s
	// The queued watches metric gives insight on these queued watches.
	//
	// To include this metric, the `metric` option should include `queued_watches`
	// or `_all`.
	QueuedWatches []WatchRecordQueuedStats `json:"queued_watches,omitempty"`
	// WatchCount The number of watches currently registered.
	WatchCount int64 `json:"watch_count"`
	// WatcherState The current state of Watcher.
	WatcherState watcherstate.WatcherState `json:"watcher_state"`
}

WatcherNodeStats type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/stats/types.ts#L33-L61

func NewWatcherNodeStats added in v8.5.0 

func NewWatcherNodeStats() *WatcherNodeStats

NewWatcherNodeStats returns a WatcherNodeStats.

func (*WatcherNodeStats) UnmarshalJSON added in v8.7.1 

func (s *WatcherNodeStats) UnmarshalJSON(data []byte) error

type WatcherStatusActions added in v8.5.0 

type WatcherStatusActions map[string]ActionStatus

WatcherStatusActions type alias.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Action.ts#L56-L56

type WatcherWatch 

type WatcherWatch struct {
	Action    map[string]Counter  `json:"action,omitempty"`
	Condition map[string]Counter  `json:"condition,omitempty"`
	Input     map[string]Counter  `json:"input"`
	Trigger   WatcherWatchTrigger `json:"trigger"`
}

WatcherWatch type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L410-L415

func NewWatcherWatch added in v8.5.0 

func NewWatcherWatch() *WatcherWatch

NewWatcherWatch returns a WatcherWatch.

type WatcherWatchTrigger 

type WatcherWatchTrigger struct {
	All_     Counter                      `json:"_all"`
	Schedule *WatcherWatchTriggerSchedule `json:"schedule,omitempty"`
}

WatcherWatchTrigger type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L417-L420

func NewWatcherWatchTrigger added in v8.5.0 

func NewWatcherWatchTrigger() *WatcherWatchTrigger

NewWatcherWatchTrigger returns a WatcherWatchTrigger.

type WatcherWatchTriggerSchedule 

type WatcherWatchTriggerSchedule struct {
	Active int64   `json:"active"`
	All_   Counter `json:"_all"`
	Cron   Counter `json:"cron"`
	Total  int64   `json:"total"`
}

WatcherWatchTriggerSchedule type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L476-L479

func NewWatcherWatchTriggerSchedule added in v8.5.0 

func NewWatcherWatchTriggerSchedule() *WatcherWatchTriggerSchedule

NewWatcherWatchTriggerSchedule returns a WatcherWatchTriggerSchedule.

func (*WatcherWatchTriggerSchedule) UnmarshalJSON added in v8.7.1 

func (s *WatcherWatchTriggerSchedule) UnmarshalJSON(data []byte) error

type WatsonxServiceSettings added in v8.18.0 

type WatsonxServiceSettings struct {
	// ApiKey A valid API key of your Watsonx account.
	// You can find your Watsonx API keys or you can create a new one on the API
	// keys page.
	//
	// IMPORTANT: You need to provide the API key only once, during the inference
	// model creation.
	// The get inference endpoint API does not retrieve your API key.
	// After creating the inference model, you cannot change the associated API key.
	// If you want to use a different API key, delete the inference model and
	// recreate it with the same name and the updated API key.
	ApiKey string `json:"api_key"`
	// ApiVersion A version parameter that takes a version date in the format of `YYYY-MM-DD`.
	// For the active version data parameters, refer to the Wastonx documentation.
	ApiVersion string `json:"api_version"`
	// ModelId The name of the model to use for the inference task.
	// Refer to the IBM Embedding Models section in the Watsonx documentation for
	// the list of available text embedding models.
	ModelId string `json:"model_id"`
	// ProjectId The identifier of the IBM Cloud project to use for the inference task.
	ProjectId string `json:"project_id"`
	// RateLimit This setting helps to minimize the number of rate limit errors returned from
	// Watsonx.
	// By default, the `watsonxai` service sets the number of requests allowed per
	// minute to 120.
	RateLimit *RateLimitSetting `json:"rate_limit,omitempty"`
	// Url The URL of the inference endpoint that you created on Watsonx.
	Url string `json:"url"`
}

WatsonxServiceSettings type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/inference/_types/CommonTypes.ts#L1216-L1253

func NewWatsonxServiceSettings added in v8.18.0 

func NewWatsonxServiceSettings() *WatsonxServiceSettings

NewWatsonxServiceSettings returns a WatsonxServiceSettings.

func (*WatsonxServiceSettings) UnmarshalJSON added in v8.18.0 

func (s *WatsonxServiceSettings) UnmarshalJSON(data []byte) error

type Web added in v8.18.0 

type Web struct {
}

Web type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ingest/_types/Database.ts#L61-L61

func NewWeb added in v8.18.0 

func NewWeb() *Web

NewWeb returns a Web.

type WebhookAction 

type WebhookAction struct {
	Auth              *HttpInputAuthentication           `json:"auth,omitempty"`
	Body              *string                            `json:"body,omitempty"`
	ConnectionTimeout Duration                           `json:"connection_timeout,omitempty"`
	Headers           map[string]string                  `json:"headers,omitempty"`
	Host              *string                            `json:"host,omitempty"`
	Method            *httpinputmethod.HttpInputMethod   `json:"method,omitempty"`
	Params            map[string]string                  `json:"params,omitempty"`
	Path              *string                            `json:"path,omitempty"`
	Port              *uint                              `json:"port,omitempty"`
	Proxy             *HttpInputProxy                    `json:"proxy,omitempty"`
	ReadTimeout       Duration                           `json:"read_timeout,omitempty"`
	Scheme            *connectionscheme.ConnectionScheme `json:"scheme,omitempty"`
	Url               *string                            `json:"url,omitempty"`
}

WebhookAction type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L293-L293

func NewWebhookAction added in v8.5.0 

func NewWebhookAction() *WebhookAction

NewWebhookAction returns a WebhookAction.

func (*WebhookAction) UnmarshalJSON added in v8.7.1 

func (s *WebhookAction) UnmarshalJSON(data []byte) error

type WebhookResult 

type WebhookResult struct {
	Request  HttpInputRequestResult   `json:"request"`
	Response *HttpInputResponseResult `json:"response,omitempty"`
}

WebhookResult type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/watcher/_types/Actions.ts#L295-L298

func NewWebhookResult added in v8.5.0 

func NewWebhookResult() *WebhookResult

NewWebhookResult returns a WebhookResult.

type WeightedAverageAggregation 

type WeightedAverageAggregation struct {
	// Format A numeric response formatter.
	Format *string `json:"format,omitempty"`
	// Value Configuration for the field that provides the values.
	Value     *WeightedAverageValue `json:"value,omitempty"`
	ValueType *valuetype.ValueType  `json:"value_type,omitempty"`
	// Weight Configuration for the field or script that provides the weights.
	Weight *WeightedAverageValue `json:"weight,omitempty"`
}

WeightedAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L449-L463

func NewWeightedAverageAggregation added in v8.5.0 

func NewWeightedAverageAggregation() *WeightedAverageAggregation

NewWeightedAverageAggregation returns a WeightedAverageAggregation.

func (*WeightedAverageAggregation) UnmarshalJSON added in v8.7.1 

func (s *WeightedAverageAggregation) UnmarshalJSON(data []byte) error

type WeightedAverageValue 

type WeightedAverageValue struct {
	// Field The field from which to extract the values or weights.
	Field *string `json:"field,omitempty"`
	// Missing A value or weight to use if the field is missing.
	Missing *Float64 `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

WeightedAverageValue type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/metric.ts#L465-L475

func NewWeightedAverageValue added in v8.5.0 

func NewWeightedAverageValue() *WeightedAverageValue

NewWeightedAverageValue returns a WeightedAverageValue.

func (*WeightedAverageValue) UnmarshalJSON added in v8.7.1 

func (s *WeightedAverageValue) UnmarshalJSON(data []byte) error

type WeightedAvgAggregate 

type WeightedAvgAggregate struct {
	Meta Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         *Float64 `json:"value,omitempty"`
	ValueAsString *string  `json:"value_as_string,omitempty"`
}

WeightedAvgAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/aggregations/Aggregate.ts#L224-L229

func NewWeightedAvgAggregate added in v8.5.0 

func NewWeightedAvgAggregate() *WeightedAvgAggregate

NewWeightedAvgAggregate returns a WeightedAvgAggregate.

func (*WeightedAvgAggregate) UnmarshalJSON added in v8.7.1 

func (s *WeightedAvgAggregate) UnmarshalJSON(data []byte) error

type WeightedTokensQuery added in v8.13.0 

type WeightedTokensQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// PruningConfig Token pruning configurations
	PruningConfig *TokenPruningConfig `json:"pruning_config,omitempty"`
	QueryName_    *string             `json:"_name,omitempty"`
	// Tokens The tokens representing this query
	Tokens map[string]float32 `json:"tokens"`
}

WeightedTokensQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/WeightedTokensQuery.ts#L25-L33

func NewWeightedTokensQuery added in v8.13.0 

func NewWeightedTokensQuery() *WeightedTokensQuery

NewWeightedTokensQuery returns a WeightedTokensQuery.

func (*WeightedTokensQuery) UnmarshalJSON added in v8.13.0 

func (s *WeightedTokensQuery) UnmarshalJSON(data []byte) error

type Weights 

type Weights struct {
	Weights Float64 `json:"weights"`
}

Weights type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/put_trained_model/types.ts#L108-L110

func NewWeights added in v8.5.0 

func NewWeights() *Weights

NewWeights returns a Weights.

func (*Weights) UnmarshalJSON added in v8.7.1 

func (s *Weights) UnmarshalJSON(data []byte) error

type WhitespaceAnalyzer 

type WhitespaceAnalyzer struct {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

WhitespaceAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/analyzers.ts#L345-L348

func NewWhitespaceAnalyzer added in v8.5.0 

func NewWhitespaceAnalyzer() *WhitespaceAnalyzer

NewWhitespaceAnalyzer returns a WhitespaceAnalyzer.

func (WhitespaceAnalyzer) MarshalJSON added in v8.9.0 

func (s WhitespaceAnalyzer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*WhitespaceAnalyzer) UnmarshalJSON added in v8.7.1 

func (s *WhitespaceAnalyzer) UnmarshalJSON(data []byte) error

type WhitespaceTokenizer 

type WhitespaceTokenizer struct {
	MaxTokenLength *int    `json:"max_token_length,omitempty"`
	Type           string  `json:"type,omitempty"`
	Version        *string `json:"version,omitempty"`
}

WhitespaceTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/tokenizers.ts#L135-L138

func NewWhitespaceTokenizer added in v8.5.0 

func NewWhitespaceTokenizer() *WhitespaceTokenizer

NewWhitespaceTokenizer returns a WhitespaceTokenizer.

func (WhitespaceTokenizer) MarshalJSON added in v8.9.0 

func (s WhitespaceTokenizer) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*WhitespaceTokenizer) UnmarshalJSON added in v8.7.1 

func (s *WhitespaceTokenizer) UnmarshalJSON(data []byte) error

type WildcardProperty 

type WildcardProperty struct {
	CopyTo      []string                       `json:"copy_to,omitempty"`
	DocValues   *bool                          `json:"doc_values,omitempty"`
	Dynamic     *dynamicmapping.DynamicMapping `json:"dynamic,omitempty"`
	Fields      map[string]Property            `json:"fields,omitempty"`
	IgnoreAbove *int                           `json:"ignore_above,omitempty"`
	// Meta Metadata about the field.
	Meta                map[string]string                                `json:"meta,omitempty"`
	NullValue           *string                                          `json:"null_value,omitempty"`
	Properties          map[string]Property                              `json:"properties,omitempty"`
	Store               *bool                                            `json:"store,omitempty"`
	SyntheticSourceKeep *syntheticsourcekeepenum.SyntheticSourceKeepEnum `json:"synthetic_source_keep,omitempty"`
	Type                string                                           `json:"type,omitempty"`
}

WildcardProperty type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/mapping/core.ts#L318-L325

func NewWildcardProperty added in v8.5.0 

func NewWildcardProperty() *WildcardProperty

NewWildcardProperty returns a WildcardProperty.

func (WildcardProperty) MarshalJSON added in v8.9.0 

func (s WildcardProperty) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*WildcardProperty) UnmarshalJSON added in v8.7.0 

func (s *WildcardProperty) UnmarshalJSON(data []byte) error

type WildcardQuery 

type WildcardQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// CaseInsensitive Allows case insensitive matching of the pattern with the indexed field values
	// when set to true. Default is false which means the case sensitivity of
	// matching depends on the underlying field’s mapping.
	CaseInsensitive *bool   `json:"case_insensitive,omitempty"`
	QueryName_      *string `json:"_name,omitempty"`
	// Rewrite Method used to rewrite the query.
	Rewrite *string `json:"rewrite,omitempty"`
	// Value Wildcard pattern for terms you wish to find in the provided field. Required,
	// when wildcard is not set.
	Value *string `json:"value,omitempty"`
	// Wildcard Wildcard pattern for terms you wish to find in the provided field. Required,
	// when value is not set.
	Wildcard *string `json:"wildcard,omitempty"`
}

WildcardQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/term.ts#L305-L325

func NewWildcardQuery added in v8.5.0 

func NewWildcardQuery() *WildcardQuery

NewWildcardQuery returns a WildcardQuery.

func (*WildcardQuery) UnmarshalJSON added in v8.7.1 

func (s *WildcardQuery) UnmarshalJSON(data []byte) error

type WktGeoBounds 

type WktGeoBounds struct {
	Wkt string `json:"wkt"`
}

WktGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/Geo.ts#L150-L152

func NewWktGeoBounds added in v8.5.0 

func NewWktGeoBounds() *WktGeoBounds

NewWktGeoBounds returns a WktGeoBounds.

func (*WktGeoBounds) UnmarshalJSON added in v8.9.0 

func (s *WktGeoBounds) UnmarshalJSON(data []byte) error

type WordDelimiterGraphTokenFilter 

type WordDelimiterGraphTokenFilter struct {
	// AdjustOffsets If `true`, the filter adjusts the offsets of split or catenated tokens to
	// better reflect their actual position in the token stream. Defaults to `true`.
	AdjustOffsets *bool `json:"adjust_offsets,omitempty"`
	// CatenateAll If `true`, the filter produces catenated tokens for chains of alphanumeric
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateAll *bool `json:"catenate_all,omitempty"`
	// CatenateNumbers If `true`, the filter produces catenated tokens for chains of numeric
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateNumbers *bool `json:"catenate_numbers,omitempty"`
	// CatenateWords If `true`, the filter produces catenated tokens for chains of alphabetical
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateWords *bool `json:"catenate_words,omitempty"`
	// GenerateNumberParts If `true`, the filter includes tokens consisting of only numeric characters
	// in the output. If `false`, the filter excludes these tokens from the output.
	// Defaults to `true`.
	GenerateNumberParts *bool `json:"generate_number_parts,omitempty"`
	// GenerateWordParts If `true`, the filter includes tokens consisting of only alphabetical
	// characters in the output. If `false`, the filter excludes these tokens from
	// the output. Defaults to `true`.
	GenerateWordParts *bool `json:"generate_word_parts,omitempty"`
	// IgnoreKeywords If `true`, the filter skips tokens with a keyword attribute of true. Defaults
	// to `false`.
	IgnoreKeywords *bool `json:"ignore_keywords,omitempty"`
	// PreserveOriginal If `true`, the filter includes the original version of any split tokens in
	// the output. This original version includes non-alphanumeric delimiters.
	// Defaults to `false`.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	// ProtectedWords Array of tokens the filter won’t split.
	ProtectedWords []string `json:"protected_words,omitempty"`
	// ProtectedWordsPath Path to a file that contains a list of tokens the filter won’t split.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each token in the file must be separated by a line
	// break.
	ProtectedWordsPath *string `json:"protected_words_path,omitempty"`
	// SplitOnCaseChange If `true`, the filter splits tokens at letter case transitions. For example:
	// camelCase -> [ camel, Case ]. Defaults to `true`.
	SplitOnCaseChange *bool `json:"split_on_case_change,omitempty"`
	// SplitOnNumerics If `true`, the filter splits tokens at letter-number transitions. For
	// example: j2se -> [ j, 2, se ]. Defaults to `true`.
	SplitOnNumerics *bool `json:"split_on_numerics,omitempty"`
	// StemEnglishPossessive If `true`, the filter removes the English possessive (`'s`) from the end of
	// each token. For example: O'Neil's -> [ O, Neil ]. Defaults to `true`.
	StemEnglishPossessive *bool  `json:"stem_english_possessive,omitempty"`
	Type                  string `json:"type,omitempty"`
	// TypeTable Array of custom type mappings for characters. This allows you to map
	// non-alphanumeric characters as numeric or alphanumeric to avoid splitting on
	// those characters.
	TypeTable []string `json:"type_table,omitempty"`
	// TypeTablePath Path to a file that contains custom type mappings for characters. This allows
	// you to map non-alphanumeric characters as numeric or alphanumeric to avoid
	// splitting on those characters.
	TypeTablePath *string `json:"type_table_path,omitempty"`
	Version       *string `json:"version,omitempty"`
}

WordDelimiterGraphTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L205-L211

func NewWordDelimiterGraphTokenFilter added in v8.5.0 

func NewWordDelimiterGraphTokenFilter() *WordDelimiterGraphTokenFilter

NewWordDelimiterGraphTokenFilter returns a WordDelimiterGraphTokenFilter.

func (WordDelimiterGraphTokenFilter) MarshalJSON added in v8.9.0 

func (s WordDelimiterGraphTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*WordDelimiterGraphTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *WordDelimiterGraphTokenFilter) UnmarshalJSON(data []byte) error

type WordDelimiterTokenFilter 

type WordDelimiterTokenFilter struct {
	// CatenateAll If `true`, the filter produces catenated tokens for chains of alphanumeric
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateAll *bool `json:"catenate_all,omitempty"`
	// CatenateNumbers If `true`, the filter produces catenated tokens for chains of numeric
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateNumbers *bool `json:"catenate_numbers,omitempty"`
	// CatenateWords If `true`, the filter produces catenated tokens for chains of alphabetical
	// characters separated by non-alphabetic delimiters. Defaults to `false`.
	CatenateWords *bool `json:"catenate_words,omitempty"`
	// GenerateNumberParts If `true`, the filter includes tokens consisting of only numeric characters
	// in the output. If `false`, the filter excludes these tokens from the output.
	// Defaults to `true`.
	GenerateNumberParts *bool `json:"generate_number_parts,omitempty"`
	// GenerateWordParts If `true`, the filter includes tokens consisting of only alphabetical
	// characters in the output. If `false`, the filter excludes these tokens from
	// the output. Defaults to `true`.
	GenerateWordParts *bool `json:"generate_word_parts,omitempty"`
	// PreserveOriginal If `true`, the filter includes the original version of any split tokens in
	// the output. This original version includes non-alphanumeric delimiters.
	// Defaults to `false`.
	PreserveOriginal Stringifiedboolean `json:"preserve_original,omitempty"`
	// ProtectedWords Array of tokens the filter won’t split.
	ProtectedWords []string `json:"protected_words,omitempty"`
	// ProtectedWordsPath Path to a file that contains a list of tokens the filter won’t split.
	// This path must be absolute or relative to the `config` location, and the file
	// must be UTF-8 encoded. Each token in the file must be separated by a line
	// break.
	ProtectedWordsPath *string `json:"protected_words_path,omitempty"`
	// SplitOnCaseChange If `true`, the filter splits tokens at letter case transitions. For example:
	// camelCase -> [ camel, Case ]. Defaults to `true`.
	SplitOnCaseChange *bool `json:"split_on_case_change,omitempty"`
	// SplitOnNumerics If `true`, the filter splits tokens at letter-number transitions. For
	// example: j2se -> [ j, 2, se ]. Defaults to `true`.
	SplitOnNumerics *bool `json:"split_on_numerics,omitempty"`
	// StemEnglishPossessive If `true`, the filter removes the English possessive (`'s`) from the end of
	// each token. For example: O'Neil's -> [ O, Neil ]. Defaults to `true`.
	StemEnglishPossessive *bool  `json:"stem_english_possessive,omitempty"`
	Type                  string `json:"type,omitempty"`
	// TypeTable Array of custom type mappings for characters. This allows you to map
	// non-alphanumeric characters as numeric or alphanumeric to avoid splitting on
	// those characters.
	TypeTable []string `json:"type_table,omitempty"`
	// TypeTablePath Path to a file that contains custom type mappings for characters. This allows
	// you to map non-alphanumeric characters as numeric or alphanumeric to avoid
	// splitting on those characters.
	TypeTablePath *string `json:"type_table_path,omitempty"`
	Version       *string `json:"version,omitempty"`
}

WordDelimiterTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/analysis/token_filters.ts#L201-L203

func NewWordDelimiterTokenFilter added in v8.5.0 

func NewWordDelimiterTokenFilter() *WordDelimiterTokenFilter

NewWordDelimiterTokenFilter returns a WordDelimiterTokenFilter.

func (WordDelimiterTokenFilter) MarshalJSON added in v8.9.0 

func (s WordDelimiterTokenFilter) MarshalJSON() ([]byte, error)

MarshalJSON override marshalling to include literal value

func (*WordDelimiterTokenFilter) UnmarshalJSON added in v8.7.1 

func (s *WordDelimiterTokenFilter) UnmarshalJSON(data []byte) error

type WrapperQuery 

type WrapperQuery struct {
	// Boost Floating point number used to decrease or increase the relevance scores of
	// the query.
	// Boost values are relative to the default value of 1.0.
	// A boost value between 0 and 1.0 decreases the relevance score.
	// A value greater than 1.0 increases the relevance score.
	Boost *float32 `json:"boost,omitempty"`
	// Query A base64 encoded query.
	// The binary data format can be any of JSON, YAML, CBOR or SMILE encodings
	Query      string  `json:"query"`
	QueryName_ *string `json:"_name,omitempty"`
}

WrapperQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_types/query_dsl/abstractions.ts#L508-L517

func NewWrapperQuery added in v8.5.0 

func NewWrapperQuery() *WrapperQuery

NewWrapperQuery returns a WrapperQuery.

func (*WrapperQuery) UnmarshalJSON added in v8.7.1 

func (s *WrapperQuery) UnmarshalJSON(data []byte) error

type WriteOperation added in v8.9.0 

type WriteOperation struct {
	// DynamicTemplates A map from the full name of fields to the name of dynamic templates.
	// It defaults to an empty map.
	// If a name matches a dynamic template, that template will be applied
	// regardless of other match predicates defined in the template.
	// If a field is already defined in the mapping, then this parameter won't be
	// used.
	DynamicTemplates map[string]string `json:"dynamic_templates,omitempty"`
	// Id_ The document ID.
	Id_           *string `json:"_id,omitempty"`
	IfPrimaryTerm *int64  `json:"if_primary_term,omitempty"`
	IfSeqNo       *int64  `json:"if_seq_no,omitempty"`
	// Index_ The name of the index or index alias to perform the action on.
	Index_ *string `json:"_index,omitempty"`
	// Pipeline The ID of the pipeline to use to preprocess incoming documents.
	// If the index has a default ingest pipeline specified, setting the value to
	// `_none` turns off the default ingest pipeline for this request.
	// If a final pipeline is configured, it will always run regardless of the value
	// of this parameter.
	Pipeline *string `json:"pipeline,omitempty"`
	// RequireAlias If `true`, the request's actions must target an index alias.
	RequireAlias *bool `json:"require_alias,omitempty"`
	// Routing A custom value used to route operations to a specific shard.
	Routing     *string                  `json:"routing,omitempty"`
	Version     *int64                   `json:"version,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

WriteOperation type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/_global/bulk/types.ts#L119-L138

func NewWriteOperation added in v8.9.0 

func NewWriteOperation() *WriteOperation

NewWriteOperation returns a WriteOperation.

func (*WriteOperation) UnmarshalJSON added in v8.9.0 

func (s *WriteOperation) UnmarshalJSON(data []byte) error

type WriteSummaryInfo added in v8.18.0 

type WriteSummaryInfo struct {
	// Count The number of write operations performed in the test.
	Count int `json:"count"`
	// TotalElapsed The total elapsed time spent on writing blobs in the test.
	TotalElapsed Duration `json:"total_elapsed"`
	// TotalElapsedNanos The total elapsed time spent on writing blobs in the test, in nanoseconds.
	TotalElapsedNanos int64 `json:"total_elapsed_nanos"`
	// TotalSize The total size of all the blobs written in the test.
	TotalSize ByteSize `json:"total_size"`
	// TotalSizeBytes The total size of all the blobs written in the test, in bytes.
	TotalSizeBytes int64 `json:"total_size_bytes"`
	// TotalThrottled The total time spent waiting due to the `max_snapshot_bytes_per_sec`
	// throttle.
	TotalThrottled Duration `json:"total_throttled"`
	// TotalThrottledNanos The total time spent waiting due to the `max_snapshot_bytes_per_sec`
	// throttle, in nanoseconds.
	TotalThrottledNanos int64 `json:"total_throttled_nanos"`
}

WriteSummaryInfo type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/snapshot/repository_analyze/SnapshotAnalyzeRepositoryResponse.ts#L162-L191

func NewWriteSummaryInfo added in v8.18.0 

func NewWriteSummaryInfo() *WriteSummaryInfo

NewWriteSummaryInfo returns a WriteSummaryInfo.

func (*WriteSummaryInfo) UnmarshalJSON added in v8.18.0 

func (s *WriteSummaryInfo) UnmarshalJSON(data []byte) error

type XlmRobertaTokenizationConfig added in v8.18.0 

type XlmRobertaTokenizationConfig struct {
	// DoLowerCase Should the tokenizer lower case the text
	DoLowerCase *bool `json:"do_lower_case,omitempty"`
	// MaxSequenceLength Maximum input sequence length for the model
	MaxSequenceLength *int `json:"max_sequence_length,omitempty"`
	// Span Tokenization spanning options. Special value of -1 indicates no spanning
	// takes place
	Span *int `json:"span,omitempty"`
	// Truncate Should tokenization input be automatically truncated before sending to the
	// model for inference
	Truncate *tokenizationtruncate.TokenizationTruncate `json:"truncate,omitempty"`
	// WithSpecialTokens Is tokenization completed with special tokens
	WithSpecialTokens *bool `json:"with_special_tokens,omitempty"`
}

XlmRobertaTokenizationConfig type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L200-L200

func NewXlmRobertaTokenizationConfig added in v8.18.0 

func NewXlmRobertaTokenizationConfig() *XlmRobertaTokenizationConfig

NewXlmRobertaTokenizationConfig returns a XlmRobertaTokenizationConfig.

func (*XlmRobertaTokenizationConfig) UnmarshalJSON added in v8.18.0 

func (s *XlmRobertaTokenizationConfig) UnmarshalJSON(data []byte) error

type XpackDatafeed added in v8.5.0 

type XpackDatafeed struct {
	Count int64 `json:"count"`
}

XpackDatafeed type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L74-L76

func NewXpackDatafeed added in v8.5.0 

func NewXpackDatafeed() *XpackDatafeed

NewXpackDatafeed returns a XpackDatafeed.

func (*XpackDatafeed) UnmarshalJSON added in v8.7.1 

func (s *XpackDatafeed) UnmarshalJSON(data []byte) error

type XpackFeature added in v8.5.0 

type XpackFeature struct {
	Available      bool                   `json:"available"`
	Description    *string                `json:"description,omitempty"`
	Enabled        bool                   `json:"enabled"`
	NativeCodeInfo *NativeCodeInformation `json:"native_code_info,omitempty"`
}

XpackFeature type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/info/types.ts#L85-L90

func NewXpackFeature added in v8.5.0 

func NewXpackFeature() *XpackFeature

NewXpackFeature returns a XpackFeature.

func (*XpackFeature) UnmarshalJSON added in v8.7.1 

func (s *XpackFeature) UnmarshalJSON(data []byte) error

type XpackFeatures added in v8.7.0 

type XpackFeatures struct {
	AggregateMetric     XpackFeature  `json:"aggregate_metric"`
	Analytics           XpackFeature  `json:"analytics"`
	Archive             XpackFeature  `json:"archive"`
	Ccr                 XpackFeature  `json:"ccr"`
	DataStreams         XpackFeature  `json:"data_streams"`
	DataTiers           XpackFeature  `json:"data_tiers"`
	Enrich              XpackFeature  `json:"enrich"`
	EnterpriseSearch    XpackFeature  `json:"enterprise_search"`
	Eql                 XpackFeature  `json:"eql"`
	Esql                XpackFeature  `json:"esql"`
	FrozenIndices       XpackFeature  `json:"frozen_indices"`
	Graph               XpackFeature  `json:"graph"`
	Ilm                 XpackFeature  `json:"ilm"`
	Logsdb              XpackFeature  `json:"logsdb"`
	Logstash            XpackFeature  `json:"logstash"`
	Ml                  XpackFeature  `json:"ml"`
	Monitoring          XpackFeature  `json:"monitoring"`
	Rollup              XpackFeature  `json:"rollup"`
	RuntimeFields       *XpackFeature `json:"runtime_fields,omitempty"`
	SearchableSnapshots XpackFeature  `json:"searchable_snapshots"`
	Security            XpackFeature  `json:"security"`
	Slm                 XpackFeature  `json:"slm"`
	Spatial             XpackFeature  `json:"spatial"`
	Sql                 XpackFeature  `json:"sql"`
	Transform           XpackFeature  `json:"transform"`
	UniversalProfiling  XpackFeature  `json:"universal_profiling"`
	VotingOnly          XpackFeature  `json:"voting_only"`
	Watcher             XpackFeature  `json:"watcher"`
}

XpackFeatures type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/info/types.ts#L42-L83

func NewXpackFeatures added in v8.7.0 

func NewXpackFeatures() *XpackFeatures

NewXpackFeatures returns a XpackFeatures.

type XpackQuery added in v8.5.0 

type XpackQuery struct {
	Count  *int `json:"count,omitempty"`
	Failed *int `json:"failed,omitempty"`
	Paging *int `json:"paging,omitempty"`
	Total  *int `json:"total,omitempty"`
}

XpackQuery type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L269-L274

func NewXpackQuery added in v8.5.0 

func NewXpackQuery() *XpackQuery

NewXpackQuery returns a XpackQuery.

func (*XpackQuery) UnmarshalJSON added in v8.7.1 

func (s *XpackQuery) UnmarshalJSON(data []byte) error

type XpackRealm added in v8.5.0 

type XpackRealm struct {
	Available                 bool         `json:"available"`
	Cache                     []RealmCache `json:"cache,omitempty"`
	Enabled                   bool         `json:"enabled"`
	HasAuthorizationRealms    []bool       `json:"has_authorization_realms,omitempty"`
	HasDefaultUsernamePattern []bool       `json:"has_default_username_pattern,omitempty"`
	HasTruststore             []bool       `json:"has_truststore,omitempty"`
	IsAuthenticationDelegated []bool       `json:"is_authentication_delegated,omitempty"`
	Name                      []string     `json:"name,omitempty"`
	Order                     []int64      `json:"order,omitempty"`
	Size                      []int64      `json:"size,omitempty"`
}

XpackRealm type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L427-L436

func NewXpackRealm added in v8.5.0 

func NewXpackRealm() *XpackRealm

NewXpackRealm returns a XpackRealm.

func (*XpackRealm) UnmarshalJSON added in v8.7.1 

func (s *XpackRealm) UnmarshalJSON(data []byte) error

type XpackRoleMapping added in v8.5.0 

type XpackRoleMapping struct {
	Enabled int `json:"enabled"`
	Size    int `json:"size"`
}

XpackRoleMapping type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L280-L283

func NewXpackRoleMapping added in v8.5.0 

func NewXpackRoleMapping() *XpackRoleMapping

NewXpackRoleMapping returns a XpackRoleMapping.

func (*XpackRoleMapping) UnmarshalJSON added in v8.7.1 

func (s *XpackRoleMapping) UnmarshalJSON(data []byte) error

type XpackRuntimeFieldTypes added in v8.5.0 

type XpackRuntimeFieldTypes struct {
	Available  bool                `json:"available"`
	Enabled    bool                `json:"enabled"`
	FieldTypes []RuntimeFieldsType `json:"field_types"`
}

XpackRuntimeFieldTypes type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/xpack/usage/types.ts#L285-L287

func NewXpackRuntimeFieldTypes added in v8.5.0 

func NewXpackRuntimeFieldTypes() *XpackRuntimeFieldTypes

NewXpackRuntimeFieldTypes returns a XpackRuntimeFieldTypes.

func (*XpackRuntimeFieldTypes) UnmarshalJSON added in v8.7.1 

func (s *XpackRuntimeFieldTypes) UnmarshalJSON(data []byte) error

type ZeroShotClassificationInferenceOptions 

type ZeroShotClassificationInferenceOptions struct {
	// ClassificationLabels The zero shot classification labels indicating entailment, neutral, and
	// contradiction
	// Must contain exactly and only entailment, neutral, and contradiction
	ClassificationLabels []string `json:"classification_labels"`
	// HypothesisTemplate Hypothesis template used when tokenizing labels for prediction
	HypothesisTemplate *string `json:"hypothesis_template,omitempty"`
	// Labels The labels to predict.
	Labels []string `json:"labels,omitempty"`
	// MultiLabel Indicates if more than one true label exists.
	MultiLabel *bool `json:"multi_label,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *TokenizationConfigContainer `json:"tokenization,omitempty"`
}

ZeroShotClassificationInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L216-L237

func NewZeroShotClassificationInferenceOptions added in v8.5.0 

func NewZeroShotClassificationInferenceOptions() *ZeroShotClassificationInferenceOptions

NewZeroShotClassificationInferenceOptions returns a ZeroShotClassificationInferenceOptions.

func (*ZeroShotClassificationInferenceOptions) UnmarshalJSON added in v8.7.1 

func (s *ZeroShotClassificationInferenceOptions) UnmarshalJSON(data []byte) error

type ZeroShotClassificationInferenceUpdateOptions 

type ZeroShotClassificationInferenceUpdateOptions struct {
	// Labels The labels to predict.
	Labels []string `json:"labels"`
	// MultiLabel Update the configured multi label option. Indicates if more than one true
	// label exists. Defaults to the configured value.
	MultiLabel *bool `json:"multi_label,omitempty"`
	// ResultsField The field that is added to incoming documents to contain the inference
	// prediction. Defaults to predicted_value.
	ResultsField *string `json:"results_field,omitempty"`
	// Tokenization The tokenization options to update when inferring
	Tokenization *NlpTokenizationUpdateOptions `json:"tokenization,omitempty"`
}

ZeroShotClassificationInferenceUpdateOptions type.

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/ml/_types/inference.ts#L393-L402

func NewZeroShotClassificationInferenceUpdateOptions added in v8.5.0 

func NewZeroShotClassificationInferenceUpdateOptions() *ZeroShotClassificationInferenceUpdateOptions

NewZeroShotClassificationInferenceUpdateOptions returns a ZeroShotClassificationInferenceUpdateOptions.

func (*ZeroShotClassificationInferenceUpdateOptions) UnmarshalJSON added in v8.7.1 

func (s *ZeroShotClassificationInferenceUpdateOptions) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis
enums
accesstokengranttype
Package accesstokengranttype
 Package accesstokengranttype
acknowledgementoptions
Package acknowledgementoptions
 Package acknowledgementoptions
actionexecutionmode
Package actionexecutionmode
 Package actionexecutionmode
actionstatusoptions
Package actionstatusoptions
 Package actionstatusoptions
actiontype
Package actiontype
 Package actiontype
alibabacloudservicetype
Package alibabacloudservicetype
 Package alibabacloudservicetype
alibabacloudtasktype
Package alibabacloudtasktype
 Package alibabacloudtasktype
allocationexplaindecision
Package allocationexplaindecision
 Package allocationexplaindecision
amazonbedrockservicetype
Package amazonbedrockservicetype
 Package amazonbedrockservicetype
amazonbedrocktasktype
Package amazonbedrocktasktype
 Package amazonbedrocktasktype
anthropicservicetype
Package anthropicservicetype
 Package anthropicservicetype
anthropictasktype
Package anthropictasktype
 Package anthropictasktype
apikeygranttype
Package apikeygranttype
 Package apikeygranttype
apikeytype
Package apikeytype
 Package apikeytype
appliesto
Package appliesto
 Package appliesto
azureaistudioservicetype
Package azureaistudioservicetype
 Package azureaistudioservicetype
azureaistudiotasktype
Package azureaistudiotasktype
 Package azureaistudiotasktype
azureopenaiservicetype
Package azureopenaiservicetype
 Package azureopenaiservicetype
azureopenaitasktype
Package azureopenaitasktype
 Package azureopenaitasktype
boundaryscanner
Package boundaryscanner
 Package boundaryscanner
bytes
Package bytes
 Package bytes
calendarinterval
Package calendarinterval
 Package calendarinterval
cardinalityexecutionmode
Package cardinalityexecutionmode
 Package cardinalityexecutionmode
catanomalydetectorcolumn
Package catanomalydetectorcolumn
 Package catanomalydetectorcolumn
catdatafeedcolumn
Package catdatafeedcolumn
 Package catdatafeedcolumn
catdfacolumn
Package catdfacolumn
 Package catdfacolumn
categorizationstatus
Package categorizationstatus
 Package categorizationstatus
catnodecolumn
Package catnodecolumn
 Package catnodecolumn
cattrainedmodelscolumn
Package cattrainedmodelscolumn
 Package cattrainedmodelscolumn
cattransformcolumn
Package cattransformcolumn
 Package cattransformcolumn
childscoremode
Package childscoremode
 Package childscoremode
chunkingmode
Package chunkingmode
 Package chunkingmode
cjkbigramignoredscript
Package cjkbigramignoredscript
 Package cjkbigramignoredscript
clusterinfotarget
Package clusterinfotarget
 Package clusterinfotarget
clusterprivilege
Package clusterprivilege
 Package clusterprivilege
clustersearchstatus
Package clustersearchstatus
 Package clustersearchstatus
cohereembeddingtype
Package cohereembeddingtype
 Package cohereembeddingtype
cohereinputtype
Package cohereinputtype
 Package cohereinputtype
cohereservicetype
Package cohereservicetype
 Package cohereservicetype
coheresimilaritytype
Package coheresimilaritytype
 Package coheresimilaritytype
coheretasktype
Package coheretasktype
 Package coheretasktype
coheretruncatetype
Package coheretruncatetype
 Package coheretruncatetype
combinedfieldsoperator
Package combinedfieldsoperator
 Package combinedfieldsoperator
combinedfieldszeroterms
Package combinedfieldszeroterms
 Package combinedfieldszeroterms
conditionop
Package conditionop
 Package conditionop
conditionoperator
Package conditionoperator
 Package conditionoperator
conditiontype
Package conditiontype
 Package conditiontype
conflicts
Package conflicts
 Package conflicts
connectionscheme
Package connectionscheme
 Package connectionscheme
connectorfieldtype
Package connectorfieldtype
 Package connectorfieldtype
connectorstatus
Package connectorstatus
 Package connectorstatus
converttype
Package converttype
 Package converttype
dataattachmentformat
Package dataattachmentformat
 Package dataattachmentformat
datafeedstate
Package datafeedstate
 Package datafeedstate
dataframestate
Package dataframestate
 Package dataframestate
day
Package day
 Package day
decision
Package decision
 Package decision
delimitedpayloadencoding
Package delimitedpayloadencoding
 Package delimitedpayloadencoding
densevectorelementtype
Package densevectorelementtype
 Package densevectorelementtype
densevectorindexoptionstype
Package densevectorindexoptionstype
 Package densevectorindexoptionstype
densevectorsimilarity
Package densevectorsimilarity
 Package densevectorsimilarity
deploymentallocationstate
Package deploymentallocationstate
 Package deploymentallocationstate
deploymentassignmentstate
Package deploymentassignmentstate
 Package deploymentassignmentstate
deprecationlevel
Package deprecationlevel
 Package deprecationlevel
dfiindependencemeasure
Package dfiindependencemeasure
 Package dfiindependencemeasure
dfraftereffect
Package dfraftereffect
 Package dfraftereffect
dfrbasicmodel
Package dfrbasicmodel
 Package dfrbasicmodel
displaytype
Package displaytype
 Package displaytype
distanceunit
Package distanceunit
 Package distanceunit
dynamicmapping
Package dynamicmapping
 Package dynamicmapping
ecscompatibilitytype
Package ecscompatibilitytype
 Package ecscompatibilitytype
edgengramside
Package edgengramside
 Package edgengramside
elasticsearchservicetype
Package elasticsearchservicetype
 Package elasticsearchservicetype
elasticsearchtasktype
Package elasticsearchtasktype
 Package elasticsearchtasktype
elserservicetype
Package elserservicetype
 Package elserservicetype
elsertasktype
Package elsertasktype
 Package elsertasktype
emailpriority
Package emailpriority
 Package emailpriority
enrichpolicyphase
Package enrichpolicyphase
 Package enrichpolicyphase
esqlformat
Package esqlformat
 Package esqlformat
eventtype
Package eventtype
 Package eventtype
excludefrequent
Package excludefrequent
 Package excludefrequent
executionphase
Package executionphase
 Package executionphase
executionstatus
Package executionstatus
 Package executionstatus
expandwildcard
Package expandwildcard
 Package expandwildcard
failurestorestatus
Package failurestorestatus
 Package failurestorestatus
feature
Package feature
 Package feature
fieldsortnumerictype
Package fieldsortnumerictype
 Package fieldsortnumerictype
fieldtype
Package fieldtype
 Package fieldtype
fieldvaluefactormodifier
Package fieldvaluefactormodifier
 Package fieldvaluefactormodifier
filteringpolicy
Package filteringpolicy
 Package filteringpolicy
filteringrulerule
Package filteringrulerule
 Package filteringrulerule
filteringvalidationstate
Package filteringvalidationstate
 Package filteringvalidationstate
filtertype
Package filtertype
 Package filtertype
fingerprintdigest
Package fingerprintdigest
 Package fingerprintdigest
followerindexstatus
Package followerindexstatus
 Package followerindexstatus
formattype
Package formattype
 Package formattype
functionboostmode
Package functionboostmode
 Package functionboostmode
functionscoremode
Package functionscoremode
 Package functionscoremode
gappolicy
Package gappolicy
 Package gappolicy
geodistancetype
Package geodistancetype
 Package geodistancetype
geoexecution
Package geoexecution
 Package geoexecution
geogridtargetformat
Package geogridtargetformat
 Package geogridtargetformat
geogridtiletype
Package geogridtiletype
 Package geogridtiletype
geoorientation
Package geoorientation
 Package geoorientation
geoshaperelation
Package geoshaperelation
 Package geoshaperelation
geostrategy
Package geostrategy
 Package geostrategy
geovalidationmethod
Package geovalidationmethod
 Package geovalidationmethod
googleaiservicetype
Package googleaiservicetype
 Package googleaiservicetype
googleaistudiotasktype
Package googleaistudiotasktype
 Package googleaistudiotasktype
googlevertexaiservicetype
Package googlevertexaiservicetype
 Package googlevertexaiservicetype
googlevertexaitasktype
Package googlevertexaitasktype
 Package googlevertexaitasktype
granttype
Package granttype
 Package granttype
gridaggregationtype
Package gridaggregationtype
 Package gridaggregationtype
gridtype
Package gridtype
 Package gridtype
groupby
Package groupby
 Package groupby
healthstatus
Package healthstatus
 Package healthstatus
highlighterencoder
Package highlighterencoder
 Package highlighterencoder
highlighterfragmenter
Package highlighterfragmenter
 Package highlighterfragmenter
highlighterorder
Package highlighterorder
 Package highlighterorder
highlightertagsschema
Package highlightertagsschema
 Package highlightertagsschema
highlightertype
Package highlightertype
 Package highlightertype
holtwinterstype
Package holtwinterstype
 Package holtwinterstype
httpinputmethod
Package httpinputmethod
 Package httpinputmethod
huggingfaceservicetype
Package huggingfaceservicetype
 Package huggingfaceservicetype
huggingfacetasktype
Package huggingfacetasktype
 Package huggingfacetasktype
ibdistribution
Package ibdistribution
 Package ibdistribution
iblambda
Package iblambda
 Package iblambda
icucollationalternate
Package icucollationalternate
 Package icucollationalternate
icucollationcasefirst
Package icucollationcasefirst
 Package icucollationcasefirst
icucollationdecomposition
Package icucollationdecomposition
 Package icucollationdecomposition
icucollationstrength
Package icucollationstrength
 Package icucollationstrength
icunormalizationmode
Package icunormalizationmode
 Package icunormalizationmode
icunormalizationtype
Package icunormalizationtype
 Package icunormalizationtype
icutransformdirection
Package icutransformdirection
 Package icutransformdirection
impactarea
Package impactarea
 Package impactarea
include
Package include
 Package include
indexcheckonstartup
Package indexcheckonstartup
 Package indexcheckonstartup
indexingjobstate
Package indexingjobstate
 Package indexingjobstate
indexmetadatastate
Package indexmetadatastate
 Package indexmetadatastate
indexoptions
Package indexoptions
 Package indexoptions
indexprivilege
Package indexprivilege
 Package indexprivilege
indexroutingallocationoptions
Package indexroutingallocationoptions
 Package indexroutingallocationoptions
indexroutingrebalanceoptions
Package indexroutingrebalanceoptions
 Package indexroutingrebalanceoptions
indicatorhealthstatus
Package indicatorhealthstatus
 Package indicatorhealthstatus
indicesblockoptions
Package indicesblockoptions
 Package indicesblockoptions
inputtype
Package inputtype
 Package inputtype
jinaaiservicetype
Package jinaaiservicetype
 Package jinaaiservicetype
jinaaisimilaritytype
Package jinaaisimilaritytype
 Package jinaaisimilaritytype
jinaaitasktype
Package jinaaitasktype
 Package jinaaitasktype
jinaaitextembeddingtask
Package jinaaitextembeddingtask
 Package jinaaitextembeddingtask
jobblockedreason
Package jobblockedreason
 Package jobblockedreason
jobstate
Package jobstate
 Package jobstate
jsonprocessorconflictstrategy
Package jsonprocessorconflictstrategy
 Package jsonprocessorconflictstrategy
keeptypesmode
Package keeptypesmode
 Package keeptypesmode
kuromojitokenizationmode
Package kuromojitokenizationmode
 Package kuromojitokenizationmode
level
Package level
 Package level
licensestatus
Package licensestatus
 Package licensestatus
licensetype
Package licensetype
 Package licensetype
lifecycleoperationmode
Package lifecycleoperationmode
 Package lifecycleoperationmode
lowercasetokenfilterlanguages
Package lowercasetokenfilterlanguages
 Package lowercasetokenfilterlanguages
managedby
Package managedby
 Package managedby
matchtype
Package matchtype
 Package matchtype
memorystatus
Package memorystatus
 Package memorystatus
metric
Package metric
 Package metric
migrationstatus
Package migrationstatus
 Package migrationstatus
minimuminterval
Package minimuminterval
 Package minimuminterval
missingorder
Package missingorder
 Package missingorder
mistralservicetype
Package mistralservicetype
 Package mistralservicetype
mistraltasktype
Package mistraltasktype
 Package mistraltasktype
modeenum
Package modeenum
 Package modeenum
month
Package month
 Package month
multivaluemode
Package multivaluemode
 Package multivaluemode
noderole
Package noderole
 Package noderole
noridecompoundmode
Package noridecompoundmode
 Package noridecompoundmode
normalization
Package normalization
 Package normalization
normalizemethod
Package normalizemethod
 Package normalizemethod
numericfielddataformat
Package numericfielddataformat
 Package numericfielddataformat
onscripterror
Package onscripterror
 Package onscripterror
openaiservicetype
Package openaiservicetype
 Package openaiservicetype
openaitasktype
Package openaitasktype
 Package openaitasktype
operationtype
Package operationtype
 Package operationtype
operator
Package operator
 Package operator
optype
Package optype
 Package optype
pagerdutycontexttype
Package pagerdutycontexttype
 Package pagerdutycontexttype
pagerdutyeventtype
Package pagerdutyeventtype
 Package pagerdutyeventtype
painlesscontext
Package painlesscontext
 Package painlesscontext
phoneticencoder
Package phoneticencoder
 Package phoneticencoder
phoneticlanguage
Package phoneticlanguage
 Package phoneticlanguage
phoneticnametype
Package phoneticnametype
 Package phoneticnametype
phoneticruletype
Package phoneticruletype
 Package phoneticruletype
pipelinesimulationstatusoptions
Package pipelinesimulationstatusoptions
 Package pipelinesimulationstatusoptions
policytype
Package policytype
 Package policytype
quantifier
Package quantifier
 Package quantifier
queryrulecriteriatype
Package queryrulecriteriatype
 Package queryrulecriteriatype
queryruletype
Package queryruletype
 Package queryruletype
rangerelation
Package rangerelation
 Package rangerelation
ratemode
Package ratemode
 Package ratemode
refresh
Package refresh
 Package refresh
remoteclusterprivilege
Package remoteclusterprivilege
 Package remoteclusterprivilege
responsecontenttype
Package responsecontenttype
 Package responsecontenttype
restrictionworkflow
Package restrictionworkflow
 Package restrictionworkflow
result
Package result
 Package result
resultposition
Package resultposition
 Package resultposition
routingstate
Package routingstate
 Package routingstate
ruleaction
Package ruleaction
 Package ruleaction
runtimefieldtype
Package runtimefieldtype
 Package runtimefieldtype
sampleraggregationexecutionhint
Package sampleraggregationexecutionhint
 Package sampleraggregationexecutionhint
scoremode
Package scoremode
 Package scoremode
scorenormalizer
Package scorenormalizer
 Package scorenormalizer
scriptlanguage
Package scriptlanguage
 Package scriptlanguage
scriptsorttype
Package scriptsorttype
 Package scriptsorttype
searchtype
Package searchtype
 Package searchtype
segmentsortmissing
Package segmentsortmissing
 Package segmentsortmissing
segmentsortmode
Package segmentsortmode
 Package segmentsortmode
segmentsortorder
Package segmentsortorder
 Package segmentsortorder
shapetype
Package shapetype
 Package shapetype
shardroutingstate
Package shardroutingstate
 Package shardroutingstate
shardsstatsstage
Package shardsstatsstage
 Package shardsstatsstage
shardstoreallocation
Package shardstoreallocation
 Package shardstoreallocation
shardstorestatus
Package shardstorestatus
 Package shardstorestatus
shutdownstatus
Package shutdownstatus
 Package shutdownstatus
shutdowntype
Package shutdowntype
 Package shutdowntype
simplequerystringflag
Package simplequerystringflag
 Package simplequerystringflag
slicescalculation
Package slicescalculation
 Package slicescalculation
snapshotsort
Package snapshotsort
 Package snapshotsort
snapshotupgradestate
Package snapshotupgradestate
 Package snapshotupgradestate
snowballlanguage
Package snowballlanguage
 Package snowballlanguage
sortmode
Package sortmode
 Package sortmode
sortorder
Package sortorder
 Package sortorder
sourcefieldmode
Package sourcefieldmode
 Package sourcefieldmode
sourcemode
Package sourcemode
 Package sourcemode
sqlformat
Package sqlformat
 Package sqlformat
statslevel
Package statslevel
 Package statslevel
stopwordlanguage
Package stopwordlanguage
 Package stopwordlanguage
storagetype
Package storagetype
 Package storagetype
stringdistance
Package stringdistance
 Package stringdistance
subobjects
Package subobjects
 Package subobjects
suggestmode
Package suggestmode
 Package suggestmode
suggestsort
Package suggestsort
 Package suggestsort
syncjobtriggermethod
Package syncjobtriggermethod
 Package syncjobtriggermethod
syncjobtype
Package syncjobtype
 Package syncjobtype
syncstatus
Package syncstatus
 Package syncstatus
synonymformat
Package synonymformat
 Package synonymformat
syntheticsourcekeepenum
Package syntheticsourcekeepenum
 Package syntheticsourcekeepenum
tasktype
Package tasktype
 Package tasktype
tasktypealibabacloudai
Package tasktypealibabacloudai
 Package tasktypealibabacloudai
tasktypeamazonbedrock
Package tasktypeamazonbedrock
 Package tasktypeamazonbedrock
tasktypeanthropic
Package tasktypeanthropic
 Package tasktypeanthropic
tasktypeazureaistudio
Package tasktypeazureaistudio
 Package tasktypeazureaistudio
tasktypeazureopenai
Package tasktypeazureopenai
 Package tasktypeazureopenai
tasktypecohere
Package tasktypecohere
 Package tasktypecohere
tasktypeelasticsearch
Package tasktypeelasticsearch
 Package tasktypeelasticsearch
tasktypeelser
Package tasktypeelser
 Package tasktypeelser
tasktypegoogleaistudio
Package tasktypegoogleaistudio
 Package tasktypegoogleaistudio
tasktypegooglevertexai
Package tasktypegooglevertexai
 Package tasktypegooglevertexai
tasktypehuggingface
Package tasktypehuggingface
 Package tasktypehuggingface
tasktypejinaai
Package tasktypejinaai
 Package tasktypejinaai
tasktypemistral
Package tasktypemistral
 Package tasktypemistral
tasktypeopenai
Package tasktypeopenai
 Package tasktypeopenai
tasktypevoyageai
Package tasktypevoyageai
 Package tasktypevoyageai
tasktypewatsonx
Package tasktypewatsonx
 Package tasktypewatsonx
templateformat
Package templateformat
 Package templateformat
termsaggregationcollectmode
Package termsaggregationcollectmode
 Package termsaggregationcollectmode
termsaggregationexecutionhint
Package termsaggregationexecutionhint
 Package termsaggregationexecutionhint
termvectoroption
Package termvectoroption
 Package termvectoroption
textquerytype
Package textquerytype
 Package textquerytype
threadtype
Package threadtype
 Package threadtype
timeseriesmetrictype
Package timeseriesmetrictype
 Package timeseriesmetrictype
timeunit
Package timeunit
 Package timeunit
tokenchar
Package tokenchar
 Package tokenchar
tokenizationtruncate
Package tokenizationtruncate
 Package tokenizationtruncate
totalhitsrelation
Package totalhitsrelation
 Package totalhitsrelation
trainedmodeltype
Package trainedmodeltype
 Package trainedmodeltype
trainingpriority
Package trainingpriority
 Package trainingpriority
translogdurability
Package translogdurability
 Package translogdurability
ttesttype
Package ttesttype
 Package ttesttype
type_
Package type_
 Package type_
unassignedinformationreason
Package unassignedinformationreason
 Package unassignedinformationreason
useragentproperty
Package useragentproperty
 Package useragentproperty
valuetype
Package valuetype
 Package valuetype
versiontype
Package versiontype
 Package versiontype
voyageaiservicetype
Package voyageaiservicetype
 Package voyageaiservicetype
voyageaitasktype
Package voyageaitasktype
 Package voyageaitasktype
waitforactiveshardoptions
Package waitforactiveshardoptions
 Package waitforactiveshardoptions
waitforevents
Package waitforevents
 Package waitforevents
watchermetric
Package watchermetric
 Package watchermetric
watcherstate
Package watcherstate
 Package watcherstate
watsonxservicetype
Package watsonxservicetype
 Package watsonxservicetype
watsonxtasktype
Package watsonxtasktype
 Package watsonxtasktype
xpackcategory
Package xpackcategory
 Package xpackcategory
zerotermsquery
Package zerotermsquery
 Package zerotermsquery

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.