types

package
v8.6.0 Latest Latest
Warning

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

 Go to latest Published: Jan 11, 2023 License: Apache-2.0 Imports: 170 Imported by: 2,140

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AcknowledgeState ¶ 

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

AcknowledgeState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L112-L115

func NewAcknowledgeState ¶ added in v8.5.0 

func NewAcknowledgeState() *AcknowledgeState

NewAcknowledgeState returns a AcknowledgeState.

type Acknowledgement ¶ 

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

Acknowledgement type.

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

func NewAcknowledgement ¶ added in v8.5.0 

func NewAcknowledgement() *Acknowledgement

NewAcknowledgement returns a Acknowledgement.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L128-L133

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Activation.ts#L24-L27

func NewActivationState ¶ added in v8.5.0 

func NewActivationState() *ActivationState

NewActivationState returns a ActivationState.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Activation.ts#L29-L33

func NewActivationStatus ¶ added in v8.5.0 

func NewActivationStatus() *ActivationStatus

NewActivationStatus returns a ActivationStatus.

type AdaptiveSelection ¶ 

type AdaptiveSelection struct {
	AvgQueueSize      *int64  `json:"avg_queue_size,omitempty"`
	AvgResponseTime   *int64  `json:"avg_response_time,omitempty"`
	AvgResponseTimeNs *int64  `json:"avg_response_time_ns,omitempty"`
	AvgServiceTime    *string `json:"avg_service_time,omitempty"`
	AvgServiceTimeNs  *int64  `json:"avg_service_time_ns,omitempty"`
	OutgoingSearches  *int64  `json:"outgoing_searches,omitempty"`
	Rank              *string `json:"rank,omitempty"`
}

AdaptiveSelection type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L163-L171

func NewAdaptiveSelection ¶ added in v8.5.0 

func NewAdaptiveSelection() *AdaptiveSelection

NewAdaptiveSelection returns a AdaptiveSelection.

type AddAction ¶ 

type AddAction struct {
	Alias         *string  `json:"alias,omitempty"`
	Aliases       []string `json:"aliases,omitempty"`
	Filter        *Query   `json:"filter,omitempty"`
	Index         *string  `json:"index,omitempty"`
	IndexRouting  *string  `json:"index_routing,omitempty"`
	Indices       []string `json:"indices,omitempty"`
	IsHidden      *bool    `json:"is_hidden,omitempty"`
	IsWriteIndex  *bool    `json:"is_write_index,omitempty"`
	MustExist     *bool    `json:"must_exist,omitempty"`
	Routing       *string  `json:"routing,omitempty"`
	SearchRouting *string  `json:"search_routing,omitempty"`
}

AddAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/update_aliases/types.ts#L30-L44

func NewAddAction ¶ added in v8.5.0 

func NewAddAction() *AddAction

NewAddAction returns a AddAction.

type AdjacencyMatrixAggregate ¶ 

type AdjacencyMatrixAggregate struct {
	Buckets BucketsAdjacencyMatrixBucket `json:"buckets"`
	Meta    map[string]interface{}       `json:"meta,omitempty"`
}

AdjacencyMatrixAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L572-L574

func NewAdjacencyMatrixAggregate ¶ added in v8.5.0 

func NewAdjacencyMatrixAggregate() *AdjacencyMatrixAggregate

NewAdjacencyMatrixAggregate returns a AdjacencyMatrixAggregate.

type AdjacencyMatrixAggregation ¶ 

type AdjacencyMatrixAggregation struct {
	Filters map[string]Query       `json:"filters,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
	Name    *string                `json:"name,omitempty"`
}

AdjacencyMatrixAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L48-L50

func NewAdjacencyMatrixAggregation ¶ added in v8.5.0 

func NewAdjacencyMatrixAggregation() *AdjacencyMatrixAggregation

NewAdjacencyMatrixAggregation returns a AdjacencyMatrixAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L576-L578

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

type Aggregate ¶ 

type Aggregate interface {
	// contains filtered or unexported methods
}

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
ScriptedMetricAggregate
TopHitsAggregate
InferenceAggregate
StringStatsAggregate
BoxPlotAggregate
TopMetricsAggregate
TTestAggregate
RateAggregate
CumulativeCardinalityAggregate
MatrixStatsAggregate
GeoLineAggregate

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L38-L122

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"`
	TimeSeriesMetric *timeseriesmetrictype.TimeSeriesMetricType `json:"time_series_metric,omitempty"`
	Type             string                                     `json:"type,omitempty"`
}

AggregateMetricDoubleProperty type.

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

func NewAggregateMetricDoubleProperty ¶ added in v8.5.0 

func NewAggregateMetricDoubleProperty() *AggregateMetricDoubleProperty

NewAggregateMetricDoubleProperty returns a AggregateMetricDoubleProperty.

type AggregateOrder ¶ 

type AggregateOrder interface{}

AggregateOrder holds the union for the following types: 

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

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L403-L405

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
}

Aggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregation.ts#L22-L25

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L23-L36

func NewAggregationBreakdown ¶ added in v8.5.0 

func NewAggregationBreakdown() *AggregationBreakdown

NewAggregationBreakdown returns a AggregationBreakdown.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L77-L84

func NewAggregationProfile ¶ added in v8.5.0 

func NewAggregationProfile() *AggregationProfile

NewAggregationProfile returns a AggregationProfile.

type AggregationProfileDebug ¶ 

type AggregationProfileDebug struct {
	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"`
	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"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L39-L68

func NewAggregationProfileDebug ¶ added in v8.5.0 

func NewAggregationProfileDebug() *AggregationProfileDebug

NewAggregationProfileDebug returns a AggregationProfileDebug.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L70-L75

func NewAggregationProfileDelegateDebugFilter ¶ added in v8.5.0 

func NewAggregationProfileDelegateDebugFilter() *AggregationProfileDelegateDebugFilter

NewAggregationProfileDelegateDebugFilter returns a AggregationProfileDelegateDebugFilter.

type AggregationRange ¶ 

type AggregationRange struct {
	From string  `json:"from,omitempty"`
	Key  *string `json:"key,omitempty"`
	To   string  `json:"to,omitempty"`
}

AggregationRange type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L298-L302

func NewAggregationRange ¶ added in v8.5.0 

func NewAggregationRange() *AggregationRange

NewAggregationRange returns a AggregationRange.

type Aggregations ¶ added in v8.5.0 

type Aggregations struct {
	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       *AutoDateHistogramAggregation       `json:"auto_date_histogram,omitempty"`
	Avg                     *AverageAggregation                 `json:"avg,omitempty"`
	AvgBucket               *AverageBucketAggregation           `json:"avg_bucket,omitempty"`
	Boxplot                 *BoxplotAggregation                 `json:"boxplot,omitempty"`
	BucketCorrelation       *BucketCorrelationAggregation       `json:"bucket_correlation,omitempty"`
	BucketCountKsTest       *BucketKsAggregation                `json:"bucket_count_ks_test,omitempty"`
	BucketScript            *BucketScriptAggregation            `json:"bucket_script,omitempty"`
	BucketSelector          *BucketSelectorAggregation          `json:"bucket_selector,omitempty"`
	BucketSort              *BucketSortAggregation              `json:"bucket_sort,omitempty"`
	Cardinality             *CardinalityAggregation             `json:"cardinality,omitempty"`
	CategorizeText          *CategorizeTextAggregation          `json:"categorize_text,omitempty"`
	Children                *ChildrenAggregation                `json:"children,omitempty"`
	Composite               *CompositeAggregation               `json:"composite,omitempty"`
	CumulativeCardinality   *CumulativeCardinalityAggregation   `json:"cumulative_cardinality,omitempty"`
	CumulativeSum           *CumulativeSumAggregation           `json:"cumulative_sum,omitempty"`
	DateHistogram           *DateHistogramAggregation           `json:"date_histogram,omitempty"`
	DateRange               *DateRangeAggregation               `json:"date_range,omitempty"`
	Derivative              *DerivativeAggregation              `json:"derivative,omitempty"`
	DiversifiedSampler      *DiversifiedSamplerAggregation      `json:"diversified_sampler,omitempty"`
	ExtendedStats           *ExtendedStatsAggregation           `json:"extended_stats,omitempty"`
	ExtendedStatsBucket     *ExtendedStatsBucketAggregation     `json:"extended_stats_bucket,omitempty"`
	Filter                  *Query                              `json:"filter,omitempty"`
	Filters                 *FiltersAggregation                 `json:"filters,omitempty"`
	GeoBounds               *GeoBoundsAggregation               `json:"geo_bounds,omitempty"`
	GeoCentroid             *GeoCentroidAggregation             `json:"geo_centroid,omitempty"`
	GeoDistance             *GeoDistanceAggregation             `json:"geo_distance,omitempty"`
	GeoLine                 *GeoLineAggregation                 `json:"geo_line,omitempty"`
	GeohashGrid             *GeoHashGridAggregation             `json:"geohash_grid,omitempty"`
	GeohexGrid              *GeohexGridAggregation              `json:"geohex_grid,omitempty"`
	GeotileGrid             *GeoTileGridAggregation             `json:"geotile_grid,omitempty"`
	Global                  *GlobalAggregation                  `json:"global,omitempty"`
	Histogram               *HistogramAggregation               `json:"histogram,omitempty"`
	Inference               *InferenceAggregation               `json:"inference,omitempty"`
	IpPrefix                *IpPrefixAggregation                `json:"ip_prefix,omitempty"`
	IpRange                 *IpRangeAggregation                 `json:"ip_range,omitempty"`
	Line                    *GeoLineAggregation                 `json:"line,omitempty"`
	MatrixStats             *MatrixStatsAggregation             `json:"matrix_stats,omitempty"`
	Max                     *MaxAggregation                     `json:"max,omitempty"`
	MaxBucket               *MaxBucketAggregation               `json:"max_bucket,omitempty"`
	MedianAbsoluteDeviation *MedianAbsoluteDeviationAggregation `json:"median_absolute_deviation,omitempty"`
	Meta                    map[string]interface{}              `json:"meta,omitempty"`
	Min                     *MinAggregation                     `json:"min,omitempty"`
	MinBucket               *MinBucketAggregation               `json:"min_bucket,omitempty"`
	Missing                 *MissingAggregation                 `json:"missing,omitempty"`
	MovingAvg               *MovingAverageAggregation           `json:"moving_avg,omitempty"`
	MovingFn                *MovingFunctionAggregation          `json:"moving_fn,omitempty"`
	MovingPercentiles       *MovingPercentilesAggregation       `json:"moving_percentiles,omitempty"`
	MultiTerms              *MultiTermsAggregation              `json:"multi_terms,omitempty"`
	Nested                  *NestedAggregation                  `json:"nested,omitempty"`
	Normalize               *NormalizeAggregation               `json:"normalize,omitempty"`
	Parent                  *ParentAggregation                  `json:"parent,omitempty"`
	PercentileRanks         *PercentileRanksAggregation         `json:"percentile_ranks,omitempty"`
	Percentiles             *PercentilesAggregation             `json:"percentiles,omitempty"`
	PercentilesBucket       *PercentilesBucketAggregation       `json:"percentiles_bucket,omitempty"`
	Range                   *RangeAggregation                   `json:"range,omitempty"`
	RareTerms               *RareTermsAggregation               `json:"rare_terms,omitempty"`
	Rate                    *RateAggregation                    `json:"rate,omitempty"`
	ReverseNested           *ReverseNestedAggregation           `json:"reverse_nested,omitempty"`
	Sampler                 *SamplerAggregation                 `json:"sampler,omitempty"`
	ScriptedMetric          *ScriptedMetricAggregation          `json:"scripted_metric,omitempty"`
	SerialDiff              *SerialDifferencingAggregation      `json:"serial_diff,omitempty"`
	SignificantTerms        *SignificantTermsAggregation        `json:"significant_terms,omitempty"`
	SignificantText         *SignificantTextAggregation         `json:"significant_text,omitempty"`
	Stats                   *StatsAggregation                   `json:"stats,omitempty"`
	StatsBucket             *StatsBucketAggregation             `json:"stats_bucket,omitempty"`
	StringStats             *StringStatsAggregation             `json:"string_stats,omitempty"`
	Sum                     *SumAggregation                     `json:"sum,omitempty"`
	SumBucket               *SumBucketAggregation               `json:"sum_bucket,omitempty"`
	TTest                   *TTestAggregation                   `json:"t_test,omitempty"`
	Terms                   *TermsAggregation                   `json:"terms,omitempty"`
	TopHits                 *TopHitsAggregation                 `json:"top_hits,omitempty"`
	TopMetrics              *TopMetricsAggregation              `json:"top_metrics,omitempty"`
	ValueCount              *ValueCountAggregation              `json:"value_count,omitempty"`
	VariableWidthHistogram  *VariableWidthHistogramAggregation  `json:"variable_width_histogram,omitempty"`
	WeightedAvg             *WeightedAverageAggregation         `json:"weighted_avg,omitempty"`
}

Aggregations type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/AggregationContainer.ts#L105-L209

func NewAggregations ¶ added in v8.5.0 

func NewAggregations() *Aggregations

NewAggregations returns a Aggregations.

type Alias ¶ 

type Alias struct {
	Filter        *Query  `json:"filter,omitempty"`
	IndexRouting  *string `json:"index_routing,omitempty"`
	IsHidden      *bool   `json:"is_hidden,omitempty"`
	IsWriteIndex  *bool   `json:"is_write_index,omitempty"`
	Routing       *string `json:"routing,omitempty"`
	SearchRouting *string `json:"search_routing,omitempty"`
}

Alias type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/Alias.ts#L23-L30

func NewAlias ¶ added in v8.5.0 

func NewAlias() *Alias

NewAlias returns a Alias.

type AliasDefinition ¶ 

type AliasDefinition struct {
	Filter        *Query  `json:"filter,omitempty"`
	IndexRouting  *string `json:"index_routing,omitempty"`
	IsHidden      *bool   `json:"is_hidden,omitempty"`
	IsWriteIndex  *bool   `json:"is_write_index,omitempty"`
	Routing       *string `json:"routing,omitempty"`
	SearchRouting *string `json:"search_routing,omitempty"`
}

AliasDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/AliasDefinition.ts#L22-L30

func NewAliasDefinition ¶ added in v8.5.0 

func NewAliasDefinition() *AliasDefinition

NewAliasDefinition returns a AliasDefinition.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/aliases/types.ts#L22-L53

func NewAliasesRecord ¶ added in v8.5.0 

func NewAliasesRecord() *AliasesRecord

NewAliasesRecord returns a AliasesRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L29-L40

func NewAllField ¶ added in v8.5.0 

func NewAllField() *AllField

NewAllField returns a AllField.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L26-L30

func NewAllocationDecision ¶ added in v8.5.0 

func NewAllocationDecision() *AllocationDecision

NewAllocationDecision returns a AllocationDecision.

type AllocationRecord ¶ 

type AllocationRecord struct {
	// DiskAvail disk available
	DiskAvail ByteSize `json:"disk.avail,omitempty"`
	// DiskIndices disk used by ES indices
	DiskIndices ByteSize `json:"disk.indices,omitempty"`
	// DiskPercent percent disk used
	DiskPercent Percentage `json:"disk.percent,omitempty"`
	// DiskTotal total capacity of all volumes
	DiskTotal ByteSize `json:"disk.total,omitempty"`
	// DiskUsed disk used (total, not just ES)
	DiskUsed ByteSize `json:"disk.used,omitempty"`
	// Host host of node
	Host string `json:"host,omitempty"`
	// Ip ip of node
	Ip string `json:"ip,omitempty"`
	// Node name of node
	Node *string `json:"node,omitempty"`
	// Shards number of shards on node
	Shards *string `json:"shards,omitempty"`
}

AllocationRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/allocation/types.ts#L24-L69

func NewAllocationRecord ¶ added in v8.5.0 

func NewAllocationRecord() *AllocationRecord

NewAllocationRecord returns a AllocationRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L39-L46

func NewAllocationStore ¶ added in v8.5.0 

func NewAllocationStore() *AllocationStore

NewAllocationStore returns a AllocationStore.

type AlwaysCondition ¶ 

type AlwaysCondition struct {
}

AlwaysCondition type.

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

func NewAlwaysCondition ¶ added in v8.5.0 

func NewAlwaysCondition() *AlwaysCondition

NewAlwaysCondition returns a AlwaysCondition.

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.
	// * @server_default 5m
	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. 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L29-L77

func NewAnalysisConfig ¶ added in v8.5.0 

func NewAnalysisConfig() *AnalysisConfig

NewAnalysisConfig returns a AnalysisConfig.

type AnalysisConfigRead ¶ 

type AnalysisConfigRead 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.
	// * @server_default 5m
	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. 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 []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. 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"`
}

AnalysisConfigRead type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L79-L91

func NewAnalysisConfigRead ¶ added in v8.5.0 

func NewAnalysisConfigRead() *AnalysisConfigRead

NewAnalysisConfigRead returns a AnalysisConfigRead.

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 *string `json:"model_memory_limit,omitempty"`
}

AnalysisLimits type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L104-L115

func NewAnalysisLimits ¶ added in v8.5.0 

func NewAnalysisLimits() *AnalysisLimits

NewAnalysisLimits returns a AnalysisLimits.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L117-L122

func NewAnalysisMemoryLimit ¶ added in v8.5.0 

func NewAnalysisMemoryLimit() *AnalysisMemoryLimit

NewAnalysisMemoryLimit returns a AnalysisMemoryLimit.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L315-L317

func NewAnalytics ¶ added in v8.5.0 

func NewAnalytics() *Analytics

NewAnalytics returns a Analytics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L57-L67

func NewAnalyticsStatistics ¶ added in v8.5.0 

func NewAnalyticsStatistics() *AnalyticsStatistics

NewAnalyticsStatistics returns a AnalyticsStatistics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/analyze/types.ts#L24-L30

func NewAnalyzeDetail ¶ added in v8.5.0 

func NewAnalyzeDetail() *AnalyzeDetail

NewAnalyzeDetail returns a AnalyzeDetail.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/analyze/types.ts#L37-L44

func NewAnalyzeToken ¶ added in v8.5.0 

func NewAnalyzeToken() *AnalyzeToken

NewAnalyzeToken returns a AnalyzeToken.

type Analyzer ¶ 

type Analyzer interface {
	// contains filtered or unexported methods
}

Analyzer holds the union for the following types: 

CustomAnalyzer
FingerprintAnalyzer
KeywordAnalyzer
LanguageAnalyzer
NoriAnalyzer
PatternAnalyzer
SimpleAnalyzer
StandardAnalyzer
StopAnalyzer
WhitespaceAnalyzer
IcuAnalyzer
KuromojiAnalyzer
SnowballAnalyzer
DutchAnalyzer

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L113-L131

type AnalyzerDetail ¶ 

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

AnalyzerDetail type.

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

func NewAnalyzerDetail ¶ added in v8.5.0 

func NewAnalyzerDetail() *AnalyzerDetail

NewAnalyzerDetail returns a AnalyzerDetail.

type Anomaly ¶ 

type Anomaly struct {
	Actual []float64 `json:"actual,omitempty"`
	// AnomalyScoreExplanation Information about the factors impacting the initial anomaly score.
	AnomalyScoreExplanation *AnomalyExplanation `json:"anomaly_score_explanation,omitempty"`
	BucketSpan              int64               `json:"bucket_span"`
	ByFieldName             *string             `json:"by_field_name,omitempty"`
	ByFieldValue            *string             `json:"by_field_value,omitempty"`
	Causes                  []AnomalyCause      `json:"causes,omitempty"`
	DetectorIndex           int                 `json:"detector_index"`
	FieldName               *string             `json:"field_name,omitempty"`
	Function                *string             `json:"function,omitempty"`
	FunctionDescription     *string             `json:"function_description,omitempty"`
	Influencers             []Influence         `json:"influencers,omitempty"`
	InitialRecordScore      float64             `json:"initial_record_score"`
	IsInterim               bool                `json:"is_interim"`
	JobId                   string              `json:"job_id"`
	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"`
	RecordScore             float64             `json:"record_score"`
	ResultType              string              `json:"result_type"`
	Timestamp               int64               `json:"timestamp"`
	Typical                 []float64           `json:"typical,omitempty"`
}

Anomaly type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Anomaly.ts#L24-L51

func NewAnomaly ¶ added in v8.5.0 

func NewAnomaly() *Anomaly

NewAnomaly returns a Anomaly.

type AnomalyCause ¶ 

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

AnomalyCause type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Anomaly.ts#L53-L68

func NewAnomalyCause ¶ added in v8.5.0 

func NewAnomalyCause() *AnomalyCause

NewAnomalyCause returns a AnomalyCause.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/info/types.ts#L44-L50

func NewAnomalyDetectors ¶ added in v8.5.0 

func NewAnomalyDetectors() *AnomalyDetectors

NewAnomalyDetectors returns a AnomalyDetectors.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Anomaly.ts#L75-L116

func NewAnomalyExplanation ¶ added in v8.6.0 

func NewAnomalyExplanation() *AnomalyExplanation

NewAnomalyExplanation returns a AnomalyExplanation.

type ApiKey ¶ 

type ApiKey struct {
	Creation        *int64                      `json:"creation,omitempty"`
	Expiration      *int64                      `json:"expiration,omitempty"`
	Id              string                      `json:"id"`
	Invalidated     *bool                       `json:"invalidated,omitempty"`
	LimitedBy       []map[string]RoleDescriptor `json:"limited_by,omitempty"`
	Metadata        map[string]interface{}      `json:"metadata,omitempty"`
	Name            string                      `json:"name"`
	Realm           *string                     `json:"realm,omitempty"`
	RoleDescriptors map[string]RoleDescriptor   `json:"role_descriptors,omitempty"`
	Sort_           []FieldValue                `json:"_sort,omitempty"`
	Username        *string                     `json:"username,omitempty"`
}

ApiKey type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/ApiKey.ts#L27-L41

func NewApiKey ¶ added in v8.5.0 

func NewApiKey() *ApiKey

NewApiKey returns a ApiKey.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Authorization.ts#L20-L29

func NewApiKeyAuthorization ¶ added in v8.5.0 

func NewApiKeyAuthorization() *ApiKeyAuthorization

NewApiKeyAuthorization returns a ApiKeyAuthorization.

type AppendProcessor ¶ 

type AppendProcessor struct {
	AllowDuplicates *bool                `json:"allow_duplicates,omitempty"`
	Description     *string              `json:"description,omitempty"`
	Field           string               `json:"field"`
	If              *string              `json:"if,omitempty"`
	IgnoreFailure   *bool                `json:"ignore_failure,omitempty"`
	OnFailure       []ProcessorContainer `json:"on_failure,omitempty"`
	Tag             *string              `json:"tag,omitempty"`
	Value           []interface{}        `json:"value"`
}

AppendProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L90-L94

func NewAppendProcessor ¶ added in v8.5.0 

func NewAppendProcessor() *AppendProcessor

NewAppendProcessor returns a AppendProcessor.

type ApplicationGlobalUserPrivileges ¶ 

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

ApplicationGlobalUserPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L191-L193

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L26-L39

func NewApplicationPrivileges ¶ added in v8.5.0 

func NewApplicationPrivileges() *ApplicationPrivileges

NewApplicationPrivileges returns a ApplicationPrivileges.

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.
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/has_privileges/types.ts#L24-L31

func NewApplicationPrivilegesCheck ¶ added in v8.5.0 

func NewApplicationPrivilegesCheck() *ApplicationPrivilegesCheck

NewApplicationPrivilegesCheck returns a ApplicationPrivilegesCheck.

type ApplicationsPrivileges ¶ 

type ApplicationsPrivileges map[string]map[string]map[string]bool

ApplicationsPrivileges type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/has_privileges/types.ts#L46-L46

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L44-L46

func NewArchive ¶ added in v8.5.0 

func NewArchive() *Archive

NewArchive returns a Archive.

type ArrayCompareCondition ¶ 

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

ArrayCompareCondition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Conditions.ts#L32-L36

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Conditions.ts#L27-L30

func NewArrayCompareOpParams ¶ added in v8.5.0 

func NewArrayCompareOpParams() *ArrayCompareOpParams

NewArrayCompareOpParams returns a ArrayCompareOpParams.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L159-L163

func NewArrayPercentilesItem ¶ added in v8.5.0 

func NewArrayPercentilesItem() *ArrayPercentilesItem

NewArrayPercentilesItem returns a ArrayPercentilesItem.

type AsciiFoldingTokenFilter ¶ 

type AsciiFoldingTokenFilter struct {
	PreserveOriginal *bool   `json:"preserve_original,omitempty"`
	Type             string  `json:"type,omitempty"`
	Version          *string `json:"version,omitempty"`
}

AsciiFoldingTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L167-L170

func NewAsciiFoldingTokenFilter ¶ added in v8.5.0 

func NewAsciiFoldingTokenFilter() *AsciiFoldingTokenFilter

NewAsciiFoldingTokenFilter returns a AsciiFoldingTokenFilter.

type AsyncSearch ¶ 

type AsyncSearch struct {
	Aggregations    map[string]Aggregate   `json:"aggregations,omitempty"`
	Clusters_       *ClusterStatistics     `json:"_clusters,omitempty"`
	Fields          map[string]interface{} `json:"fields,omitempty"`
	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_       *string                `json:"_scroll_id,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/async_search/_types/AsyncSearch.ts#L30-L45

func NewAsyncSearch ¶ added in v8.5.0 

func NewAsyncSearch() *AsyncSearch

NewAsyncSearch returns a AsyncSearch.

type AttachmentProcessor ¶ 

type AttachmentProcessor struct {
	Description       *string              `json:"description,omitempty"`
	Field             string               `json:"field"`
	If                *string              `json:"if,omitempty"`
	IgnoreFailure     *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing     *bool                `json:"ignore_missing,omitempty"`
	IndexedChars      *int64               `json:"indexed_chars,omitempty"`
	IndexedCharsField *string              `json:"indexed_chars_field,omitempty"`
	OnFailure         []ProcessorContainer `json:"on_failure,omitempty"`
	Properties        []string             `json:"properties,omitempty"`
	ResourceName      *string              `json:"resource_name,omitempty"`
	Tag               *string              `json:"tag,omitempty"`
	TargetField       *string              `json:"target_field,omitempty"`
}

AttachmentProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L96-L104

func NewAttachmentProcessor ¶ added in v8.5.0 

func NewAttachmentProcessor() *AttachmentProcessor

NewAttachmentProcessor returns a AttachmentProcessor.

type Audit ¶ 

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

Audit type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L69-L71

func NewAudit ¶ added in v8.5.0 

func NewAudit() *Audit

NewAudit returns a Audit.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/authenticate/types.ts#L22-L26

func NewAuthenticateToken ¶ added in v8.5.0 

func NewAuthenticateToken() *AuthenticateToken

NewAuthenticateToken returns a AuthenticateToken.

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               map[string]interface{}  `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_token/types.ts#L40-L45

func NewAuthenticatedUser ¶ added in v8.5.0 

func NewAuthenticatedUser() *AuthenticatedUser

NewAuthenticatedUser returns a AuthenticatedUser.

type AuthenticationProvider ¶ 

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

AuthenticationProvider type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_token/types.ts#L35-L38

func NewAuthenticationProvider ¶ added in v8.5.0 

func NewAuthenticationProvider() *AuthenticationProvider

NewAuthenticationProvider returns a AuthenticationProvider.

type AutoDateHistogramAggregate ¶ 

type AutoDateHistogramAggregate struct {
	Buckets  BucketsDateHistogramBucket `json:"buckets"`
	Interval string                     `json:"interval"`
	Meta     map[string]interface{}     `json:"meta,omitempty"`
}

AutoDateHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L355-L359

func NewAutoDateHistogramAggregate ¶ added in v8.5.0 

func NewAutoDateHistogramAggregate() *AutoDateHistogramAggregate

NewAutoDateHistogramAggregate returns a AutoDateHistogramAggregate.

type AutoDateHistogramAggregation ¶ 

type AutoDateHistogramAggregation struct {
	Buckets         *int                             `json:"buckets,omitempty"`
	Field           *string                          `json:"field,omitempty"`
	Format          *string                          `json:"format,omitempty"`
	Meta            map[string]interface{}           `json:"meta,omitempty"`
	MinimumInterval *minimuminterval.MinimumInterval `json:"minimum_interval,omitempty"`
	Missing         *DateTime                        `json:"missing,omitempty"`
	Name            *string                          `json:"name,omitempty"`
	Offset          *string                          `json:"offset,omitempty"`
	Params          map[string]interface{}           `json:"params,omitempty"`
	Script          *Script                          `json:"script,omitempty"`
	TimeZone        *string                          `json:"time_zone,omitempty"`
}

AutoDateHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L52-L62

func NewAutoDateHistogramAggregation ¶ added in v8.5.0 

func NewAutoDateHistogramAggregation() *AutoDateHistogramAggregation

NewAutoDateHistogramAggregation returns a AutoDateHistogramAggregation.

type AutoFollowPattern ¶ 

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

AutoFollowPattern type.

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

func NewAutoFollowPattern ¶ added in v8.5.0 

func NewAutoFollowPattern() *AutoFollowPattern

NewAutoFollowPattern returns a AutoFollowPattern.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/get_auto_follow_pattern/types.ts#L28-L51

func NewAutoFollowPatternSummary ¶ added in v8.5.0 

func NewAutoFollowPatternSummary() *AutoFollowPatternSummary

NewAutoFollowPatternSummary returns a AutoFollowPatternSummary.

type AutoFollowStats ¶ 

type AutoFollowStats struct {
	AutoFollowedClusters                     []AutoFollowedCluster `json:"auto_followed_clusters"`
	NumberOfFailedFollowIndices              int64                 `json:"number_of_failed_follow_indices"`
	NumberOfFailedRemoteClusterStateRequests int64                 `json:"number_of_failed_remote_cluster_state_requests"`
	NumberOfSuccessfulFollowIndices          int64                 `json:"number_of_successful_follow_indices"`
	RecentAutoFollowErrors                   []ErrorCause          `json:"recent_auto_follow_errors"`
}

AutoFollowStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/stats/types.ts.ts#L33-L39

func NewAutoFollowStats ¶ added in v8.5.0 

func NewAutoFollowStats() *AutoFollowStats

NewAutoFollowStats returns a AutoFollowStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/stats/types.ts.ts#L27-L31

func NewAutoFollowedCluster ¶ added in v8.5.0 

func NewAutoFollowedCluster() *AutoFollowedCluster

NewAutoFollowedCluster returns a AutoFollowedCluster.

type AutoscalingCapacity ¶ 

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

AutoscalingCapacity type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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    interface{}         `json:"reason_details,omitempty"`
	ReasonSummary    *string             `json:"reason_summary,omitempty"`
	RequiredCapacity AutoscalingCapacity `json:"required_capacity"`
}

AutoscalingDecider type.

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

func NewAutoscalingDecider ¶ added in v8.5.0 

func NewAutoscalingDecider() *AutoscalingDecider

NewAutoscalingDecider returns a AutoscalingDecider.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L48-L50

func NewAutoscalingNode ¶ added in v8.5.0 

func NewAutoscalingNode() *AutoscalingNode

NewAutoscalingNode returns a AutoscalingNode.

type AutoscalingPolicy ¶ 

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

AutoscalingPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/autoscaling/_types/AutoscalingPolicy.ts#L23-L27

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityResponse.ts#L43-L46

func NewAutoscalingResources ¶ added in v8.5.0 

func NewAutoscalingResources() *AutoscalingResources

NewAutoscalingResources returns a AutoscalingResources.

type AverageAggregation ¶ 

type AverageAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

AverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L48-L48

func NewAverageAggregation ¶ added in v8.5.0 

func NewAverageAggregation() *AverageAggregation

NewAverageAggregation returns a AverageAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

AverageBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L69-L69

func NewAverageBucketAggregation ¶ added in v8.5.0 

func NewAverageBucketAggregation() *AverageBucketAggregation

NewAverageBucketAggregation returns a AverageBucketAggregation.

type AvgAggregate ¶ 

type AvgAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L208-L209

func NewAvgAggregate ¶ added in v8.5.0 

func NewAvgAggregate() *AvgAggregate

NewAvgAggregate returns a AvgAggregate.

type Base ¶ 

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

Base type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L30-L33

func NewBase ¶ added in v8.5.0 

func NewBase() *Base

NewBase returns a Base.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_spec_utils/BaseNode.ts#L25-L32

func NewBaseNode ¶ added in v8.5.0 

func NewBaseNode() *BaseNode

NewBaseNode returns a BaseNode.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

BinaryProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L49-L51

func NewBinaryProperty ¶ added in v8.5.0 

func NewBinaryProperty() *BinaryProperty

NewBinaryProperty returns a BinaryProperty.

type BoolQuery ¶ 

type BoolQuery struct {
	Boost              *float32            `json:"boost,omitempty"`
	Filter             []Query             `json:"filter,omitempty"`
	MinimumShouldMatch *MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	Must               []Query             `json:"must,omitempty"`
	MustNot            []Query             `json:"must_not,omitempty"`
	QueryName_         *string             `json:"_name,omitempty"`
	Should             []Query             `json:"should,omitempty"`
}

BoolQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L28-L34

func NewBoolQuery ¶ added in v8.5.0 

func NewBoolQuery() *BoolQuery

NewBoolQuery returns a BoolQuery.

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"`
	Index       *bool                          `json:"index,omitempty"`
	// Meta Metadata about the field.
	Meta       map[string]string   `json:"meta,omitempty"`
	NullValue  *bool               `json:"null_value,omitempty"`
	Properties map[string]Property `json:"properties,omitempty"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

BooleanProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L53-L59

func NewBooleanProperty ¶ added in v8.5.0 

func NewBooleanProperty() *BooleanProperty

NewBooleanProperty returns a BooleanProperty.

type BoostingQuery ¶ 

type BoostingQuery struct {
	Boost         *float32 `json:"boost,omitempty"`
	Negative      *Query   `json:"negative,omitempty"`
	NegativeBoost float64  `json:"negative_boost"`
	Positive      *Query   `json:"positive,omitempty"`
	QueryName_    *string  `json:"_name,omitempty"`
}

BoostingQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L36-L40

func NewBoostingQuery ¶ added in v8.5.0 

func NewBoostingQuery() *BoostingQuery

NewBoostingQuery returns a BoostingQuery.

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          map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L697-L713

func NewBoxPlotAggregate ¶ added in v8.5.0 

func NewBoxPlotAggregate() *BoxPlotAggregate

NewBoxPlotAggregate returns a BoxPlotAggregate.

type BoxplotAggregation ¶ 

type BoxplotAggregation struct {
	Compression *float64 `json:"compression,omitempty"`
	Field       *string  `json:"field,omitempty"`
	Missing     *Missing `json:"missing,omitempty"`
	Script      *Script  `json:"script,omitempty"`
}

BoxplotAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L50-L52

func NewBoxplotAggregation ¶ added in v8.5.0 

func NewBoxplotAggregation() *BoxplotAggregation

NewBoxplotAggregation returns a BoxplotAggregation.

type Breaker ¶ 

type Breaker struct {
	EstimatedSize        *string  `json:"estimated_size,omitempty"`
	EstimatedSizeInBytes *int64   `json:"estimated_size_in_bytes,omitempty"`
	LimitSize            *string  `json:"limit_size,omitempty"`
	LimitSizeInBytes     *int64   `json:"limit_size_in_bytes,omitempty"`
	Overhead             *float32 `json:"overhead,omitempty"`
	Tripped              *float32 `json:"tripped,omitempty"`
}

Breaker type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L173-L180

func NewBreaker ¶ added in v8.5.0 

func NewBreaker() *Breaker

NewBreaker returns a Breaker.

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"`
	Meta     map[string]interface{}    `json:"meta,omitempty"`
	Name     *string                   `json:"name,omitempty"`
}

BucketCorrelationAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L114-L120

func NewBucketCorrelationAggregation ¶ added in v8.5.0 

func NewBucketCorrelationAggregation() *BucketCorrelationAggregation

NewBucketCorrelationAggregation returns a BucketCorrelationAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L122-L127

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L129-L132

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L134-L152

func NewBucketCorrelationFunctionCountCorrelationIndicator ¶ added in v8.5.0 

func NewBucketCorrelationFunctionCountCorrelationIndicator() *BucketCorrelationFunctionCountCorrelationIndicator

NewBucketCorrelationFunctionCountCorrelationIndicator returns a BucketCorrelationFunctionCountCorrelationIndicator.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Bucket.ts#L80-L128

func NewBucketInfluencer ¶ added in v8.5.0 

func NewBucketInfluencer() *BucketInfluencer

NewBucketInfluencer returns a BucketInfluencer.

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"`
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L79-L112

func NewBucketKsAggregation ¶ added in v8.5.0 

func NewBucketKsAggregation() *BucketKsAggregation

NewBucketKsAggregation returns a BucketKsAggregation.

type BucketMetricValueAggregate ¶ 

type BucketMetricValueAggregate struct {
	Keys []string               `json:"keys"`
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L232-L235

func NewBucketMetricValueAggregate ¶ added in v8.5.0 

func NewBucketMetricValueAggregate() *BucketMetricValueAggregate

NewBucketMetricValueAggregate returns a BucketMetricValueAggregate.

type BucketPathAggregation ¶ 

type BucketPathAggregation struct {
	// BucketsPath Path to the buckets that contain one set of values to correlate.
	BucketsPath *BucketsPath           `json:"buckets_path,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

BucketPathAggregation type.

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

func NewBucketPathAggregation ¶ added in v8.5.0 

func NewBucketPathAggregation() *BucketPathAggregation

NewBucketPathAggregation returns a BucketPathAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Script      *Script                `json:"script,omitempty"`
}

BucketScriptAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L71-L73

func NewBucketScriptAggregation ¶ added in v8.5.0 

func NewBucketScriptAggregation() *BucketScriptAggregation

NewBucketScriptAggregation returns a BucketScriptAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Script      *Script                `json:"script,omitempty"`
}

BucketSelectorAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L75-L77

func NewBucketSelectorAggregation ¶ added in v8.5.0 

func NewBucketSelectorAggregation() *BucketSelectorAggregation

NewBucketSelectorAggregation returns a BucketSelectorAggregation.

type BucketSortAggregation ¶ 

type BucketSortAggregation struct {
	From      *int                   `json:"from,omitempty"`
	GapPolicy *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,omitempty"`
	Size      *int                   `json:"size,omitempty"`
	Sort      []SortCombinations     `json:"sort,omitempty"`
}

BucketSortAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L154-L159

func NewBucketSortAggregation ¶ added in v8.5.0 

func NewBucketSortAggregation() *BucketSortAggregation

NewBucketSortAggregation returns a BucketSortAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Bucket.ts#L31-L78

func NewBucketSummary ¶ added in v8.5.0 

func NewBucketSummary() *BucketSummary

NewBucketSummary returns a BucketSummary.

type BucketsAdjacencyMatrixBucket ¶ 

type BucketsAdjacencyMatrixBucket interface{}

BucketsAdjacencyMatrixBucket holds the union for the following types: 

map[string]AdjacencyMatrixBucket
[]AdjacencyMatrixBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsCompositeBucket ¶ 

type BucketsCompositeBucket interface{}

BucketsCompositeBucket holds the union for the following types: 

map[string]CompositeBucket
[]CompositeBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsDateHistogramBucket ¶ 

type BucketsDateHistogramBucket interface{}

BucketsDateHistogramBucket holds the union for the following types: 

map[string]DateHistogramBucket
[]DateHistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsDoubleTermsBucket ¶ 

type BucketsDoubleTermsBucket interface{}

BucketsDoubleTermsBucket holds the union for the following types: 

map[string]DoubleTermsBucket
[]DoubleTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsFiltersBucket ¶ 

type BucketsFiltersBucket interface{}

BucketsFiltersBucket holds the union for the following types: 

map[string]FiltersBucket
[]FiltersBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsGeoHashGridBucket ¶ 

type BucketsGeoHashGridBucket interface{}

BucketsGeoHashGridBucket holds the union for the following types: 

map[string]GeoHashGridBucket
[]GeoHashGridBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsGeoHexGridBucket ¶ added in v8.5.0 

type BucketsGeoHexGridBucket interface{}

BucketsGeoHexGridBucket holds the union for the following types: 

map[string]GeoHexGridBucket
[]GeoHexGridBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsGeoTileGridBucket ¶ 

type BucketsGeoTileGridBucket interface{}

BucketsGeoTileGridBucket holds the union for the following types: 

map[string]GeoTileGridBucket
[]GeoTileGridBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsHistogramBucket ¶ 

type BucketsHistogramBucket interface{}

BucketsHistogramBucket holds the union for the following types: 

map[string]HistogramBucket
[]HistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsIpPrefixBucket ¶ added in v8.5.0 

type BucketsIpPrefixBucket interface{}

BucketsIpPrefixBucket holds the union for the following types: 

map[string]IpPrefixBucket
[]IpPrefixBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsIpRangeBucket ¶ 

type BucketsIpRangeBucket interface{}

BucketsIpRangeBucket holds the union for the following types: 

map[string]IpRangeBucket
[]IpRangeBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsLongRareTermsBucket ¶ 

type BucketsLongRareTermsBucket interface{}

BucketsLongRareTermsBucket holds the union for the following types: 

map[string]LongRareTermsBucket
[]LongRareTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsLongTermsBucket ¶ 

type BucketsLongTermsBucket interface{}

BucketsLongTermsBucket holds the union for the following types: 

map[string]LongTermsBucket
[]LongTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsMultiTermsBucket ¶ 

type BucketsMultiTermsBucket interface{}

BucketsMultiTermsBucket holds the union for the following types: 

map[string]MultiTermsBucket
[]MultiTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsPath ¶ 

type BucketsPath interface{}

BucketsPath holds the union for the following types: 

string
[]string
map[string]string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L44-L50

type BucketsQuery ¶ added in v8.5.0 

type BucketsQuery interface{}

BucketsQuery holds the union for the following types: 

map[string]Query
[]Query

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsRangeBucket ¶ 

type BucketsRangeBucket interface{}

BucketsRangeBucket holds the union for the following types: 

map[string]RangeBucket
[]RangeBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsSignificantLongTermsBucket ¶ 

type BucketsSignificantLongTermsBucket interface{}

BucketsSignificantLongTermsBucket holds the union for the following types: 

map[string]SignificantLongTermsBucket
[]SignificantLongTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsSignificantStringTermsBucket ¶ 

type BucketsSignificantStringTermsBucket interface{}

BucketsSignificantStringTermsBucket holds the union for the following types: 

map[string]SignificantStringTermsBucket
[]SignificantStringTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsStringRareTermsBucket ¶ 

type BucketsStringRareTermsBucket interface{}

BucketsStringRareTermsBucket holds the union for the following types: 

map[string]StringRareTermsBucket
[]StringRareTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsStringTermsBucket ¶ 

type BucketsStringTermsBucket interface{}

BucketsStringTermsBucket holds the union for the following types: 

map[string]StringTermsBucket
[]StringTermsBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsVariableWidthHistogramBucket ¶ 

type BucketsVariableWidthHistogramBucket interface{}

BucketsVariableWidthHistogramBucket holds the union for the following types: 

map[string]VariableWidthHistogramBucket
[]VariableWidthHistogramBucket

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BucketsVoid ¶ 

type BucketsVoid interface{}

BucketsVoid holds the union for the following types: 

map[string]struct{}
[]struct{}

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L315-L324

type BuildInformation ¶ 

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

BuildInformation type.

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

func NewBuildInformation ¶ added in v8.5.0 

func NewBuildInformation() *BuildInformation

NewBuildInformation returns a BuildInformation.

type BulkIndexByScrollFailure ¶ 

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

BulkIndexByScrollFailure type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Errors.ts#L58-L64

func NewBulkIndexByScrollFailure ¶ added in v8.5.0 

func NewBulkIndexByScrollFailure() *BulkIndexByScrollFailure

NewBulkIndexByScrollFailure returns a BulkIndexByScrollFailure.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L41-L51

func NewBulkStats ¶ added in v8.5.0 

func NewBulkStats() *BulkStats

NewBulkStats returns a BulkStats.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L161-L164

func NewByteNumberProperty ¶ added in v8.5.0 

func NewByteNumberProperty() *ByteNumberProperty

NewByteNumberProperty returns a ByteNumberProperty.

type ByteSize ¶ 

type ByteSize interface{}

ByteSize holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L88-L89

type BytesProcessor ¶ 

type BytesProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

BytesProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L123-L127

func NewBytesProcessor ¶ added in v8.5.0 

func NewBytesProcessor() *BytesProcessor

NewBytesProcessor returns a BytesProcessor.

type CacheQueries ¶ 

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

CacheQueries type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L398-L400

func NewCacheQueries ¶ added in v8.5.0 

func NewCacheQueries() *CacheQueries

NewCacheQueries returns a CacheQueries.

type CacheStats ¶ 

type CacheStats struct {
	Count     int    `json:"count"`
	Evictions int    `json:"evictions"`
	Hits      int    `json:"hits"`
	Misses    int    `json:"misses"`
	NodeId    string `json:"node_id"`
}

CacheStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/stats/types.ts#L37-L43

func NewCacheStats ¶ added in v8.5.0 

func NewCacheStats() *CacheStats

NewCacheStats returns a CacheStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/get_calendars/types.ts#L22-L29

func NewCalendar ¶ added in v8.5.0 

func NewCalendar() *Calendar

NewCalendar returns a Calendar.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/CalendarEvent.ts#L23-L33

func NewCalendarEvent ¶ added in v8.5.0 

func NewCalendarEvent() *CalendarEvent

NewCalendarEvent returns a CalendarEvent.

type CardinalityAggregate ¶ 

type CardinalityAggregate struct {
	Meta  map[string]interface{} `json:"meta,omitempty"`
	Value int64                  `json:"value"`
}

CardinalityAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L137-L140

func NewCardinalityAggregate ¶ added in v8.5.0 

func NewCardinalityAggregate() *CardinalityAggregate

NewCardinalityAggregate returns a CardinalityAggregate.

type CardinalityAggregation ¶ 

type CardinalityAggregation struct {
	ExecutionHint      *cardinalityexecutionmode.CardinalityExecutionMode `json:"execution_hint,omitempty"`
	Field              *string                                            `json:"field,omitempty"`
	Missing            *Missing                                           `json:"missing,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L62-L66

func NewCardinalityAggregation ¶ added in v8.5.0 

func NewCardinalityAggregation() *CardinalityAggregation

NewCardinalityAggregation returns a CardinalityAggregation.

type CatAnonalyDetectorColumns ¶ 

type CatAnonalyDetectorColumns []catanomalydetectorcolumn.CatAnomalyDetectorColumn

CatAnonalyDetectorColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
}

CatComponentTemplate type.

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

func NewCatComponentTemplate ¶ added in v8.5.0 

func NewCatComponentTemplate() *CatComponentTemplate

NewCatComponentTemplate returns a CatComponentTemplate.

type CatDatafeedColumns ¶ 

type CatDatafeedColumns []catdatafeedcolumn.CatDatafeedColumn

CatDatafeedColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/_types/CatBase.ts#L559-L559

type CatDfaColumns ¶ 

type CatDfaColumns []catdfacolumn.CatDfaColumn

CatDfaColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/_types/CatBase.ts#L558-L558

type CatTrainedModelsColumns ¶ 

type CatTrainedModelsColumns []cattrainedmodelscolumn.CatTrainedModelsColumn

CatTrainedModelsColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/_types/CatBase.ts#L636-L638

type CatTransformColumns ¶ 

type CatTransformColumns []cattransformcolumn.CatTransformColumn

CatTransformColumns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/_types/CatBase.ts#L845-L845

type CategorizationAnalyzer ¶ 

type CategorizationAnalyzer interface{}

CategorizationAnalyzer holds the union for the following types: 

string
CategorizationAnalyzerDefinition

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L124-L125

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L127-L140

func NewCategorizationAnalyzerDefinition ¶ added in v8.5.0 

func NewCategorizationAnalyzerDefinition() *CategorizationAnalyzerDefinition

NewCategorizationAnalyzerDefinition returns a CategorizationAnalyzerDefinition.

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](https://www.elastic.co/guide/en/elasticsearch/reference/8.0/indices-analyze.html).
	// 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"`
	Meta            map[string]interface{} `json:"meta,omitempty"`
	// MinDocCount The minimum number of documents for a bucket to be returned to the results.
	MinDocCount *int    `json:"min_doc_count,omitempty"`
	Name        *string `json:"name,omitempty"`
	// ShardMinDocCount The minimum number of documents for 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L437-L501

func NewCategorizeTextAggregation ¶ added in v8.5.0 

func NewCategorizeTextAggregation() *CategorizeTextAggregation

NewCategorizeTextAggregation returns a CategorizeTextAggregation.

type CategorizeTextAnalyzer ¶ 

type CategorizeTextAnalyzer interface{}

CategorizeTextAnalyzer holds the union for the following types: 

string
CustomCategorizeTextAnalyzer

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L503-L506

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Category.ts#L23-L49

func NewCategory ¶ added in v8.5.0 

func NewCategory() *Category

NewCategory returns a Category.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L319-L322

func NewCcr ¶ added in v8.5.0 

func NewCcr() *Ccr

NewCcr returns a Ccr.

type CcrShardStats ¶ added in v8.5.0 

type CcrShardStats struct {
	BytesRead                     int64           `json:"bytes_read"`
	FailedReadRequests            int64           `json:"failed_read_requests"`
	FailedWriteRequests           int64           `json:"failed_write_requests"`
	FatalException                *ErrorCause     `json:"fatal_exception,omitempty"`
	FollowerAliasesVersion        int64           `json:"follower_aliases_version"`
	FollowerGlobalCheckpoint      int64           `json:"follower_global_checkpoint"`
	FollowerIndex                 string          `json:"follower_index"`
	FollowerMappingVersion        int64           `json:"follower_mapping_version"`
	FollowerMaxSeqNo              int64           `json:"follower_max_seq_no"`
	FollowerSettingsVersion       int64           `json:"follower_settings_version"`
	LastRequestedSeqNo            int64           `json:"last_requested_seq_no"`
	LeaderGlobalCheckpoint        int64           `json:"leader_global_checkpoint"`
	LeaderIndex                   string          `json:"leader_index"`
	LeaderMaxSeqNo                int64           `json:"leader_max_seq_no"`
	OperationsRead                int64           `json:"operations_read"`
	OperationsWritten             int64           `json:"operations_written"`
	OutstandingReadRequests       int             `json:"outstanding_read_requests"`
	OutstandingWriteRequests      int             `json:"outstanding_write_requests"`
	ReadExceptions                []ReadException `json:"read_exceptions"`
	RemoteCluster                 string          `json:"remote_cluster"`
	ShardId                       int             `json:"shard_id"`
	SuccessfulReadRequests        int64           `json:"successful_read_requests"`
	SuccessfulWriteRequests       int64           `json:"successful_write_requests"`
	TimeSinceLastRead             *Duration       `json:"time_since_last_read,omitempty"`
	TimeSinceLastReadMillis       int64           `json:"time_since_last_read_millis"`
	TotalReadRemoteExecTime       *Duration       `json:"total_read_remote_exec_time,omitempty"`
	TotalReadRemoteExecTimeMillis int64           `json:"total_read_remote_exec_time_millis"`
	TotalReadTime                 *Duration       `json:"total_read_time,omitempty"`
	TotalReadTimeMillis           int64           `json:"total_read_time_millis"`
	TotalWriteTime                *Duration       `json:"total_write_time,omitempty"`
	TotalWriteTimeMillis          int64           `json:"total_write_time_millis"`
	WriteBufferOperationCount     int64           `json:"write_buffer_operation_count"`
	WriteBufferSizeInBytes        ByteSize        `json:"write_buffer_size_in_bytes"`
}

CcrShardStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/_types/FollowIndexStats.ts#L35-L69

func NewCcrShardStats ¶ added in v8.5.0 

func NewCcrShardStats() *CcrShardStats

NewCcrShardStats returns a CcrShardStats.

type CertificateInformation ¶ 

type CertificateInformation struct {
	Alias         string   `json:"alias,omitempty"`
	Expiry        DateTime `json:"expiry"`
	Format        string   `json:"format"`
	HasPrivateKey bool     `json:"has_private_key"`
	Issuer        *string  `json:"issuer,omitempty"`
	Path          string   `json:"path"`
	SerialNumber  string   `json:"serial_number"`
	SubjectDn     string   `json:"subject_dn"`
}

CertificateInformation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ssl/certificates/types.ts#L22-L31

func NewCertificateInformation ¶ added in v8.5.0 

func NewCertificateInformation() *CertificateInformation

NewCertificateInformation returns a CertificateInformation.

type Cgroup ¶ 

type Cgroup struct {
	Cpu     *CgroupCpu    `json:"cpu,omitempty"`
	Cpuacct *CpuAcct      `json:"cpuacct,omitempty"`
	Memory  *CgroupMemory `json:"memory,omitempty"`
}

Cgroup type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L182-L186

func NewCgroup ¶ added in v8.5.0 

func NewCgroup() *Cgroup

NewCgroup returns a Cgroup.

type CgroupCpu ¶ 

type CgroupCpu struct {
	CfsPeriodMicros *int           `json:"cfs_period_micros,omitempty"`
	CfsQuotaMicros  *int           `json:"cfs_quota_micros,omitempty"`
	ControlGroup    *string        `json:"control_group,omitempty"`
	Stat            *CgroupCpuStat `json:"stat,omitempty"`
}

CgroupCpu type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L193-L198

func NewCgroupCpu ¶ added in v8.5.0 

func NewCgroupCpu() *CgroupCpu

NewCgroupCpu returns a CgroupCpu.

type CgroupCpuStat ¶ 

type CgroupCpuStat struct {
	NumberOfElapsedPeriods *int64 `json:"number_of_elapsed_periods,omitempty"`
	NumberOfTimesThrottled *int64 `json:"number_of_times_throttled,omitempty"`
	TimeThrottledNanos     *int64 `json:"time_throttled_nanos,omitempty"`
}

CgroupCpuStat type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L200-L204

func NewCgroupCpuStat ¶ added in v8.5.0 

func NewCgroupCpuStat() *CgroupCpuStat

NewCgroupCpuStat returns a CgroupCpuStat.

type CgroupMemory ¶ 

type CgroupMemory struct {
	ControlGroup *string `json:"control_group,omitempty"`
	LimitInBytes *string `json:"limit_in_bytes,omitempty"`
	UsageInBytes *string `json:"usage_in_bytes,omitempty"`
}

CgroupMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L206-L210

func NewCgroupMemory ¶ added in v8.5.0 

func NewCgroupMemory() *CgroupMemory

NewCgroupMemory returns a CgroupMemory.

type ChainInput ¶ 

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

ChainInput type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 interface{}

CharFilter holds the union for the following types: 

string
CharFilterDefinition

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/char_filters.ts#L28-L30

type CharFilterDefinition ¶ 

type CharFilterDefinition interface {
	// contains filtered or unexported methods
}

CharFilterDefinition holds the union for the following types: 

HtmlStripCharFilter
MappingCharFilter
PatternReplaceCharFilter
IcuNormalizationCharFilter
KuromojiIterationMarkCharFilter

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/char_filters.ts#L32-L41

type CharFilterDetail ¶ 

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

CharFilterDetail type.

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

func NewCharFilterDetail ¶ added in v8.5.0 

func NewCharFilterDetail() *CharFilterDetail

NewCharFilterDetail returns a CharFilterDetail.

type CharFilterTypes ¶ 

type CharFilterTypes struct {
	AnalyzerTypes      []FieldTypes `json:"analyzer_types"`
	BuiltInAnalyzers   []FieldTypes `json:"built_in_analyzers"`
	BuiltInCharFilters []FieldTypes `json:"built_in_char_filters"`
	BuiltInFilters     []FieldTypes `json:"built_in_filters"`
	BuiltInTokenizers  []FieldTypes `json:"built_in_tokenizers"`
	CharFilterTypes    []FieldTypes `json:"char_filter_types"`
	FilterTypes        []FieldTypes `json:"filter_types"`
	TokenizerTypes     []FieldTypes `json:"tokenizer_types"`
}

CharFilterTypes type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L126-L135

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L55-L59

func NewCharGroupTokenizer ¶ added in v8.5.0 

func NewCharGroupTokenizer() *CharGroupTokenizer

NewCharGroupTokenizer returns a CharGroupTokenizer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform_stats/types.ts#L68-L75

func NewCheckpointStats ¶ added in v8.5.0 

func NewCheckpointStats() *CheckpointStats

NewCheckpointStats returns a CheckpointStats.

type Checkpointing ¶ 

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

Checkpointing type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform_stats/types.ts#L77-L84

func NewCheckpointing ¶ added in v8.5.0 

func NewCheckpointing() *Checkpointing

NewCheckpointing returns a Checkpointing.

type ChiSquareHeuristic ¶ 

type ChiSquareHeuristic struct {
	BackgroundIsSuperset bool `json:"background_is_superset"`
	IncludeNegatives     bool `json:"include_negatives"`
}

ChiSquareHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L322-L325

func NewChiSquareHeuristic ¶ added in v8.5.0 

func NewChiSquareHeuristic() *ChiSquareHeuristic

NewChiSquareHeuristic returns a ChiSquareHeuristic.

type ChildrenAggregate ¶ 

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

ChildrenAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L767-L768

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

type ChildrenAggregation ¶ 

type ChildrenAggregation struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
	Type *string                `json:"type,omitempty"`
}

ChildrenAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L73-L75

func NewChildrenAggregation ¶ added in v8.5.0 

func NewChildrenAggregation() *ChildrenAggregation

NewChildrenAggregation returns a ChildrenAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L177-L190

func NewChunkingConfig ¶ added in v8.5.0 

func NewChunkingConfig() *ChunkingConfig

NewChunkingConfig returns a ChunkingConfig.

type CircleProcessor ¶ 

type CircleProcessor struct {
	Description   *string              `json:"description,omitempty"`
	ErrorDistance float64              `json:"error_distance"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	ShapeType     shapetype.ShapeType  `json:"shape_type"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

CircleProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L129-L135

func NewCircleProcessor ¶ added in v8.5.0 

func NewCircleProcessor() *CircleProcessor

NewCircleProcessor returns a CircleProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L80-L95

func NewClassificationInferenceOptions ¶ added in v8.5.0 

func NewClassificationInferenceOptions() *ClassificationInferenceOptions

NewClassificationInferenceOptions returns a ClassificationInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/cleanup_repository/SnapshotCleanupRepositoryResponse.ts#L29-L34

func NewCleanupRepositoryResults ¶ added in v8.5.0 

func NewCleanupRepositoryResults() *CleanupRepositoryResults

NewCleanupRepositoryResults returns a CleanupRepositoryResults.

type Client ¶ 

type Client struct {
	Agent                 *string `json:"agent,omitempty"`
	ClosedTimeMillis      *int64  `json:"closed_time_millis,omitempty"`
	Id                    *int64  `json:"id,omitempty"`
	LastRequestTimeMillis *int64  `json:"last_request_time_millis,omitempty"`
	LastUri               *string `json:"last_uri,omitempty"`
	LocalAddress          *string `json:"local_address,omitempty"`
	OpenedTimeMillis      *int64  `json:"opened_time_millis,omitempty"`
	RemoteAddress         *string `json:"remote_address,omitempty"`
	RequestCount          *int64  `json:"request_count,omitempty"`
	RequestSizeBytes      *int64  `json:"request_size_bytes,omitempty"`
	XOpaqueId             *string `json:"x_opaque_id,omitempty"`
}

Client type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L266-L278

func NewClient ¶ added in v8.5.0 

func NewClient() *Client

NewClient returns a Client.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/close/CloseIndexResponse.ts#L32-L35

func NewCloseIndexResult ¶ added in v8.5.0 

func NewCloseIndexResult() *CloseIndexResult

NewCloseIndexResult returns a CloseIndexResult.

type CloseShardResult ¶ 

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

CloseShardResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L84-L86

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/_types/ComponentTemplate.ts#L26-L29

func NewClusterComponentTemplate ¶ added in v8.5.0 

func NewClusterComponentTemplate() *ClusterComponentTemplate

NewClusterComponentTemplate returns a ClusterComponentTemplate.

type ClusterFileSystem ¶ 

type ClusterFileSystem struct {
	AvailableInBytes int64 `json:"available_in_bytes"`
	FreeInBytes      int64 `json:"free_in_bytes"`
	TotalInBytes     int64 `json:"total_in_bytes"`
}

ClusterFileSystem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L34-L38

func NewClusterFileSystem ¶ added in v8.5.0 

func NewClusterFileSystem() *ClusterFileSystem

NewClusterFileSystem returns a ClusterFileSystem.

type ClusterIndexingPressure ¶ added in v8.5.0 

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

ClusterIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L292-L294

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 []IndicesVersions `json:"versions,omitempty"`
}

ClusterIndices type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L63-L94

func NewClusterIndices ¶ added in v8.5.0 

func NewClusterIndices() *ClusterIndices

NewClusterIndices returns a ClusterIndices.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L49-L61

func NewClusterIndicesShards ¶ added in v8.5.0 

func NewClusterIndicesShards() *ClusterIndicesShards

NewClusterIndicesShards returns a ClusterIndicesShards.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L40-L47

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L48-L54

func NewClusterInfo ¶ added in v8.5.0 

func NewClusterInfo() *ClusterInfo

NewClusterInfo returns a ClusterInfo.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L144-L147

func NewClusterIngest ¶ added in v8.5.0 

func NewClusterIngest() *ClusterIngest

NewClusterIngest returns a ClusterIngest.

type ClusterJvm ¶ 

type ClusterJvm struct {
	MaxUptimeInMillis int64               `json:"max_uptime_in_millis"`
	Mem               ClusterJvmMemory    `json:"mem"`
	Threads           int64               `json:"threads"`
	Versions          []ClusterJvmVersion `json:"versions"`
}

ClusterJvm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L149-L154

func NewClusterJvm ¶ added in v8.5.0 

func NewClusterJvm() *ClusterJvm

NewClusterJvm returns a ClusterJvm.

type ClusterJvmMemory ¶ 

type ClusterJvmMemory struct {
	HeapMaxInBytes  int64 `json:"heap_max_in_bytes"`
	HeapUsedInBytes int64 `json:"heap_used_in_bytes"`
}

ClusterJvmMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L156-L159

func NewClusterJvmMemory ¶ added in v8.5.0 

func NewClusterJvmMemory() *ClusterJvmMemory

NewClusterJvmMemory returns a ClusterJvmMemory.

type ClusterJvmVersion ¶ 

type ClusterJvmVersion struct {
	BundledJdk      bool   `json:"bundled_jdk"`
	Count           int    `json:"count"`
	UsingBundledJdk bool   `json:"using_bundled_jdk"`
	Version         string `json:"version"`
	VmName          string `json:"vm_name"`
	VmVendor        string `json:"vm_vendor"`
	VmVersion       string `json:"vm_version"`
}

ClusterJvmVersion type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L161-L169

func NewClusterJvmVersion ¶ added in v8.5.0 

func NewClusterJvmVersion() *ClusterJvmVersion

NewClusterJvmVersion returns a ClusterJvmVersion.

type ClusterNetworkTypes ¶ 

type ClusterNetworkTypes struct {
	HttpTypes      map[string]int `json:"http_types"`
	TransportTypes map[string]int `json:"transport_types"`
}

ClusterNetworkTypes type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L171-L174

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/ClusterNode.ts#L22-L24

func NewClusterNode ¶ added in v8.5.0 

func NewClusterNode() *ClusterNode

NewClusterNode returns a ClusterNode.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L176-L192

func NewClusterNodeCount ¶ added in v8.5.0 

func NewClusterNodeCount() *ClusterNodeCount

NewClusterNodeCount returns a ClusterNodeCount.

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.
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L194-L221

func NewClusterNodes ¶ added in v8.5.0 

func NewClusterNodes() *ClusterNodes

NewClusterNodes returns a ClusterNodes.

type ClusterOperatingSystem ¶ 

type ClusterOperatingSystem struct {
	AllocatedProcessors int                                  `json:"allocated_processors"`
	Architectures       []ClusterOperatingSystemArchitecture `json:"architectures,omitempty"`
	AvailableProcessors int                                  `json:"available_processors"`
	Mem                 OperatingSystemMemoryInfo            `json:"mem"`
	Names               []ClusterOperatingSystemName         `json:"names"`
	PrettyNames         []ClusterOperatingSystemPrettyName   `json:"pretty_names"`
}

ClusterOperatingSystem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L228-L235

func NewClusterOperatingSystem ¶ added in v8.5.0 

func NewClusterOperatingSystem() *ClusterOperatingSystem

NewClusterOperatingSystem returns a ClusterOperatingSystem.

type ClusterOperatingSystemArchitecture ¶ 

type ClusterOperatingSystemArchitecture struct {
	Arch  string `json:"arch"`
	Count int    `json:"count"`
}

ClusterOperatingSystemArchitecture type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L223-L226

func NewClusterOperatingSystemArchitecture ¶ added in v8.5.0 

func NewClusterOperatingSystemArchitecture() *ClusterOperatingSystemArchitecture

NewClusterOperatingSystemArchitecture returns a ClusterOperatingSystemArchitecture.

type ClusterOperatingSystemName ¶ 

type ClusterOperatingSystemName struct {
	Count int    `json:"count"`
	Name  string `json:"name"`
}

ClusterOperatingSystemName type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L237-L240

func NewClusterOperatingSystemName ¶ added in v8.5.0 

func NewClusterOperatingSystemName() *ClusterOperatingSystemName

NewClusterOperatingSystemName returns a ClusterOperatingSystemName.

type ClusterOperatingSystemPrettyName ¶ 

type ClusterOperatingSystemPrettyName struct {
	Count      int    `json:"count"`
	PrettyName string `json:"pretty_name"`
}

ClusterOperatingSystemPrettyName type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L242-L245

func NewClusterOperatingSystemPrettyName ¶ added in v8.5.0 

func NewClusterOperatingSystemPrettyName() *ClusterOperatingSystemPrettyName

NewClusterOperatingSystemPrettyName returns a ClusterOperatingSystemPrettyName.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L296-L300

func NewClusterPressureMemory ¶ added in v8.5.0 

func NewClusterPressureMemory() *ClusterPressureMemory

NewClusterPressureMemory returns a ClusterPressureMemory.

type ClusterProcess ¶ 

type ClusterProcess struct {
	Cpu                 ClusterProcessCpu                 `json:"cpu"`
	OpenFileDescriptors ClusterProcessOpenFileDescriptors `json:"open_file_descriptors"`
}

ClusterProcess type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L247-L250

func NewClusterProcess ¶ added in v8.5.0 

func NewClusterProcess() *ClusterProcess

NewClusterProcess returns a ClusterProcess.

type ClusterProcessCpu ¶ 

type ClusterProcessCpu struct {
	Percent int `json:"percent"`
}

ClusterProcessCpu type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L252-L254

func NewClusterProcessCpu ¶ added in v8.5.0 

func NewClusterProcessCpu() *ClusterProcessCpu

NewClusterProcessCpu returns a ClusterProcessCpu.

type ClusterProcessOpenFileDescriptors ¶ 

type ClusterProcessOpenFileDescriptors struct {
	Avg int64 `json:"avg"`
	Max int64 `json:"max"`
	Min int64 `json:"min"`
}

ClusterProcessOpenFileDescriptors type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L256-L260

func NewClusterProcessOpenFileDescriptors ¶ added in v8.5.0 

func NewClusterProcessOpenFileDescriptors() *ClusterProcessOpenFileDescriptors

NewClusterProcessOpenFileDescriptors returns a ClusterProcessOpenFileDescriptors.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L262-L268

func NewClusterProcessor ¶ added in v8.5.0 

func NewClusterProcessor() *ClusterProcessor

NewClusterProcessor returns a ClusterProcessor.

type ClusterRemoteInfo ¶ 

type ClusterRemoteInfo interface {
	// contains filtered or unexported methods
}

ClusterRemoteInfo holds the union for the following types: 

ClusterRemoteSniffInfo
ClusterRemoteProxyInfo

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L28-L29

type ClusterRemoteProxyInfo ¶ 

type ClusterRemoteProxyInfo struct {
	Connected                 bool     `json:"connected"`
	InitialConnectTimeout     Duration `json:"initial_connect_timeout"`
	MaxProxySocketConnections int      `json:"max_proxy_socket_connections"`
	Mode                      string   `json:"mode,omitempty"`
	NumProxySocketsConnected  int      `json:"num_proxy_sockets_connected"`
	ProxyAddress              string   `json:"proxy_address"`
	ServerName                string   `json:"server_name"`
	SkipUnavailable           bool     `json:"skip_unavailable"`
}

ClusterRemoteProxyInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L41-L50

func NewClusterRemoteProxyInfo ¶ added in v8.5.0 

func NewClusterRemoteProxyInfo() *ClusterRemoteProxyInfo

NewClusterRemoteProxyInfo returns a ClusterRemoteProxyInfo.

type ClusterRemoteSniffInfo ¶ 

type ClusterRemoteSniffInfo struct {
	Connected                bool     `json:"connected"`
	InitialConnectTimeout    Duration `json:"initial_connect_timeout"`
	MaxConnectionsPerCluster int      `json:"max_connections_per_cluster"`
	Mode                     string   `json:"mode,omitempty"`
	NumNodesConnected        int64    `json:"num_nodes_connected"`
	Seeds                    []string `json:"seeds"`
	SkipUnavailable          bool     `json:"skip_unavailable"`
}

ClusterRemoteSniffInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/remote_info/ClusterRemoteInfoResponse.ts#L31-L39

func NewClusterRemoteSniffInfo ¶ added in v8.5.0 

func NewClusterRemoteSniffInfo() *ClusterRemoteSniffInfo

NewClusterRemoteSniffInfo returns a ClusterRemoteSniffInfo.

type ClusterRuntimeFieldTypes ¶ added in v8.5.0 

type ClusterRuntimeFieldTypes struct {
	CharsMax        int      `json:"chars_max"`
	CharsTotal      int      `json:"chars_total"`
	Count           int      `json:"count"`
	DocMax          int      `json:"doc_max"`
	DocTotal        int      `json:"doc_total"`
	IndexCount      int      `json:"index_count"`
	Lang            []string `json:"lang"`
	LinesMax        int      `json:"lines_max"`
	LinesTotal      int      `json:"lines_total"`
	Name            string   `json:"name"`
	ScriptlessCount int      `json:"scriptless_count"`
	ShadowedCount   int      `json:"shadowed_count"`
	SourceMax       int      `json:"source_max"`
	SourceTotal     int      `json:"source_total"`
}

ClusterRuntimeFieldTypes type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L109-L124

func NewClusterRuntimeFieldTypes ¶ added in v8.5.0 

func NewClusterRuntimeFieldTypes() *ClusterRuntimeFieldTypes

NewClusterRuntimeFieldTypes returns a ClusterRuntimeFieldTypes.

type ClusterShardMetrics ¶ 

type ClusterShardMetrics struct {
	Avg float64 `json:"avg"`
	Max float64 `json:"max"`
	Min float64 `json:"min"`
}

ClusterShardMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L270-L274

func NewClusterShardMetrics ¶ added in v8.5.0 

func NewClusterShardMetrics() *ClusterShardMetrics

NewClusterShardMetrics returns a ClusterShardMetrics.

type ClusterStateQueue ¶ 

type ClusterStateQueue struct {
	Committed *int64 `json:"committed,omitempty"`
	Pending   *int64 `json:"pending,omitempty"`
	Total     *int64 `json:"total,omitempty"`
}

ClusterStateQueue type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L108-L112

func NewClusterStateQueue ¶ added in v8.5.0 

func NewClusterStateQueue() *ClusterStateQueue

NewClusterStateQueue returns a ClusterStateQueue.

type ClusterStateUpdate ¶ 

type ClusterStateUpdate struct {
	CommitTime                    *Duration `json:"commit_time,omitempty"`
	CommitTimeMillis              *int64    `json:"commit_time_millis,omitempty"`
	CompletionTime                *Duration `json:"completion_time,omitempty"`
	CompletionTimeMillis          *int64    `json:"completion_time_millis,omitempty"`
	ComputationTime               *Duration `json:"computation_time,omitempty"`
	ComputationTimeMillis         *int64    `json:"computation_time_millis,omitempty"`
	ContextConstructionTime       *Duration `json:"context_construction_time,omitempty"`
	ContextConstructionTimeMillis *int64    `json:"context_construction_time_millis,omitempty"`
	Count                         int64     `json:"count"`
	MasterApplyTime               *Duration `json:"master_apply_time,omitempty"`
	MasterApplyTimeMillis         *int64    `json:"master_apply_time_millis,omitempty"`
	NotificationTime              *Duration `json:"notification_time,omitempty"`
	NotificationTimeMillis        *int64    `json:"notification_time_millis,omitempty"`
	PublicationTime               *Duration `json:"publication_time,omitempty"`
	PublicationTimeMillis         *int64    `json:"publication_time_millis,omitempty"`
}

ClusterStateUpdate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L120-L136

func NewClusterStateUpdate ¶ added in v8.5.0 

func NewClusterStateUpdate() *ClusterStateUpdate

NewClusterStateUpdate returns a ClusterStateUpdate.

type ClusterStatistics ¶ 

type ClusterStatistics struct {
	Skipped    int `json:"skipped"`
	Successful int `json:"successful"`
	Total      int `json:"total"`
}

ClusterStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L27-L31

func NewClusterStatistics ¶ added in v8.5.0 

func NewClusterStatistics() *ClusterStatistics

NewClusterStatistics returns a ClusterStatistics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L86-L91

func NewCollector ¶ added in v8.5.0 

func NewCollector() *Collector

NewCollector returns a Collector.

type Column ¶ 

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

Column type.

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

func NewColumn ¶ added in v8.5.0 

func NewColumn() *Column

NewColumn returns a Column.

type CombinedFieldsQuery ¶ 

type CombinedFieldsQuery struct {
	AutoGenerateSynonymsPhraseQuery *bool                                            `json:"auto_generate_synonyms_phrase_query,omitempty"`
	Boost                           *float32                                         `json:"boost,omitempty"`
	Fields                          []string                                         `json:"fields"`
	MinimumShouldMatch              *MinimumShouldMatch                              `json:"minimum_should_match,omitempty"`
	Operator                        *combinedfieldsoperator.CombinedFieldsOperator   `json:"operator,omitempty"`
	Query                           string                                           `json:"query"`
	QueryName_                      *string                                          `json:"_name,omitempty"`
	ZeroTermsQuery                  *combinedfieldszeroterms.CombinedFieldsZeroTerms `json:"zero_terms_query,omitempty"`
}

CombinedFieldsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/abstractions.ts#L181-L195

func NewCombinedFieldsQuery ¶ added in v8.5.0 

func NewCombinedFieldsQuery() *CombinedFieldsQuery

NewCombinedFieldsQuery returns a CombinedFieldsQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L78-L84

func NewCommandAllocatePrimaryAction ¶ added in v8.5.0 

func NewCommandAllocatePrimaryAction() *CommandAllocatePrimaryAction

NewCommandAllocatePrimaryAction returns a CommandAllocatePrimaryAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L69-L76

func NewCommandAllocateReplicaAction ¶ added in v8.5.0 

func NewCommandAllocateReplicaAction() *CommandAllocateReplicaAction

NewCommandAllocateReplicaAction returns a CommandAllocateReplicaAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L45-L50

func NewCommandCancelAction ¶ added in v8.5.0 

func NewCommandCancelAction() *CommandCancelAction

NewCommandCancelAction returns a CommandCancelAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L60-L67

func NewCommandMoveAction ¶ added in v8.5.0 

func NewCommandMoveAction() *CommandMoveAction

NewCommandMoveAction returns a CommandMoveAction.

type CommonGramsTokenFilter ¶ 

type CommonGramsTokenFilter struct {
	CommonWords     []string `json:"common_words,omitempty"`
	CommonWordsPath *string  `json:"common_words_path,omitempty"`
	IgnoreCase      *bool    `json:"ignore_case,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L172-L178

func NewCommonGramsTokenFilter ¶ added in v8.5.0 

func NewCommonGramsTokenFilter() *CommonGramsTokenFilter

NewCommonGramsTokenFilter returns a CommonGramsTokenFilter.

type CommonTermsQuery ¶ 

type CommonTermsQuery struct {
	Analyzer           *string             `json:"analyzer,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L33-L43

func NewCommonTermsQuery ¶ added in v8.5.0 

func NewCommonTermsQuery() *CommonTermsQuery

NewCommonTermsQuery returns a CommonTermsQuery.

type CompactNodeInfo ¶ 

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

CompactNodeInfo type.

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

func NewCompactNodeInfo ¶ added in v8.5.0 

func NewCompactNodeInfo() *CompactNodeInfo

NewCompactNodeInfo returns a CompactNodeInfo.

type CompletionContext ¶ 

type CompletionContext struct {
	Boost      *float64           `json:"boost,omitempty"`
	Context    Context            `json:"context"`
	Neighbours []GeoHashPrecision `json:"neighbours,omitempty"`
	Precision  *GeoHashPrecision  `json:"precision,omitempty"`
	Prefix     *bool              `json:"prefix,omitempty"`
}

CompletionContext type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L155-L162

func NewCompletionContext ¶ added in v8.5.0 

func NewCompletionContext() *CompletionContext

NewCompletionContext returns a CompletionContext.

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"`
	Similarity                 *string             `json:"similarity,omitempty"`
	Store                      *bool               `json:"store,omitempty"`
	Type                       string              `json:"type,omitempty"`
}

CompletionProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L27-L35

func NewCompletionProperty ¶ added in v8.5.0 

func NewCompletionProperty() *CompletionProperty

NewCompletionProperty returns a CompletionProperty.

type CompletionStats ¶ 

type CompletionStats struct {
	Fields      map[string]FieldSizeUsage `json:"fields,omitempty"`
	Size        *ByteSize                 `json:"size,omitempty"`
	SizeInBytes int64                     `json:"size_in_bytes"`
}

CompletionStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L53-L57

func NewCompletionStats ¶ added in v8.5.0 

func NewCompletionStats() *CompletionStats

NewCompletionStats returns a CompletionStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L48-L55

func NewCompletionSuggest ¶ added in v8.5.0 

func NewCompletionSuggest() *CompletionSuggest

NewCompletionSuggest returns a CompletionSuggest.

type CompletionSuggestOption ¶ 

type CompletionSuggestOption struct {
	CollateMatch *bool                  `json:"collate_match,omitempty"`
	Contexts     map[string][]Context   `json:"contexts,omitempty"`
	Fields       map[string]interface{} `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_      interface{}            `json:"_source,omitempty"`
	Text         string                 `json:"text"`
}

CompletionSuggestOption type.

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

func NewCompletionSuggestOption ¶ added in v8.5.0 

func NewCompletionSuggestOption() *CompletionSuggestOption

NewCompletionSuggestOption returns a CompletionSuggestOption.

type CompletionSuggester ¶ 

type CompletionSuggester struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	Contexts       map[string][]CompletionContext `json:"contexts,omitempty"`
	Field          string                         `json:"field"`
	Fuzzy          *SuggestFuzziness              `json:"fuzzy,omitempty"`
	Prefix         *string                        `json:"prefix,omitempty"`
	Regex          *string                        `json:"regex,omitempty"`
	Size           *int                           `json:"size,omitempty"`
	SkipDuplicates *bool                          `json:"skip_duplicates,omitempty"`
}

CompletionSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L130-L136

func NewCompletionSuggester ¶ added in v8.5.0 

func NewCompletionSuggester() *CompletionSuggester

NewCompletionSuggester returns a CompletionSuggester.

type ComponentTemplateNode ¶ 

type ComponentTemplateNode struct {
	Meta_    map[string]interface{}   `json:"_meta,omitempty"`
	Template ComponentTemplateSummary `json:"template"`
	Version  *int64                   `json:"version,omitempty"`
}

ComponentTemplateNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/_types/ComponentTemplate.ts#L31-L36

func NewComponentTemplateNode ¶ added in v8.5.0 

func NewComponentTemplateNode() *ComponentTemplateNode

NewComponentTemplateNode returns a ComponentTemplateNode.

type ComponentTemplateSummary ¶ 

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

ComponentTemplateSummary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/_types/ComponentTemplate.ts#L38-L45

func NewComponentTemplateSummary ¶ added in v8.5.0 

func NewComponentTemplateSummary() *ComponentTemplateSummary

NewComponentTemplateSummary returns a ComponentTemplateSummary.

type CompositeAggregate ¶ 

type CompositeAggregate struct {
	AfterKey map[string]FieldValue  `json:"after_key,omitempty"`
	Buckets  BucketsCompositeBucket `json:"buckets"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
}

CompositeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L617-L622

func NewCompositeAggregate ¶ added in v8.5.0 

func NewCompositeAggregate() *CompositeAggregate

NewCompositeAggregate returns a CompositeAggregate.

type CompositeAggregateKey ¶ added in v8.5.0 

type CompositeAggregateKey map[string]FieldValue

CompositeAggregateKey type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L77-L77

type CompositeAggregation ¶ 

type CompositeAggregation struct {
	After   map[string]FieldValue                   `json:"after,omitempty"`
	Meta    map[string]interface{}                  `json:"meta,omitempty"`
	Name    *string                                 `json:"name,omitempty"`
	Size    *int                                    `json:"size,omitempty"`
	Sources []map[string]CompositeAggregationSource `json:"sources,omitempty"`
}

CompositeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L79-L84

func NewCompositeAggregation ¶ added in v8.5.0 

func NewCompositeAggregation() *CompositeAggregation

NewCompositeAggregation returns a CompositeAggregation.

type CompositeAggregationSource ¶ 

type CompositeAggregationSource struct {
	DateHistogram *DateHistogramAggregation `json:"date_histogram,omitempty"`
	GeotileGrid   *GeoTileGridAggregation   `json:"geotile_grid,omitempty"`
	Histogram     *HistogramAggregation     `json:"histogram,omitempty"`
	Terms         *TermsAggregation         `json:"terms,omitempty"`
}

CompositeAggregationSource type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L86-L91

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          map[string]FieldValue `json:"key"`
}

CompositeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L624-L626

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

type ConditionTokenFilter ¶ 

type ConditionTokenFilter struct {
	Filter  []string `json:"filter"`
	Script  Script   `json:"script"`
	Type    string   `json:"type,omitempty"`
	Version *string  `json:"version,omitempty"`
}

ConditionTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L180-L184

func NewConditionTokenFilter ¶ added in v8.5.0 

func NewConditionTokenFilter() *ConditionTokenFilter

NewConditionTokenFilter returns a ConditionTokenFilter.

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 map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L99-L129

func NewConfiguration ¶ added in v8.5.0 

func NewConfiguration() *Configuration

NewConfiguration returns a Configuration.

type Configurations ¶ 

type Configurations struct {
	Forcemerge *ForceMergeConfiguration `json:"forcemerge,omitempty"`
	Rollover   *RolloverConditions      `json:"rollover,omitempty"`
	Shrink     *ShrinkConfiguration     `json:"shrink,omitempty"`
}

Configurations type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L47-L51

func NewConfigurations ¶ added in v8.5.0 

func NewConfigurations() *Configurations

NewConfigurations returns a Configurations.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L84-L89

func NewConfusionMatrixItem ¶ added in v8.5.0 

func NewConfusionMatrixItem() *ConfusionMatrixItem

NewConfusionMatrixItem returns a ConfusionMatrixItem.

type ConfusionMatrixPrediction ¶ 

type ConfusionMatrixPrediction struct {
	Count          int    `json:"count"`
	PredictedClass string `json:"predicted_class"`
}

ConfusionMatrixPrediction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L91-L94

func NewConfusionMatrixPrediction ¶ added in v8.5.0 

func NewConfusionMatrixPrediction() *ConfusionMatrixPrediction

NewConfusionMatrixPrediction returns a ConfusionMatrixPrediction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L96-L117

func NewConfusionMatrixThreshold ¶ added in v8.5.0 

func NewConfusionMatrixThreshold() *ConfusionMatrixThreshold

NewConfusionMatrixThreshold returns a ConfusionMatrixThreshold.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/Connection.ts#L22-L27

func NewConnection ¶ added in v8.5.0 

func NewConnection() *Connection

NewConnection returns a Connection.

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"`
	Type       string              `json:"type,omitempty"`
	Value      interface{}         `json:"value,omitempty"`
}

ConstantKeywordProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L44-L47

func NewConstantKeywordProperty ¶ added in v8.5.0 

func NewConstantKeywordProperty() *ConstantKeywordProperty

NewConstantKeywordProperty returns a ConstantKeywordProperty.

type ConstantScoreQuery ¶ 

type ConstantScoreQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	Filter     *Query   `json:"filter,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

ConstantScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L42-L44

func NewConstantScoreQuery ¶ added in v8.5.0 

func NewConstantScoreQuery() *ConstantScoreQuery

NewConstantScoreQuery returns a ConstantScoreQuery.

type Context ¶ 

type Context interface{}

Context holds the union for the following types: 

string
GeoLocation

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L148-L153

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/get_script_context/types.ts#L27-L31

func NewContextMethod ¶ added in v8.5.0 

func NewContextMethod() *ContextMethod

NewContextMethod returns a ContextMethod.

type ContextMethodParam ¶ 

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

ContextMethodParam type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/get_script_context/types.ts#L33-L36

func NewContextMethodParam ¶ added in v8.5.0 

func NewContextMethodParam() *ContextMethodParam

NewContextMethodParam returns a ContextMethodParam.

type ConvertProcessor ¶ 

type ConvertProcessor struct {
	Description   *string                 `json:"description,omitempty"`
	Field         string                  `json:"field"`
	If            *string                 `json:"if,omitempty"`
	IgnoreFailure *bool                   `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                   `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer    `json:"on_failure,omitempty"`
	Tag           *string                 `json:"tag,omitempty"`
	TargetField   *string                 `json:"target_field,omitempty"`
	Type          converttype.ConvertType `json:"type"`
}

ConvertProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L147-L152

func NewConvertProcessor ¶ added in v8.5.0 

func NewConvertProcessor() *ConvertProcessor

NewConvertProcessor returns a ConvertProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/stats/types.ts#L29-L35

func NewCoordinatorStats ¶ added in v8.5.0 

func NewCoordinatorStats() *CoordinatorStats

NewCoordinatorStats returns a CoordinatorStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L138-L143

func NewCoordsGeoBounds ¶ added in v8.5.0 

func NewCoordsGeoBounds() *CoordsGeoBounds

NewCoordsGeoBounds returns a CoordsGeoBounds.

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 int64 `json:"k"`
	// NumCandidates The number of nearest neighbor candidates to consider per shard
	NumCandidates int64 `json:"num_candidates"`
	// QueryVector The query vector
	QueryVector []float64 `json:"query_vector"`
}

CoreKnnQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/knn_search/_types/Knn.ts#L25-L34

func NewCoreKnnQuery ¶ added in v8.5.0 

func NewCoreKnnQuery() *CoreKnnQuery

NewCoreKnnQuery returns a CoreKnnQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/count/types.ts#L23-L39

func NewCountRecord ¶ added in v8.5.0 

func NewCountRecord() *CountRecord

NewCountRecord returns a CountRecord.

type Counter ¶ 

type Counter struct {
	Active int64 `json:"active"`
	Total  int64 `json:"total"`
}

Counter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L35-L38

func NewCounter ¶ added in v8.5.0 

func NewCounter() *Counter

NewCounter returns a Counter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L212-L221

func NewCpu ¶ added in v8.5.0 

func NewCpu() *Cpu

NewCpu returns a Cpu.

type CpuAcct ¶ 

type CpuAcct struct {
	ControlGroup *string `json:"control_group,omitempty"`
	UsageNanos   *int64  `json:"usage_nanos,omitempty"`
}

CpuAcct type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L188-L191

func NewCpuAcct ¶ added in v8.5.0 

func NewCpuAcct() *CpuAcct

NewCpuAcct returns a CpuAcct.

type CreatedStatus ¶ 

type CreatedStatus struct {
	Created bool `json:"created"`
}

CreatedStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/CreatedStatus.ts#L20-L22

func NewCreatedStatus ¶ added in v8.5.0 

func NewCreatedStatus() *CreatedStatus

NewCreatedStatus returns a CreatedStatus.

type CsvProcessor ¶ 

type CsvProcessor struct {
	Description   *string              `json:"description,omitempty"`
	EmptyValue    interface{}          `json:"empty_value,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Quote         *string              `json:"quote,omitempty"`
	Separator     *string              `json:"separator,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetFields  []string             `json:"target_fields"`
	Trim          *bool                `json:"trim,omitempty"`
}

CsvProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L154-L162

func NewCsvProcessor ¶ added in v8.5.0 

func NewCsvProcessor() *CsvProcessor

NewCsvProcessor returns a CsvProcessor.

type CumulativeCardinalityAggregate ¶ 

type CumulativeCardinalityAggregate struct {
	Meta          map[string]interface{} `json:"meta,omitempty"`
	Value         int64                  `json:"value"`
	ValueAsString *string                `json:"value_as_string,omitempty"`
}

CumulativeCardinalityAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L738-L746

func NewCumulativeCardinalityAggregate ¶ added in v8.5.0 

func NewCumulativeCardinalityAggregate() *CumulativeCardinalityAggregate

NewCumulativeCardinalityAggregate returns a CumulativeCardinalityAggregate.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

CumulativeCardinalityAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L161-L161

func NewCumulativeCardinalityAggregation ¶ added in v8.5.0 

func NewCumulativeCardinalityAggregation() *CumulativeCardinalityAggregation

NewCumulativeCardinalityAggregation returns a CumulativeCardinalityAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

CumulativeSumAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L163-L163

func NewCumulativeSumAggregation ¶ added in v8.5.0 

func NewCumulativeSumAggregation() *CumulativeSumAggregation

NewCumulativeSumAggregation returns a CumulativeSumAggregation.

type CurrentNode ¶ 

type CurrentNode struct {
	Attributes       map[string]string `json:"attributes"`
	Id               string            `json:"id"`
	Name             string            `json:"name"`
	TransportAddress string            `json:"transport_address"`
	WeightRanking    int               `json:"weight_ranking"`
}

CurrentNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L78-L84

func NewCurrentNode ¶ added in v8.5.0 

func NewCurrentNode() *CurrentNode

NewCurrentNode returns a CurrentNode.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L28-L35

func NewCustomAnalyzer ¶ added in v8.5.0 

func NewCustomAnalyzer() *CustomAnalyzer

NewCustomAnalyzer returns a CustomAnalyzer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L508-L512

func NewCustomCategorizeTextAnalyzer ¶ added in v8.5.0 

func NewCustomCategorizeTextAnalyzer() *CustomCategorizeTextAnalyzer

NewCustomCategorizeTextAnalyzer returns a CustomCategorizeTextAnalyzer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/normalizers.ts#L30-L34

func NewCustomNormalizer ¶ added in v8.5.0 

func NewCustomNormalizer() *CustomNormalizer

NewCustomNormalizer returns a CustomNormalizer.

type CustomSettings ¶ 

type CustomSettings interface{}

CustomSettings type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Settings.ts#L22-L27

type DailySchedule ¶ 

type DailySchedule struct {
	At []ScheduleTimeOfDay `json:"at"`
}

DailySchedule type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponse.ts#L29-L34

func NewDanglingIndex ¶ added in v8.5.0 

func NewDanglingIndex() *DanglingIndex

NewDanglingIndex returns a DanglingIndex.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L129-L149

func NewDataCounts ¶ added in v8.5.0 

func NewDataCounts() *DataCounts

NewDataCounts returns a DataCounts.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L151-L167

func NewDataDescription ¶ added in v8.5.0 

func NewDataDescription() *DataDescription

NewDataDescription returns a DataDescription.

type DataEmailAttachment ¶ 

type DataEmailAttachment struct {
	Format *dataattachmentformat.DataAttachmentFormat `json:"format,omitempty"`
}

DataEmailAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 why the job is or is not assigned to a node
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// CreateTime job creation time
	CreateTime *string `json:"create_time,omitempty"`
	// Description description
	Description *string `json:"description,omitempty"`
	// DestIndex destination index
	DestIndex *string `json:"dest_index,omitempty"`
	// FailureReason failure reason
	FailureReason *string `json:"failure_reason,omitempty"`
	// Id the id
	Id *string `json:"id,omitempty"`
	// ModelMemoryLimit model memory limit
	ModelMemoryLimit *string `json:"model_memory_limit,omitempty"`
	// NodeAddress network address of the assigned node
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId ephemeral id of the assigned node
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId id of the assigned node
	NodeId *string `json:"node.id,omitempty"`
	// NodeName name of the assigned node
	NodeName *string `json:"node.name,omitempty"`
	// Progress progress
	Progress *string `json:"progress,omitempty"`
	// SourceIndex source index
	SourceIndex *string `json:"source_index,omitempty"`
	// State job state
	State *string `json:"state,omitempty"`
	// Type analysis type
	Type *string `json:"type,omitempty"`
	// Version the version of Elasticsearch when the analytics was created
	Version *string `json:"version,omitempty"`
}

DataFrameAnalyticsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/ml_data_frame_analytics/types.ts#L22-L102

func NewDataFrameAnalyticsRecord ¶ added in v8.5.0 

func NewDataFrameAnalyticsRecord() *DataFrameAnalyticsRecord

NewDataFrameAnalyticsRecord returns a DataFrameAnalyticsRecord.

type DataPathStats ¶ 

type DataPathStats struct {
	Available            *string `json:"available,omitempty"`
	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                 *string `json:"free,omitempty"`
	FreeInBytes          *int64  `json:"free_in_bytes,omitempty"`
	Mount                *string `json:"mount,omitempty"`
	Path                 *string `json:"path,omitempty"`
	Total                *string `json:"total,omitempty"`
	TotalInBytes         *int64  `json:"total_in_bytes,omitempty"`
	Type                 *string `json:"type,omitempty"`
}

DataPathStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L223-L240

func NewDataPathStats ¶ added in v8.5.0 

func NewDataPathStats() *DataPathStats

NewDataPathStats returns a DataPathStats.

type DataStream ¶ 

type DataStream struct {
	AllowCustomRouting *bool                     `json:"allow_custom_routing,omitempty"`
	Generation         int                       `json:"generation"`
	Hidden             bool                      `json:"hidden"`
	IlmPolicy          *string                   `json:"ilm_policy,omitempty"`
	Indices            []DataStreamIndex         `json:"indices"`
	Meta_              map[string]interface{}    `json:"_meta,omitempty"`
	Name               string                    `json:"name"`
	Replicated         *bool                     `json:"replicated,omitempty"`
	Status             healthstatus.HealthStatus `json:"status"`
	System             *bool                     `json:"system,omitempty"`
	Template           string                    `json:"template"`
	TimestampField     DataStreamTimestampField  `json:"timestamp_field"`
}

DataStream type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/DataStream.ts#L31-L46

func NewDataStream ¶ added in v8.5.0 

func NewDataStream() *DataStream

NewDataStream returns a DataStream.

type DataStreamIndex ¶ 

type DataStreamIndex struct {
	IndexName string `json:"index_name"`
	IndexUuid string `json:"index_uuid"`
}

DataStreamIndex type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/DataStream.ts#L52-L55

func NewDataStreamIndex ¶ added in v8.5.0 

func NewDataStreamIndex() *DataStreamIndex

NewDataStreamIndex returns a DataStreamIndex.

type DataStreamNames ¶ 

type DataStreamNames []string

DataStreamNames type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L86-L86

type DataStreamTimestamp ¶ 

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

DataStreamTimestamp type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/TypeMapping.ts#L57-L59

func NewDataStreamTimestamp ¶ added in v8.5.0 

func NewDataStreamTimestamp() *DataStreamTimestamp

NewDataStreamTimestamp returns a DataStreamTimestamp.

type DataStreamTimestampField ¶ 

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

DataStreamTimestampField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/DataStream.ts#L48-L50

func NewDataStreamTimestampField ¶ added in v8.5.0 

func NewDataStreamTimestampField() *DataStreamTimestampField

NewDataStreamTimestampField returns a DataStreamTimestampField.

type DataStreamVisibility ¶ 

type DataStreamVisibility struct {
	Hidden *bool `json:"hidden,omitempty"`
}

DataStreamVisibility type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/DataStream.ts#L57-L59

func NewDataStreamVisibility ¶ added in v8.5.0 

func NewDataStreamVisibility() *DataStreamVisibility

NewDataStreamVisibility returns a DataStreamVisibility.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L77-L80

func NewDataStreams ¶ added in v8.5.0 

func NewDataStreams() *DataStreams

NewDataStreams returns a DataStreams.

type DataStreamsStatsItem ¶ 

type DataStreamsStatsItem struct {
	BackingIndices   int       `json:"backing_indices"`
	DataStream       string    `json:"data_stream"`
	MaximumTimestamp int64     `json:"maximum_timestamp"`
	StoreSize        *ByteSize `json:"store_size,omitempty"`
	StoreSizeBytes   int       `json:"store_size_bytes"`
}

DataStreamsStatsItem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts#L36-L42

func NewDataStreamsStatsItem ¶ added in v8.5.0 

func NewDataStreamsStatsItem() *DataStreamsStatsItem

NewDataStreamsStatsItem returns a DataStreamsStatsItem.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L82-L93

func NewDataTierPhaseStatistics ¶ added in v8.5.0 

func NewDataTierPhaseStatistics() *DataTierPhaseStatistics

NewDataTierPhaseStatistics returns a DataTierPhaseStatistics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L324-L331

func NewDataTiers ¶ added in v8.5.0 

func NewDataTiers() *DataTiers

NewDataTiers returns a DataTiers.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Authorization.ts#L31-L43

func NewDatafeedAuthorization ¶ added in v8.5.0 

func NewDatafeedAuthorization() *DatafeedAuthorization

NewDatafeedAuthorization returns a DatafeedAuthorization.

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"`
	Indexes   []string  `json:"indexes,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"`
	// 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"`
	// 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 map[string]RuntimeField `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L60-L117

func NewDatafeedConfig ¶ added in v8.5.0 

func NewDatafeedConfig() *DatafeedConfig

NewDatafeedConfig returns a DatafeedConfig.

type DatafeedRunningState ¶ 

type DatafeedRunningState struct {
	RealTimeConfigured bool                        `json:"real_time_configured"`
	RealTimeRunning    bool                        `json:"real_time_running"`
	SearchInterval     *RunningStateSearchInterval `json:"search_interval,omitempty"`
}

DatafeedRunningState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L158-L162

func NewDatafeedRunningState ¶ added in v8.5.0 

func NewDatafeedRunningState() *DatafeedRunningState

NewDatafeedRunningState returns a DatafeedRunningState.

type DatafeedStats ¶ 

type DatafeedStats struct {
	AssignmentExplanation *string                     `json:"assignment_explanation,omitempty"`
	DatafeedId            string                      `json:"datafeed_id"`
	Node                  *DiscoveryNode              `json:"node,omitempty"`
	RunningState          *DatafeedRunningState       `json:"running_state,omitempty"`
	State                 datafeedstate.DatafeedState `json:"state"`
	TimingStats           DatafeedTimingStats         `json:"timing_stats"`
}

DatafeedStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L140-L147

func NewDatafeedStats ¶ added in v8.5.0 

func NewDatafeedStats() *DatafeedStats

NewDatafeedStats returns a DatafeedStats.

type DatafeedTimingStats ¶ 

type DatafeedTimingStats struct {
	AverageSearchTimePerBucketMs          *float64 `json:"average_search_time_per_bucket_ms,omitempty"`
	BucketCount                           int64    `json:"bucket_count"`
	ExponentialAverageSearchTimePerHourMs float64  `json:"exponential_average_search_time_per_hour_ms"`
	JobId                                 string   `json:"job_id"`
	SearchCount                           int64    `json:"search_count"`
	TotalSearchTimeMs                     float64  `json:"total_search_time_ms"`
}

DatafeedTimingStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L149-L156

func NewDatafeedTimingStats ¶ added in v8.5.0 

func NewDatafeedTimingStats() *DatafeedTimingStats

NewDatafeedTimingStats returns a DatafeedTimingStats.

type Datafeeds ¶ 

type Datafeeds struct {
	ScrollSize int `json:"scroll_size"`
}

Datafeeds type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/info/types.ts#L40-L42

func NewDatafeeds ¶ added in v8.5.0 

func NewDatafeeds() *Datafeeds

NewDatafeeds returns a Datafeeds.

type DatafeedsRecord ¶ 

type DatafeedsRecord struct {
	// AssignmentExplanation why the datafeed is or is not assigned to a node
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// BucketsCount bucket count
	BucketsCount *string `json:"buckets.count,omitempty"`
	// Id the datafeed_id
	Id *string `json:"id,omitempty"`
	// NodeAddress network address of the assigned node
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId ephemeral id of the assigned node
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId id of the assigned node
	NodeId *string `json:"node.id,omitempty"`
	// NodeName name of the assigned node
	NodeName *string `json:"node.name,omitempty"`
	// SearchBucketAvg the average search time per bucket (millisecond)
	SearchBucketAvg *string `json:"search.bucket_avg,omitempty"`
	// SearchCount number of searches ran by the datafeed
	SearchCount *string `json:"search.count,omitempty"`
	// SearchExpAvgHour the exponential average search time per hour (millisecond)
	SearchExpAvgHour *string `json:"search.exp_avg_hour,omitempty"`
	// SearchTime the total search time
	SearchTime *string `json:"search.time,omitempty"`
	// State the datafeed state
	State *datafeedstate.DatafeedState `json:"state,omitempty"`
}

DatafeedsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/ml_datafeeds/types.ts#L22-L83

func NewDatafeedsRecord ¶ added in v8.5.0 

func NewDatafeedsRecord() *DatafeedsRecord

NewDatafeedsRecord returns a DatafeedsRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L134-L213

func NewDataframeAnalysis ¶ added in v8.5.0 

func NewDataframeAnalysis() *DataframeAnalysis

NewDataframeAnalysis returns a DataframeAnalysis.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L238-L244

func NewDataframeAnalysisAnalyzedFields ¶ added in v8.5.0 

func NewDataframeAnalysisAnalyzedFields() *DataframeAnalysisAnalyzedFields

NewDataframeAnalysisAnalyzedFields returns a DataframeAnalysisAnalyzedFields.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L227-L236

func NewDataframeAnalysisClassification ¶ added in v8.5.0 

func NewDataframeAnalysisClassification() *DataframeAnalysisClassification

NewDataframeAnalysisClassification returns a DataframeAnalysisClassification.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L260-L267

func NewDataframeAnalysisFeatureProcessorFrequencyEncoding ¶ added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorFrequencyEncoding() *DataframeAnalysisFeatureProcessorFrequencyEncoding

NewDataframeAnalysisFeatureProcessorFrequencyEncoding returns a DataframeAnalysisFeatureProcessorFrequencyEncoding.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L274-L286

func NewDataframeAnalysisFeatureProcessorNGramEncoding ¶ added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorNGramEncoding() *DataframeAnalysisFeatureProcessorNGramEncoding

NewDataframeAnalysisFeatureProcessorNGramEncoding returns a DataframeAnalysisFeatureProcessorNGramEncoding.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L288-L293

func NewDataframeAnalysisFeatureProcessorOneHotEncoding ¶ added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorOneHotEncoding() *DataframeAnalysisFeatureProcessorOneHotEncoding

NewDataframeAnalysisFeatureProcessorOneHotEncoding returns a DataframeAnalysisFeatureProcessorOneHotEncoding.

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]interface{} `json:"target_map"`
}

DataframeAnalysisFeatureProcessorTargetMeanEncoding type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L295-L304

func NewDataframeAnalysisFeatureProcessorTargetMeanEncoding ¶ added in v8.5.0 

func NewDataframeAnalysisFeatureProcessorTargetMeanEncoding() *DataframeAnalysisFeatureProcessorTargetMeanEncoding

NewDataframeAnalysisFeatureProcessorTargetMeanEncoding returns a DataframeAnalysisFeatureProcessorTargetMeanEncoding.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L103-L132

func NewDataframeAnalysisOutlierDetection ¶ added in v8.5.0 

func NewDataframeAnalysisOutlierDetection() *DataframeAnalysisOutlierDetection

NewDataframeAnalysisOutlierDetection returns a DataframeAnalysisOutlierDetection.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L215-L225

func NewDataframeAnalysisRegression ¶ added in v8.5.0 

func NewDataframeAnalysisRegression() *DataframeAnalysisRegression

NewDataframeAnalysisRegression returns a DataframeAnalysisRegression.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L324-L341

func NewDataframeAnalytics ¶ added in v8.5.0 

func NewDataframeAnalytics() *DataframeAnalytics

NewDataframeAnalytics returns a DataframeAnalytics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Authorization.ts#L45-L57

func NewDataframeAnalyticsAuthorization ¶ added in v8.5.0 

func NewDataframeAnalyticsAuthorization() *DataframeAnalyticsAuthorization

NewDataframeAnalyticsAuthorization returns a DataframeAnalyticsAuthorization.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L77-L82

func NewDataframeAnalyticsDestination ¶ added in v8.5.0 

func NewDataframeAnalyticsDestination() *DataframeAnalyticsDestination

NewDataframeAnalyticsDestination returns a DataframeAnalyticsDestination.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L55-L68

func NewDataframeAnalyticsFieldSelection ¶ added in v8.5.0 

func NewDataframeAnalyticsFieldSelection() *DataframeAnalyticsFieldSelection

NewDataframeAnalyticsFieldSelection returns a DataframeAnalyticsFieldSelection.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L70-L75

func NewDataframeAnalyticsMemoryEstimation ¶ added in v8.5.0 

func NewDataframeAnalyticsMemoryEstimation() *DataframeAnalyticsMemoryEstimation

NewDataframeAnalyticsMemoryEstimation returns a DataframeAnalyticsMemoryEstimation.

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 map[string]RuntimeField `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L39-L53

func NewDataframeAnalyticsSource ¶ added in v8.5.0 

func NewDataframeAnalyticsSource() *DataframeAnalyticsSource

NewDataframeAnalyticsSource returns a DataframeAnalyticsSource.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L370-L378

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L361-L368

func NewDataframeAnalyticsStatsDataCounts ¶ added in v8.5.0 

func NewDataframeAnalyticsStatsDataCounts() *DataframeAnalyticsStatsDataCounts

NewDataframeAnalyticsStatsDataCounts returns a DataframeAnalyticsStatsDataCounts.

type DataframeAnalyticsStatsHyperparameters ¶ 

type DataframeAnalyticsStatsHyperparameters struct {
	Hyperparameters Hyperparameters `json:"hyperparameters"`
	// Iteration The number of iterations on the analysis.
	Iteration      int            `json:"iteration"`
	Timestamp      int64          `json:"timestamp"`
	TimingStats    TimingStats    `json:"timing_stats"`
	ValidationLoss ValidationLoss `json:"validation_loss"`
}

DataframeAnalyticsStatsHyperparameters type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L380-L387

func NewDataframeAnalyticsStatsHyperparameters ¶ added in v8.5.0 

func NewDataframeAnalyticsStatsHyperparameters() *DataframeAnalyticsStatsHyperparameters

NewDataframeAnalyticsStatsHyperparameters returns a DataframeAnalyticsStatsHyperparameters.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L350-L359

func NewDataframeAnalyticsStatsMemoryUsage ¶ added in v8.5.0 

func NewDataframeAnalyticsStatsMemoryUsage() *DataframeAnalyticsStatsMemoryUsage

NewDataframeAnalyticsStatsMemoryUsage returns a DataframeAnalyticsStatsMemoryUsage.

type DataframeAnalyticsStatsOutlierDetection ¶ 

type DataframeAnalyticsStatsOutlierDetection struct {
	Parameters  OutlierDetectionParameters `json:"parameters"`
	Timestamp   int64                      `json:"timestamp"`
	TimingStats TimingStats                `json:"timing_stats"`
}

DataframeAnalyticsStatsOutlierDetection type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L389-L393

func NewDataframeAnalyticsStatsOutlierDetection ¶ added in v8.5.0 

func NewDataframeAnalyticsStatsOutlierDetection() *DataframeAnalyticsStatsOutlierDetection

NewDataframeAnalyticsStatsOutlierDetection returns a DataframeAnalyticsStatsOutlierDetection.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L343-L348

func NewDataframeAnalyticsStatsProgress ¶ added in v8.5.0 

func NewDataframeAnalyticsStatsProgress() *DataframeAnalyticsStatsProgress

NewDataframeAnalyticsStatsProgress returns a DataframeAnalyticsStatsProgress.

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"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L306-L322

func NewDataframeAnalyticsSummary ¶ added in v8.5.0 

func NewDataframeAnalyticsSummary() *DataframeAnalyticsSummary

NewDataframeAnalyticsSummary returns a DataframeAnalyticsSummary.

type DataframeClassificationSummary ¶ 

type DataframeClassificationSummary struct {
	Accuracy                  *DataframeClassificationSummaryAccuracy                  `json:"accuracy,omitempty"`
	AucRoc                    *DataframeEvaluationSummaryAucRoc                        `json:"auc_roc,omitempty"`
	MulticlassConfusionMatrix *DataframeClassificationSummaryMulticlassConfusionMatrix `json:"multiclass_confusion_matrix,omitempty"`
	Precision                 *DataframeClassificationSummaryPrecision                 `json:"precision,omitempty"`
	Recall                    *DataframeClassificationSummaryRecall                    `json:"recall,omitempty"`
}

DataframeClassificationSummary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L31-L37

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L70-L73

func NewDataframeClassificationSummaryAccuracy ¶ added in v8.5.0 

func NewDataframeClassificationSummaryAccuracy() *DataframeClassificationSummaryAccuracy

NewDataframeClassificationSummaryAccuracy returns a DataframeClassificationSummaryAccuracy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L79-L82

func NewDataframeClassificationSummaryMulticlassConfusionMatrix ¶ added in v8.5.0 

func NewDataframeClassificationSummaryMulticlassConfusionMatrix() *DataframeClassificationSummaryMulticlassConfusionMatrix

NewDataframeClassificationSummaryMulticlassConfusionMatrix returns a DataframeClassificationSummaryMulticlassConfusionMatrix.

type DataframeClassificationSummaryPrecision ¶ 

type DataframeClassificationSummaryPrecision struct {
	AvgPrecision float64                    `json:"avg_precision"`
	Classes      []DataframeEvaluationClass `json:"classes"`
}

DataframeClassificationSummaryPrecision type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L60-L63

func NewDataframeClassificationSummaryPrecision ¶ added in v8.5.0 

func NewDataframeClassificationSummaryPrecision() *DataframeClassificationSummaryPrecision

NewDataframeClassificationSummaryPrecision returns a DataframeClassificationSummaryPrecision.

type DataframeClassificationSummaryRecall ¶ 

type DataframeClassificationSummaryRecall struct {
	AvgRecall float64                    `json:"avg_recall"`
	Classes   []DataframeEvaluationClass `json:"classes"`
}

DataframeClassificationSummaryRecall type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L65-L68

func NewDataframeClassificationSummaryRecall ¶ added in v8.5.0 

func NewDataframeClassificationSummaryRecall() *DataframeClassificationSummaryRecall

NewDataframeClassificationSummaryRecall returns a DataframeClassificationSummaryRecall.

type DataframeEvaluationClass ¶ 

type DataframeEvaluationClass struct {
	ClassName string  `json:"class_name"`
	Value     float64 `json:"value"`
}

DataframeEvaluationClass type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L75-L77

func NewDataframeEvaluationClass ¶ added in v8.5.0 

func NewDataframeEvaluationClass() *DataframeEvaluationClass

NewDataframeEvaluationClass returns a DataframeEvaluationClass.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L35-L44

func NewDataframeEvaluationClassification ¶ added in v8.5.0 

func NewDataframeEvaluationClassification() *DataframeEvaluationClassification

NewDataframeEvaluationClassification returns a DataframeEvaluationClassification.

type DataframeEvaluationClassificationMetrics ¶ 

type DataframeEvaluationClassificationMetrics struct {
	// Accuracy Accuracy of predictions (per-class and overall).
	Accuracy map[string]interface{} `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]interface{} `json:"multiclass_confusion_matrix,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision map[string]interface{} `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]interface{} `json:"recall,omitempty"`
}

DataframeEvaluationClassificationMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L85-L90

func NewDataframeEvaluationClassificationMetricsAucRoc ¶ added in v8.5.0 

func NewDataframeEvaluationClassificationMetricsAucRoc() *DataframeEvaluationClassificationMetricsAucRoc

NewDataframeEvaluationClassificationMetricsAucRoc returns a DataframeEvaluationClassificationMetricsAucRoc.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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]interface{} `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]interface{} `json:"recall,omitempty"`
}

DataframeEvaluationMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L46-L53

func NewDataframeEvaluationOutlierDetection ¶ added in v8.5.0 

func NewDataframeEvaluationOutlierDetection() *DataframeEvaluationOutlierDetection

NewDataframeEvaluationOutlierDetection returns a DataframeEvaluationOutlierDetection.

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]interface{} `json:"confusion_matrix,omitempty"`
	// Precision Precision of predictions (per-class and average).
	Precision map[string]interface{} `json:"precision,omitempty"`
	// Recall Recall of predictions (per-class and average).
	Recall map[string]interface{} `json:"recall,omitempty"`
}

DataframeEvaluationOutlierDetectionMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L55-L62

func NewDataframeEvaluationRegression ¶ added in v8.5.0 

func NewDataframeEvaluationRegression() *DataframeEvaluationRegression

NewDataframeEvaluationRegression returns a DataframeEvaluationRegression.

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]interface{} `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]interface{} `json:"r_squared,omitempty"`
}

DataframeEvaluationRegressionMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L117-L120

func NewDataframeEvaluationRegressionMetricsHuber ¶ added in v8.5.0 

func NewDataframeEvaluationRegressionMetricsHuber() *DataframeEvaluationRegressionMetricsHuber

NewDataframeEvaluationRegressionMetricsHuber returns a DataframeEvaluationRegressionMetricsHuber.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeEvaluation.ts#L112-L115

func NewDataframeEvaluationRegressionMetricsMsle ¶ added in v8.5.0 

func NewDataframeEvaluationRegressionMetricsMsle() *DataframeEvaluationRegressionMetricsMsle

NewDataframeEvaluationRegressionMetricsMsle returns a DataframeEvaluationRegressionMetricsMsle.

type DataframeEvaluationSummaryAucRoc ¶ 

type DataframeEvaluationSummaryAucRoc struct {
	Curve []DataframeEvaluationSummaryAucRocCurveItem `json:"curve,omitempty"`
	Value float64                                     `json:"value"`
}

DataframeEvaluationSummaryAucRoc type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L50-L52

func NewDataframeEvaluationSummaryAucRoc ¶ added in v8.5.0 

func NewDataframeEvaluationSummaryAucRoc() *DataframeEvaluationSummaryAucRoc

NewDataframeEvaluationSummaryAucRoc returns a DataframeEvaluationSummaryAucRoc.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L54-L58

func NewDataframeEvaluationSummaryAucRocCurveItem ¶ added in v8.5.0 

func NewDataframeEvaluationSummaryAucRocCurveItem() *DataframeEvaluationSummaryAucRocCurveItem

NewDataframeEvaluationSummaryAucRocCurveItem returns a DataframeEvaluationSummaryAucRocCurveItem.

type DataframeEvaluationValue ¶ 

type DataframeEvaluationValue struct {
	Value float64 `json:"value"`
}

DataframeEvaluationValue type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L46-L48

func NewDataframeEvaluationValue ¶ added in v8.5.0 

func NewDataframeEvaluationValue() *DataframeEvaluationValue

NewDataframeEvaluationValue returns a DataframeEvaluationValue.

type DataframeOutlierDetectionSummary ¶ 

type DataframeOutlierDetectionSummary struct {
	AucRoc          *DataframeEvaluationSummaryAucRoc   `json:"auc_roc,omitempty"`
	ConfusionMatrix map[string]ConfusionMatrixThreshold `json:"confusion_matrix,omitempty"`
	Precision       map[string]float64                  `json:"precision,omitempty"`
	Recall          map[string]float64                  `json:"recall,omitempty"`
}

DataframeOutlierDetectionSummary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L24-L29

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/preview_data_frame_analytics/types.ts#L27-L33

func NewDataframePreviewConfig ¶ added in v8.5.0 

func NewDataframePreviewConfig() *DataframePreviewConfig

NewDataframePreviewConfig returns a DataframePreviewConfig.

type DataframeRegressionSummary ¶ 

type DataframeRegressionSummary struct {
	Huber    *DataframeEvaluationValue `json:"huber,omitempty"`
	Mse      *DataframeEvaluationValue `json:"mse,omitempty"`
	Msle     *DataframeEvaluationValue `json:"msle,omitempty"`
	RSquared *DataframeEvaluationValue `json:"r_squared,omitempty"`
}

DataframeRegressionSummary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/evaluate_data_frame/types.ts#L39-L44

func NewDataframeRegressionSummary ¶ added in v8.5.0 

func NewDataframeRegressionSummary() *DataframeRegressionSummary

NewDataframeRegressionSummary returns a DataframeRegressionSummary.

type DateDecayFunction ¶ 

type DateDecayFunction struct {
	DateDecayFunction map[string]DecayPlacementDateMathDuration `json:"-"`
	MultiValueMode    *multivaluemode.MultiValueMode            `json:"multi_value_mode,omitempty"`
}

DateDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L92-L94

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      *float32 `json:"boost,omitempty"`
	Field      string   `json:"field"`
	Origin     string   `json:"origin"`
	Pivot      Duration `json:"pivot"`
	QueryName_ *string  `json:"_name,omitempty"`
}

DateDistanceFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L51-L54

func NewDateDistanceFeatureQuery ¶ added in v8.5.0 

func NewDateDistanceFeatureQuery() *DateDistanceFeatureQuery

NewDateDistanceFeatureQuery returns a DateDistanceFeatureQuery.

type DateHistogramAggregate ¶ 

type DateHistogramAggregate struct {
	Buckets BucketsDateHistogramBucket `json:"buckets"`
	Meta    map[string]interface{}     `json:"meta,omitempty"`
}

DateHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L347-L348

func NewDateHistogramAggregate ¶ added in v8.5.0 

func NewDateHistogramAggregate() *DateHistogramAggregate

NewDateHistogramAggregate returns a DateHistogramAggregate.

type DateHistogramAggregation ¶ 

type DateHistogramAggregation struct {
	CalendarInterval *calendarinterval.CalendarInterval `json:"calendar_interval,omitempty"`
	ExtendedBounds   *ExtendedBoundsFieldDateMath       `json:"extended_bounds,omitempty"`
	Field            *string                            `json:"field,omitempty"`
	FixedInterval    *Duration                          `json:"fixed_interval,omitempty"`
	Format           *string                            `json:"format,omitempty"`
	HardBounds       *ExtendedBoundsFieldDateMath       `json:"hard_bounds,omitempty"`
	Interval         *Duration                          `json:"interval,omitempty"`
	Keyed            *bool                              `json:"keyed,omitempty"`
	Meta             map[string]interface{}             `json:"meta,omitempty"`
	MinDocCount      *int                               `json:"min_doc_count,omitempty"`
	Missing          *DateTime                          `json:"missing,omitempty"`
	Name             *string                            `json:"name,omitempty"`
	Offset           *Duration                          `json:"offset,omitempty"`
	Order            *AggregateOrder                    `json:"order,omitempty"`
	Params           map[string]interface{}             `json:"params,omitempty"`
	Script           *Script                            `json:"script,omitempty"`
	TimeZone         *string                            `json:"time_zone,omitempty"`
}

DateHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L93-L110

func NewDateHistogramAggregation ¶ added in v8.5.0 

func NewDateHistogramAggregation() *DateHistogramAggregation

NewDateHistogramAggregation returns a DateHistogramAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L350-L353

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

type DateHistogramGrouping ¶ 

type DateHistogramGrouping struct {
	CalendarInterval *Duration `json:"calendar_interval,omitempty"`
	Delay            *Duration `json:"delay,omitempty"`
	Field            string    `json:"field"`
	FixedInterval    *Duration `json:"fixed_interval,omitempty"`
	Format           *string   `json:"format,omitempty"`
	Interval         *Duration `json:"interval,omitempty"`
	TimeZone         *string   `json:"time_zone,omitempty"`
}

DateHistogramGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/_types/Groupings.ts#L30-L38

func NewDateHistogramGrouping ¶ added in v8.5.0 

func NewDateHistogramGrouping() *DateHistogramGrouping

NewDateHistogramGrouping returns a DateHistogramGrouping.

type DateIndexNameProcessor ¶ 

type DateIndexNameProcessor struct {
	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     *string              `json:"description,omitempty"`
	Field           string               `json:"field"`
	If              *string              `json:"if,omitempty"`
	IgnoreFailure   *bool                `json:"ignore_failure,omitempty"`
	IndexNameFormat *string              `json:"index_name_format,omitempty"`
	IndexNamePrefix *string              `json:"index_name_prefix,omitempty"`
	Locale          *string              `json:"locale,omitempty"`
	OnFailure       []ProcessorContainer `json:"on_failure,omitempty"`
	Tag             *string              `json:"tag,omitempty"`
	Timezone        *string              `json:"timezone,omitempty"`
}

DateIndexNameProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L164-L177

func NewDateIndexNameProcessor ¶ added in v8.5.0 

func NewDateIndexNameProcessor() *DateIndexNameProcessor

NewDateIndexNameProcessor returns a DateIndexNameProcessor.

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"`
	PrecisionStep *int                `json:"precision_step,omitempty"`
	Properties    map[string]Property `json:"properties,omitempty"`
	Similarity    *string             `json:"similarity,omitempty"`
	Store         *bool               `json:"store,omitempty"`
	Type          string              `json:"type,omitempty"`
}

DateNanosProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L73-L81

func NewDateNanosProperty ¶ added in v8.5.0 

func NewDateNanosProperty() *DateNanosProperty

NewDateNanosProperty returns a DateNanosProperty.

type DateProcessor ¶ 

type DateProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	Formats       []string             `json:"formats"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	Locale        *string              `json:"locale,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
	Timezone      *string              `json:"timezone,omitempty"`
}

DateProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L179-L185

func NewDateProcessor ¶ added in v8.5.0 

func NewDateProcessor() *DateProcessor

NewDateProcessor returns a DateProcessor.

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"`
	PrecisionStep *int                `json:"precision_step,omitempty"`
	Properties    map[string]Property `json:"properties,omitempty"`
	Similarity    *string             `json:"similarity,omitempty"`
	Store         *bool               `json:"store,omitempty"`
	Type          string              `json:"type,omitempty"`
}

DateProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L61-L71

func NewDateProperty ¶ added in v8.5.0 

func NewDateProperty() *DateProperty

NewDateProperty returns a DateProperty.

type DateRangeAggregate ¶ 

type DateRangeAggregate struct {
	Buckets BucketsRangeBucket     `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

DateRangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L542-L547

func NewDateRangeAggregate ¶ added in v8.5.0 

func NewDateRangeAggregate() *DateRangeAggregate

NewDateRangeAggregate returns a DateRangeAggregate.

type DateRangeAggregation ¶ 

type DateRangeAggregation struct {
	Field    *string                `json:"field,omitempty"`
	Format   *string                `json:"format,omitempty"`
	Keyed    *bool                  `json:"keyed,omitempty"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
	Missing  *Missing               `json:"missing,omitempty"`
	Name     *string                `json:"name,omitempty"`
	Ranges   []DateRangeExpression  `json:"ranges,omitempty"`
	TimeZone *string                `json:"time_zone,omitempty"`
}

DateRangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L131-L138

func NewDateRangeAggregation ¶ added in v8.5.0 

func NewDateRangeAggregation() *DateRangeAggregation

NewDateRangeAggregation returns a DateRangeAggregation.

type DateRangeExpression ¶ 

type DateRangeExpression struct {
	From *FieldDateMath `json:"from,omitempty"`
	Key  *string        `json:"key,omitempty"`
	To   *FieldDateMath `json:"to,omitempty"`
}

DateRangeExpression type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L149-L153

func NewDateRangeExpression ¶ added in v8.5.0 

func NewDateRangeExpression() *DateRangeExpression

NewDateRangeExpression returns a DateRangeExpression.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

DateRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L29-L32

func NewDateRangeProperty ¶ added in v8.5.0 

func NewDateRangeProperty() *DateRangeProperty

NewDateRangeProperty returns a DateRangeProperty.

type DateRangeQuery ¶ 

type DateRangeQuery struct {
	Boost      *float32                     `json:"boost,omitempty"`
	Format     *string                      `json:"format,omitempty"`
	From       string                       `json:"from,omitempty"`
	Gt         *string                      `json:"gt,omitempty"`
	Gte        *string                      `json:"gte,omitempty"`
	Lt         *string                      `json:"lt,omitempty"`
	Lte        *string                      `json:"lte,omitempty"`
	QueryName_ *string                      `json:"_name,omitempty"`
	Relation   *rangerelation.RangeRelation `json:"relation,omitempty"`
	TimeZone   *string                      `json:"time_zone,omitempty"`
	To         string                       `json:"to,omitempty"`
}

DateRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L72-L81

func NewDateRangeQuery ¶ added in v8.5.0 

func NewDateRangeQuery() *DateRangeQuery

NewDateRangeQuery returns a DateRangeQuery.

type DateTime ¶ 

type DateTime interface{}

DateTime holds the union for the following types: 

string
int64

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L22-L27

type DecayFunction ¶ 

type DecayFunction interface {
	// contains filtered or unexported methods
}

DecayFunction holds the union for the following types: 

DateDecayFunction
NumericDecayFunction
GeoDecayFunction

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L100-L105

type DecayPlacementDateMathDuration ¶ 

type DecayPlacementDateMathDuration struct {
	Decay  *float64  `json:"decay,omitempty"`
	Offset *Duration `json:"offset,omitempty"`
	Origin *string   `json:"origin,omitempty"`
	Scale  *Duration `json:"scale,omitempty"`
}

DecayPlacementDateMathDuration type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L77-L82

func NewDecayPlacementDateMathDuration ¶ added in v8.5.0 

func NewDecayPlacementDateMathDuration() *DecayPlacementDateMathDuration

NewDecayPlacementDateMathDuration returns a DecayPlacementDateMathDuration.

type DecayPlacementGeoLocationDistance ¶ 

type DecayPlacementGeoLocationDistance struct {
	Decay  *float64     `json:"decay,omitempty"`
	Offset *string      `json:"offset,omitempty"`
	Origin *GeoLocation `json:"origin,omitempty"`
	Scale  *string      `json:"scale,omitempty"`
}

DecayPlacementGeoLocationDistance type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L77-L82

func NewDecayPlacementGeoLocationDistance ¶ added in v8.5.0 

func NewDecayPlacementGeoLocationDistance() *DecayPlacementGeoLocationDistance

NewDecayPlacementGeoLocationDistance returns a DecayPlacementGeoLocationDistance.

type DecayPlacementdoubledouble ¶ 

type DecayPlacementdoubledouble struct {
	Decay  *float64 `json:"decay,omitempty"`
	Offset *float64 `json:"offset,omitempty"`
	Origin *float64 `json:"origin,omitempty"`
	Scale  *float64 `json:"scale,omitempty"`
}

DecayPlacementdoubledouble type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L77-L82

func NewDecayPlacementdoubledouble ¶ added in v8.5.0 

func NewDecayPlacementdoubledouble() *DecayPlacementdoubledouble

NewDecayPlacementdoubledouble returns a DecayPlacementdoubledouble.

type Defaults ¶ 

type Defaults struct {
	AnomalyDetectors AnomalyDetectors `json:"anomaly_detectors"`
	Datafeeds        Datafeeds        `json:"datafeeds"`
}

Defaults type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L119-L130

func NewDelayedDataCheckConfig ¶ added in v8.5.0 

func NewDelayedDataCheckConfig() *DelayedDataCheckConfig

NewDelayedDataCheckConfig returns a DelayedDataCheckConfig.

type DelimitedPayloadTokenFilter ¶ 

type DelimitedPayloadTokenFilter struct {
	Delimiter *string                                            `json:"delimiter,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L67-L71

func NewDelimitedPayloadTokenFilter ¶ added in v8.5.0 

func NewDelimitedPayloadTokenFilter() *DelimitedPayloadTokenFilter

NewDelimitedPayloadTokenFilter returns a DelimitedPayloadTokenFilter.

type DenseVectorIndexOptions ¶ 

type DenseVectorIndexOptions struct {
	EfConstruction int    `json:"ef_construction"`
	M              int    `json:"m"`
	Type           string `json:"type"`
}

DenseVectorIndexOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/DenseVectorIndexOptions.ts#L22-L26

func NewDenseVectorIndexOptions ¶ added in v8.5.0 

func NewDenseVectorIndexOptions() *DenseVectorIndexOptions

NewDenseVectorIndexOptions returns a DenseVectorIndexOptions.

type DenseVectorProperty ¶ 

type DenseVectorProperty struct {
	Dims         int                            `json:"dims"`
	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 *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 *string             `json:"similarity,omitempty"`
	Type       string              `json:"type,omitempty"`
}

DenseVectorProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/complex.ts#L51-L57

func NewDenseVectorProperty ¶ added in v8.5.0 

func NewDenseVectorProperty() *DenseVectorProperty

NewDenseVectorProperty returns a DenseVectorProperty.

type Deprecation ¶ 

type Deprecation struct {
	Details string `json:"details"`
	// Level The level property describes the significance of the issue.
	Level   deprecationlevel.DeprecationLevel `json:"level"`
	Message string                            `json:"message"`
	Url     string                            `json:"url"`
}

Deprecation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/migration/deprecations/types.ts#L29-L35

func NewDeprecation ¶ added in v8.5.0 

func NewDeprecation() *Deprecation

NewDeprecation returns a Deprecation.

type DeprecationIndexing ¶ 

type DeprecationIndexing struct {
	Enabled string `json:"enabled"`
}

DeprecationIndexing type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L140-L142

func NewDeprecationIndexing ¶ added in v8.5.0 

func NewDeprecationIndexing() *DeprecationIndexing

NewDeprecationIndexing returns a DeprecationIndexing.

type DerivativeAggregate ¶ 

type DerivativeAggregate struct {
	Meta                    map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L226-L230

func NewDerivativeAggregate ¶ added in v8.5.0 

func NewDerivativeAggregate() *DerivativeAggregate

NewDerivativeAggregate returns a DerivativeAggregate.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

DerivativeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L165-L165

func NewDerivativeAggregation ¶ added in v8.5.0 

func NewDerivativeAggregation() *DerivativeAggregation

NewDerivativeAggregation returns a DerivativeAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Detector.ts#L25-L67

func NewDetector ¶ added in v8.5.0 

func NewDetector() *Detector

NewDetector returns a Detector.

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 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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Detector.ts#L69-L80

func NewDetectorRead ¶ added in v8.5.0 

func NewDetectorRead() *DetectorRead

NewDetectorRead returns a DetectorRead.

type DictionaryDecompounderTokenFilter ¶ 

type DictionaryDecompounderTokenFilter struct {
	HyphenationPatternsPath *string  `json:"hyphenation_patterns_path,omitempty"`
	MaxSubwordSize          *int     `json:"max_subword_size,omitempty"`
	MinSubwordSize          *int     `json:"min_subword_size,omitempty"`
	MinWordSize             *int     `json:"min_word_size,omitempty"`
	OnlyLongestMatch        *bool    `json:"only_longest_match,omitempty"`
	Type                    string   `json:"type,omitempty"`
	Version                 *string  `json:"version,omitempty"`
	WordList                []string `json:"word_list,omitempty"`
	WordListPath            *string  `json:"word_list_path,omitempty"`
}

DictionaryDecompounderTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L53-L55

func NewDictionaryDecompounderTokenFilter ¶ added in v8.5.0 

func NewDictionaryDecompounderTokenFilter() *DictionaryDecompounderTokenFilter

NewDictionaryDecompounderTokenFilter returns a DictionaryDecompounderTokenFilter.

type DirectGenerator ¶ 

type DirectGenerator struct {
	Field          string                   `json:"field"`
	MaxEdits       *int                     `json:"max_edits,omitempty"`
	MaxInspections *float32                 `json:"max_inspections,omitempty"`
	MaxTermFreq    *float32                 `json:"max_term_freq,omitempty"`
	MinDocFreq     *float32                 `json:"min_doc_freq,omitempty"`
	MinWordLength  *int                     `json:"min_word_length,omitempty"`
	PostFilter     *string                  `json:"post_filter,omitempty"`
	PreFilter      *string                  `json:"pre_filter,omitempty"`
	PrefixLength   *int                     `json:"prefix_length,omitempty"`
	Size           *int                     `json:"size,omitempty"`
	SuggestMode    *suggestmode.SuggestMode `json:"suggest_mode,omitempty"`
}

DirectGenerator type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L166-L178

func NewDirectGenerator ¶ added in v8.5.0 

func NewDirectGenerator() *DirectGenerator

NewDirectGenerator returns a DirectGenerator.

type DisMaxQuery ¶ 

type DisMaxQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	Queries    []Query  `json:"queries"`
	QueryName_ *string  `json:"_name,omitempty"`
	TieBreaker *float64 `json:"tie_breaker,omitempty"`
}

DisMaxQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L46-L50

func NewDisMaxQuery ¶ added in v8.5.0 

func NewDisMaxQuery() *DisMaxQuery

NewDisMaxQuery returns a DisMaxQuery.

type Discovery ¶ 

type Discovery struct {
	ClusterApplierStats     *ClusterAppliedStats          `json:"cluster_applier_stats,omitempty"`
	ClusterStateQueue       *ClusterStateQueue            `json:"cluster_state_queue,omitempty"`
	ClusterStateUpdate      map[string]ClusterStateUpdate `json:"cluster_state_update,omitempty"`
	PublishedClusterStates  *PublishedClusterStates       `json:"published_cluster_states,omitempty"`
	SerializedClusterStates *SerializedClusterState       `json:"serialized_cluster_states,omitempty"`
}

Discovery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L76-L82

func NewDiscovery ¶ added in v8.5.0 

func NewDiscovery() *Discovery

NewDiscovery returns a Discovery.

type DiscoveryNode ¶ 

type DiscoveryNode 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"`
}

DiscoveryNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DiscoveryNode.ts#L24-L30

func NewDiscoveryNode ¶ added in v8.5.0 

func NewDiscoveryNode() *DiscoveryNode

NewDiscoveryNode returns a DiscoveryNode.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L62-L69

func NewDiskUsage ¶ added in v8.5.0 

func NewDiskUsage() *DiskUsage

NewDiskUsage returns a DiskUsage.

type DissectProcessor ¶ 

type DissectProcessor struct {
	AppendSeparator *string              `json:"append_separator,omitempty"`
	Description     *string              `json:"description,omitempty"`
	Field           string               `json:"field"`
	If              *string              `json:"if,omitempty"`
	IgnoreFailure   *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing   *bool                `json:"ignore_missing,omitempty"`
	OnFailure       []ProcessorContainer `json:"on_failure,omitempty"`
	Pattern         string               `json:"pattern"`
	Tag             *string              `json:"tag,omitempty"`
}

DissectProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L187-L192

func NewDissectProcessor ¶ added in v8.5.0 

func NewDissectProcessor() *DissectProcessor

NewDissectProcessor returns a DissectProcessor.

type DistanceFeatureQuery ¶ 

type DistanceFeatureQuery interface {
	// contains filtered or unexported methods
}

DistanceFeatureQuery holds the union for the following types: 

GeoDistanceFeatureQuery
DateDistanceFeatureQuery

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L56-L60

type DistanceFeatureQueryBaseDateMathDuration ¶ 

type DistanceFeatureQueryBaseDateMathDuration struct {
	Boost      *float32 `json:"boost,omitempty"`
	Field      string   `json:"field"`
	Origin     string   `json:"origin"`
	Pivot      Duration `json:"pivot"`
	QueryName_ *string  `json:"_name,omitempty"`
}

DistanceFeatureQueryBaseDateMathDuration type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L40-L44

func NewDistanceFeatureQueryBaseDateMathDuration ¶ added in v8.5.0 

func NewDistanceFeatureQueryBaseDateMathDuration() *DistanceFeatureQueryBaseDateMathDuration

NewDistanceFeatureQueryBaseDateMathDuration returns a DistanceFeatureQueryBaseDateMathDuration.

type DistanceFeatureQueryBaseGeoLocationDistance ¶ 

type DistanceFeatureQueryBaseGeoLocationDistance struct {
	Boost      *float32    `json:"boost,omitempty"`
	Field      string      `json:"field"`
	Origin     GeoLocation `json:"origin"`
	Pivot      string      `json:"pivot"`
	QueryName_ *string     `json:"_name,omitempty"`
}

DistanceFeatureQueryBaseGeoLocationDistance type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L40-L44

func NewDistanceFeatureQueryBaseGeoLocationDistance ¶ added in v8.5.0 

func NewDistanceFeatureQueryBaseGeoLocationDistance() *DistanceFeatureQueryBaseGeoLocationDistance

NewDistanceFeatureQueryBaseGeoLocationDistance returns a DistanceFeatureQueryBaseGeoLocationDistance.

type DiversifiedSamplerAggregation ¶ 

type DiversifiedSamplerAggregation struct {
	ExecutionHint   *sampleraggregationexecutionhint.SamplerAggregationExecutionHint `json:"execution_hint,omitempty"`
	Field           *string                                                          `json:"field,omitempty"`
	MaxDocsPerValue *int                                                             `json:"max_docs_per_value,omitempty"`
	Meta            map[string]interface{}                                           `json:"meta,omitempty"`
	Name            *string                                                          `json:"name,omitempty"`
	Script          *Script                                                          `json:"script,omitempty"`
	ShardSize       *int                                                             `json:"shard_size,omitempty"`
}

DiversifiedSamplerAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L155-L161

func NewDiversifiedSamplerAggregation ¶ added in v8.5.0 

func NewDiversifiedSamplerAggregation() *DiversifiedSamplerAggregation

NewDiversifiedSamplerAggregation returns a DiversifiedSamplerAggregation.

type DocStats ¶ 

type DocStats struct {
	Count   int64  `json:"count"`
	Deleted *int64 `json:"deleted,omitempty"`
}

DocStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L64-L67

func NewDocStats ¶ added in v8.5.0 

func NewDocStats() *DocStats

NewDocStats returns a DocStats.

type Document ¶ 

type Document struct {
	Id_     *string     `json:"_id,omitempty"`
	Index_  *string     `json:"_index,omitempty"`
	Source_ interface{} `json:"_source,omitempty"`
}

Document type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/simulate/types.ts#L41-L45

func NewDocument ¶ added in v8.5.0 

func NewDocument() *Document

NewDocument returns a Document.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L116-L123

func NewDocumentRating ¶ added in v8.5.0 

func NewDocumentRating() *DocumentRating

NewDocumentRating returns a DocumentRating.

type DocumentSimulation ¶ 

type DocumentSimulation struct {
	DocumentSimulation map[string]string         `json:"-"`
	Id_                string                    `json:"_id"`
	Index_             string                    `json:"_index"`
	Ingest_            SimulateIngest            `json:"_ingest"`
	Routing_           *string                   `json:"_routing,omitempty"`
	Source_            map[string]interface{}    `json:"_source"`
	VersionType_       *versiontype.VersionType  `json:"_version_type,omitempty"`
	Version_           *StringifiedVersionNumber `json:"_version,omitempty"`
}

DocumentSimulation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/simulate/types.ts#L47-L60

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

type DotExpanderProcessor ¶ 

type DotExpanderProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Path          *string              `json:"path,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

DotExpanderProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L194-L197

func NewDotExpanderProcessor ¶ added in v8.5.0 

func NewDotExpanderProcessor() *DotExpanderProcessor

NewDotExpanderProcessor returns a DotExpanderProcessor.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L141-L144

func NewDoubleNumberProperty ¶ added in v8.5.0 

func NewDoubleNumberProperty() *DoubleNumberProperty

NewDoubleNumberProperty returns a DoubleNumberProperty.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

DoubleRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L34-L36

func NewDoubleRangeProperty ¶ added in v8.5.0 

func NewDoubleRangeProperty() *DoubleRangeProperty

NewDoubleRangeProperty returns a DoubleRangeProperty.

type DoubleTermsAggregate ¶ 

type DoubleTermsAggregate struct {
	Buckets                 BucketsDoubleTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}   `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

DoubleTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L410-L415

func NewDoubleTermsAggregate ¶ added in v8.5.0 

func NewDoubleTermsAggregate() *DoubleTermsAggregate

NewDoubleTermsAggregate returns a DoubleTermsAggregate.

type DoubleTermsBucket ¶ 

type DoubleTermsBucket struct {
	Aggregations  map[string]Aggregate `json:"-"`
	DocCount      int64                `json:"doc_count"`
	DocCountError *int64               `json:"doc_count_error,omitempty"`
	Key           float64              `json:"key"`
	KeyAsString   *string              `json:"key_as_string,omitempty"`
}

DoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L417-L420

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

type DownsampleConfig ¶ added in v8.5.0 

type DownsampleConfig struct {
	FixedInterval string `json:"fixed_interval"`
}

DownsampleConfig type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/Downsample.ts#L22-L24

func NewDownsampleConfig ¶ added in v8.5.0 

func NewDownsampleConfig() *DownsampleConfig

NewDownsampleConfig returns a DownsampleConfig.

type DropProcessor ¶ 

type DropProcessor struct {
	Description   *string              `json:"description,omitempty"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

DropProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L199-L199

func NewDropProcessor ¶ added in v8.5.0 

func NewDropProcessor() *DropProcessor

NewDropProcessor returns a DropProcessor.

type Duration ¶ 

type Duration interface{}

Duration holds the union for the following types: 

string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L52-L58

type DurationValueUnitFloatMillis ¶ 

type DurationValueUnitFloatMillis float64

DurationValueUnitFloatMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L67-L67

type DurationValueUnitMillis ¶ 

type DurationValueUnitMillis int64

DurationValueUnitMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L67-L67

type DurationValueUnitNanos ¶ 

type DurationValueUnitNanos int64

DurationValueUnitNanos type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L67-L67

type DurationValueUnitSeconds ¶ 

type DurationValueUnitSeconds int64

DurationValueUnitSeconds type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L67-L67

type DutchAnalyzer ¶ 

type DutchAnalyzer struct {
	Stopwords []string `json:"stopwords,omitempty"`
	Type      string   `json:"type,omitempty"`
}

DutchAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L61-L64

func NewDutchAnalyzer ¶ added in v8.5.0 

func NewDutchAnalyzer() *DutchAnalyzer

NewDutchAnalyzer returns a DutchAnalyzer.

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"`
	Similarity           *string                                    `json:"similarity,omitempty"`
	Store                *bool                                      `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L275-L306

func NewDynamicProperty ¶ added in v8.5.0 

func NewDynamicProperty() *DynamicProperty

NewDynamicProperty returns a DynamicProperty.

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"`
	Unmatch          *string              `json:"unmatch,omitempty"`
}

DynamicTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/dynamic-template.ts#L22-L30

func NewDynamicTemplate ¶ added in v8.5.0 

func NewDynamicTemplate() *DynamicTemplate

NewDynamicTemplate returns a DynamicTemplate.

type EdgeNGramTokenFilter ¶ 

type EdgeNGramTokenFilter struct {
	MaxGram          *int                         `json:"max_gram,omitempty"`
	MinGram          *int                         `json:"min_gram,omitempty"`
	PreserveOriginal *bool                        `json:"preserve_original,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L78-L84

func NewEdgeNGramTokenFilter ¶ added in v8.5.0 

func NewEdgeNGramTokenFilter() *EdgeNGramTokenFilter

NewEdgeNGramTokenFilter returns a EdgeNGramTokenFilter.

type EdgeNGramTokenizer ¶ 

type EdgeNGramTokenizer struct {
	CustomTokenChars *string               `json:"custom_token_chars,omitempty"`
	MaxGram          int                   `json:"max_gram"`
	MinGram          int                   `json:"min_gram"`
	TokenChars       []tokenchar.TokenChar `json:"token_chars"`
	Type             string                `json:"type,omitempty"`
	Version          *string               `json:"version,omitempty"`
}

EdgeNGramTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L30-L36

func NewEdgeNGramTokenizer ¶ added in v8.5.0 

func NewEdgeNGramTokenizer() *EdgeNGramTokenizer

NewEdgeNGramTokenizer returns a EdgeNGramTokenizer.

type ElasticsearchVersionInfo ¶ 

type ElasticsearchVersionInfo struct {
	BuildDate                        DateTime `json:"build_date"`
	BuildFlavor                      string   `json:"build_flavor"`
	BuildHash                        string   `json:"build_hash"`
	BuildSnapshot                    bool     `json:"build_snapshot"`
	BuildType                        string   `json:"build_type"`
	Int                              string   `json:"number"`
	LuceneVersion                    string   `json:"lucene_version"`
	MinimumIndexCompatibilityVersion string   `json:"minimum_index_compatibility_version"`
	MinimumWireCompatibilityVersion  string   `json:"minimum_wire_compatibility_version"`
}

ElasticsearchVersionInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Base.ts#L54-L64

func NewElasticsearchVersionInfo ¶ added in v8.5.0 

func NewElasticsearchVersionInfo() *ElasticsearchVersionInfo

NewElasticsearchVersionInfo returns a ElasticsearchVersionInfo.

type ElisionTokenFilter ¶ 

type ElisionTokenFilter struct {
	Articles     []string `json:"articles,omitempty"`
	ArticlesCase *bool    `json:"articles_case,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L186-L191

func NewElisionTokenFilter ¶ added in v8.5.0 

func NewElisionTokenFilter() *ElisionTokenFilter

NewElisionTokenFilter returns a ElisionTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L238-L250

func NewEmail ¶ added in v8.5.0 

func NewEmail() *Email

NewEmail returns a Email.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L252-L252

func NewEmailAction ¶ added in v8.5.0 

func NewEmailAction() *EmailAction

NewEmailAction returns a EmailAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L192-L195

func NewEmailBody ¶ added in v8.5.0 

func NewEmailBody() *EmailBody

NewEmailBody returns a EmailBody.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L205-L209

func NewEmailResult ¶ added in v8.5.0 

func NewEmailResult() *EmailResult

NewEmailResult returns a EmailResult.

type EmptyObject ¶ 

type EmptyObject struct {
}

EmptyObject type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L140-L141

func NewEmptyObject ¶ added in v8.5.0 

func NewEmptyObject() *EmptyObject

NewEmptyObject returns a EmptyObject.

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                *string  `json:"query,omitempty"`
}

EnrichPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/_types/Policy.ts#L33-L40

func NewEnrichPolicy ¶ added in v8.5.0 

func NewEnrichPolicy() *EnrichPolicy

NewEnrichPolicy returns a EnrichPolicy.

type EnrichProcessor ¶ 

type EnrichProcessor struct {
	Description   *string                            `json:"description,omitempty"`
	Field         string                             `json:"field"`
	If            *string                            `json:"if,omitempty"`
	IgnoreFailure *bool                              `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                              `json:"ignore_missing,omitempty"`
	MaxMatches    *int                               `json:"max_matches,omitempty"`
	OnFailure     []ProcessorContainer               `json:"on_failure,omitempty"`
	Override      *bool                              `json:"override,omitempty"`
	PolicyName    string                             `json:"policy_name"`
	ShapeRelation *geoshaperelation.GeoShapeRelation `json:"shape_relation,omitempty"`
	Tag           *string                            `json:"tag,omitempty"`
	TargetField   string                             `json:"target_field"`
}

EnrichProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L201-L209

func NewEnrichProcessor ¶ added in v8.5.0 

func NewEnrichProcessor() *EnrichProcessor

NewEnrichProcessor returns a EnrichProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L93-L99

func NewEnsemble ¶ added in v8.5.0 

func NewEnsemble() *Ensemble

NewEnsemble returns a Ensemble.

type EpochTimeUnitMillis ¶ 

type EpochTimeUnitMillis int64

EpochTimeUnitMillis type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Time.ts#L40-L40

type EpochTimeUnitSeconds ¶ 

type EpochTimeUnitSeconds int64

EpochTimeUnitSeconds type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L333-L336

func NewEql ¶ added in v8.5.0 

func NewEql() *Eql

NewEql returns a Eql.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L95-L103

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L105-L111

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L113-L119

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L121-L124

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L126-L133

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Errors.ts#L25-L48

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

type EwmaModelSettings ¶ 

type EwmaModelSettings struct {
	Alpha *float32 `json:"alpha,omitempty"`
}

EwmaModelSettings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L227-L229

func NewEwmaModelSettings ¶ added in v8.5.0 

func NewEwmaModelSettings() *EwmaModelSettings

NewEwmaModelSettings returns a EwmaModelSettings.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Minimize    *bool                  `json:"minimize,omitempty"`
	Model       string                 `json:"model,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Predict     *int                   `json:"predict,omitempty"`
	Settings    EwmaModelSettings      `json:"settings"`
	Window      *int                   `json:"window,omitempty"`
}

EwmaMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L212-L215

func NewEwmaMovingAverageAggregation ¶ added in v8.5.0 

func NewEwmaMovingAverageAggregation() *EwmaMovingAverageAggregation

NewEwmaMovingAverageAggregation returns a EwmaMovingAverageAggregation.

type ExecuteEnrichPolicyStatus ¶ 

type ExecuteEnrichPolicyStatus struct {
	Phase enrichpolicyphase.EnrichPolicyPhase `json:"phase"`
}

ExecuteEnrichPolicyStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/execute_policy/types.ts#L20-L22

func NewExecuteEnrichPolicyStatus ¶ added in v8.5.0 

func NewExecuteEnrichPolicyStatus() *ExecuteEnrichPolicyStatus

NewExecuteEnrichPolicyStatus returns a ExecuteEnrichPolicyStatus.

type ExecutingPolicy ¶ 

type ExecutingPolicy struct {
	Name string   `json:"name"`
	Task TaskInfo `json:"task"`
}

ExecutingPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/stats/types.ts#L24-L27

func NewExecutingPolicy ¶ added in v8.5.0 

func NewExecutingPolicy() *ExecutingPolicy

NewExecutingPolicy returns a ExecutingPolicy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Execution.ts#L60-L66

func NewExecutionResult ¶ added in v8.5.0 

func NewExecutionResult() *ExecutionResult

NewExecutionResult returns a ExecutionResult.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Execution.ts#L74-L86

func NewExecutionResultAction ¶ added in v8.5.0 

func NewExecutionResultAction() *ExecutionResultAction

NewExecutionResultAction returns a ExecutionResultAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Execution.ts#L68-L72

func NewExecutionResultCondition ¶ added in v8.5.0 

func NewExecutionResultCondition() *ExecutionResultCondition

NewExecutionResultCondition returns a ExecutionResultCondition.

type ExecutionResultInput ¶ 

type ExecutionResultInput struct {
	Payload map[string]interface{}                  `json:"payload"`
	Status  actionstatusoptions.ActionStatusOptions `json:"status"`
	Type    inputtype.InputType                     `json:"type"`
}

ExecutionResultInput type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L117-L121

func NewExecutionState ¶ added in v8.5.0 

func NewExecutionState() *ExecutionState

NewExecutionState returns a ExecutionState.

type ExecutionThreadPool ¶ 

type ExecutionThreadPool struct {
	MaxSize   int64 `json:"max_size"`
	QueueSize int64 `json:"queue_size"`
}

ExecutionThreadPool type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Execution.ts#L94-L97

func NewExecutionThreadPool ¶ added in v8.5.0 

func NewExecutionThreadPool() *ExecutionThreadPool

NewExecutionThreadPool returns a ExecutionThreadPool.

type ExistsQuery ¶ 

type ExistsQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	Field      string   `json:"field"`
	QueryName_ *string  `json:"_name,omitempty"`
}

ExistsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L36-L38

func NewExistsQuery ¶ added in v8.5.0 

func NewExistsQuery() *ExistsQuery

NewExistsQuery returns a ExistsQuery.

type ExpandWildcards ¶ 

type ExpandWildcards []expandwildcard.ExpandWildcard

ExpandWildcards type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L197-L197

type ExplainAnalyzeToken ¶ 

type ExplainAnalyzeToken struct {
	Bytes               string                 `json:"bytes"`
	EndOffset           int64                  `json:"end_offset"`
	ExplainAnalyzeToken map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/analyze/types.ts#L52-L64

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/explain/types.ts#L22-L26

func NewExplanation ¶ added in v8.5.0 

func NewExplanation() *Explanation

NewExplanation returns a Explanation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/explain/types.ts#L28-L32

func NewExplanationDetail ¶ added in v8.5.0 

func NewExplanationDetail() *ExplanationDetail

NewExplanationDetail returns a ExplanationDetail.

type ExploreControls ¶ 

type ExploreControls struct {
	SampleDiversity *SampleDiversity `json:"sample_diversity,omitempty"`
	SampleSize      *int             `json:"sample_size,omitempty"`
	Timeout         *Duration        `json:"timeout,omitempty"`
	UseSignificance bool             `json:"use_significance"`
}

ExploreControls type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/ExploreControls.ts#L24-L29

func NewExploreControls ¶ added in v8.5.0 

func NewExploreControls() *ExploreControls

NewExploreControls returns a ExploreControls.

type ExtendedBoundsFieldDateMath ¶ 

type ExtendedBoundsFieldDateMath struct {
	Max FieldDateMath `json:"max"`
	Min FieldDateMath `json:"min"`
}

ExtendedBoundsFieldDateMath type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L230-L233

func NewExtendedBoundsFieldDateMath ¶ added in v8.5.0 

func NewExtendedBoundsFieldDateMath() *ExtendedBoundsFieldDateMath

NewExtendedBoundsFieldDateMath returns a ExtendedBoundsFieldDateMath.

type ExtendedBoundsdouble ¶ 

type ExtendedBoundsdouble struct {
	Max float64 `json:"max"`
	Min float64 `json:"min"`
}

ExtendedBoundsdouble type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L230-L233

func NewExtendedBoundsdouble ¶ added in v8.5.0 

func NewExtendedBoundsdouble() *ExtendedBoundsdouble

NewExtendedBoundsdouble returns a ExtendedBoundsdouble.

type ExtendedMemoryStats ¶ 

type ExtendedMemoryStats struct {
	AdjustedTotalInBytes *int64  `json:"adjusted_total_in_bytes,omitempty"`
	FreeInBytes          *int64  `json:"free_in_bytes,omitempty"`
	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         *int64  `json:"total_in_bytes,omitempty"`
	TotalVirtual         *string `json:"total_virtual,omitempty"`
	TotalVirtualInBytes  *int64  `json:"total_virtual_in_bytes,omitempty"`
	UsedInBytes          *int64  `json:"used_in_bytes,omitempty"`
	UsedPercent          *int    `json:"used_percent,omitempty"`
}

ExtendedMemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L255-L258

func NewExtendedMemoryStats ¶ added in v8.5.0 

func NewExtendedMemoryStats() *ExtendedMemoryStats

NewExtendedMemoryStats returns a ExtendedMemoryStats.

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                       map[string]interface{}           `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L277-L295

func NewExtendedStatsAggregate ¶ added in v8.5.0 

func NewExtendedStatsAggregate() *ExtendedStatsAggregate

NewExtendedStatsAggregate returns a ExtendedStatsAggregate.

type ExtendedStatsAggregation ¶ 

type ExtendedStatsAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
	Sigma   *float64 `json:"sigma,omitempty"`
}

ExtendedStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L68-L70

func NewExtendedStatsAggregation ¶ added in v8.5.0 

func NewExtendedStatsAggregation() *ExtendedStatsAggregation

NewExtendedStatsAggregation returns a ExtendedStatsAggregation.

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                       map[string]interface{}           `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L297-L298

func NewExtendedStatsBucketAggregate ¶ added in v8.5.0 

func NewExtendedStatsBucketAggregate() *ExtendedStatsBucketAggregate

NewExtendedStatsBucketAggregate returns a ExtendedStatsBucketAggregate.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Sigma       *float64               `json:"sigma,omitempty"`
}

ExtendedStatsBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L167-L169

func NewExtendedStatsBucketAggregation ¶ added in v8.5.0 

func NewExtendedStatsBucketAggregation() *ExtendedStatsBucketAggregation

NewExtendedStatsBucketAggregation returns a ExtendedStatsBucketAggregation.

type FailProcessor ¶ 

type FailProcessor struct {
	Description   *string              `json:"description,omitempty"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	Message       string               `json:"message"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

FailProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L211-L213

func NewFailProcessor ¶ added in v8.5.0 

func NewFailProcessor() *FailProcessor

NewFailProcessor returns a FailProcessor.

type Feature ¶ 

type Feature struct {
	Description string `json:"description"`
	Name        string `json:"name"`
}

Feature type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/features/_types/Feature.ts#L20-L23

func NewFeature ¶ added in v8.5.0 

func NewFeature() *Feature

NewFeature returns a Feature.

type FeatureToggle ¶ 

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

FeatureToggle type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L40-L42

func NewFeatureToggle ¶ added in v8.5.0 

func NewFeatureToggle() *FeatureToggle

NewFeatureToggle returns a FeatureToggle.

type Features ¶ 

type Features []feature.Feature

Features type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/get/IndicesGetRequest.ts#L94-L94

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L139-L146

func NewFetchProfile ¶ added in v8.5.0 

func NewFetchProfile() *FetchProfile

NewFetchProfile returns a FetchProfile.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L148-L157

func NewFetchProfileBreakdown ¶ added in v8.5.0 

func NewFetchProfileBreakdown() *FetchProfileBreakdown

NewFetchProfileBreakdown returns a FetchProfileBreakdown.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L159-L162

func NewFetchProfileDebug ¶ added in v8.5.0 

func NewFetchProfileDebug() *FetchProfileDebug

NewFetchProfileDebug returns a FetchProfileDebug.

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"`
	Type       string              `json:"type,omitempty"`
}

FieldAliasProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L49-L52

func NewFieldAliasProperty ¶ added in v8.5.0 

func NewFieldAliasProperty() *FieldAliasProperty

NewFieldAliasProperty returns a FieldAliasProperty.

type FieldAndFormat ¶ 

type FieldAndFormat struct {
	// Field Wildcard pattern. The request returns values for field names matching this
	// pattern.
	Field string `json:"field"`
	// Format 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/abstractions.ts#L212-L226

func NewFieldAndFormat ¶ added in v8.5.0 

func NewFieldAndFormat() *FieldAndFormat

NewFieldAndFormat returns a FieldAndFormat.

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 map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/field_caps/types.ts#L23-L81

func NewFieldCapability ¶ added in v8.5.0 

func NewFieldCapability() *FieldCapability

NewFieldCapability returns a FieldCapability.

type FieldCollapse ¶ 

type FieldCollapse struct {
	Collapse                   *FieldCollapse `json:"collapse,omitempty"`
	Field                      string         `json:"field"`
	InnerHits                  []InnerHits    `json:"inner_hits,omitempty"`
	MaxConcurrentGroupSearches *int           `json:"max_concurrent_group_searches,omitempty"`
}

FieldCollapse type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/FieldCollapse.ts#L24-L29

func NewFieldCollapse ¶ added in v8.5.0 

func NewFieldCollapse() *FieldCollapse

NewFieldCollapse returns a FieldCollapse.

type FieldDateMath ¶ 

type FieldDateMath interface{}

FieldDateMath holds the union for the following types: 

string
float64

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L140-L147

type FieldLookup ¶ 

type FieldLookup struct {
	Id      string  `json:"id"`
	Index   *string `json:"index,omitempty"`
	Path    *string `json:"path,omitempty"`
	Routing *string `json:"routing,omitempty"`
}

FieldLookup type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/abstractions.ts#L164-L169

func NewFieldLookup ¶ added in v8.5.0 

func NewFieldLookup() *FieldLookup

NewFieldLookup returns a FieldLookup.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L24-L27

func NewFieldMapping ¶ added in v8.5.0 

func NewFieldMapping() *FieldMapping

NewFieldMapping returns a FieldMapping.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L76-L79

func NewFieldMemoryUsage ¶ added in v8.5.0 

func NewFieldMemoryUsage() *FieldMemoryUsage

NewFieldMemoryUsage returns a FieldMemoryUsage.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/_types/Metric.ts#L30-L35

func NewFieldMetric ¶ added in v8.5.0 

func NewFieldMetric() *FieldMetric

NewFieldMetric returns a FieldMetric.

type FieldNamesField ¶ 

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

FieldNamesField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L42-L44

func NewFieldNamesField ¶ added in v8.5.0 

func NewFieldNamesField() *FieldNamesField

NewFieldNamesField returns a FieldNamesField.

type FieldRule ¶ 

type FieldRule struct {
	Dn       []string       `json:"dn,omitempty"`
	Groups   []string       `json:"groups,omitempty"`
	Metadata interface{}    `json:"metadata,omitempty"`
	Realm    *SecurityRealm `json:"realm,omitempty"`
	Username *string        `json:"username,omitempty"`
}

FieldRule type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleMappingRule.ts#L33-L42

func NewFieldRule ¶ added in v8.5.0 

func NewFieldRule() *FieldRule

NewFieldRule returns a FieldRule.

type FieldSecurity ¶ 

type FieldSecurity struct {
	Except []string `json:"except,omitempty"`
	Grant  []string `json:"grant,omitempty"`
}

FieldSecurity type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/FieldSecurity.ts#L22-L25

func NewFieldSecurity ¶ added in v8.5.0 

func NewFieldSecurity() *FieldSecurity

NewFieldSecurity returns a FieldSecurity.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L59-L62

func NewFieldSizeUsage ¶ added in v8.5.0 

func NewFieldSizeUsage() *FieldSizeUsage

NewFieldSizeUsage returns a FieldSizeUsage.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L44-L53

func NewFieldSort ¶ added in v8.5.0 

func NewFieldSort() *FieldSort

NewFieldSort returns a FieldSort.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/termvectors/types.ts#L28-L32

func NewFieldStatistics ¶ added in v8.5.0 

func NewFieldStatistics() *FieldStatistics

NewFieldStatistics returns a FieldStatistics.

type FieldSuggester ¶ 

type FieldSuggester struct {
	Completion *CompletionSuggester `json:"completion,omitempty"`
	Phrase     *PhraseSuggester     `json:"phrase,omitempty"`
	Prefix     *string              `json:"prefix,omitempty"`
	Regex      *string              `json:"regex,omitempty"`
	Term       *TermSuggester       `json:"term,omitempty"`
	Text       *string              `json:"text,omitempty"`
}

FieldSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L106-L120

func NewFieldSuggester ¶ added in v8.5.0 

func NewFieldSuggester() *FieldSuggester

NewFieldSuggester returns a FieldSuggester.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L54-L63

func NewFieldSummary ¶ added in v8.5.0 

func NewFieldSummary() *FieldSummary

NewFieldSummary returns a FieldSummary.

type FieldTypes ¶ 

type FieldTypes struct {
	Count       int    `json:"count"`
	IndexCount  int    `json:"index_count"`
	Name        string `json:"name"`
	ScriptCount *int   `json:"script_count,omitempty"`
}

FieldTypes type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L101-L107

func NewFieldTypes ¶ added in v8.5.0 

func NewFieldTypes() *FieldTypes

NewFieldTypes returns a FieldTypes.

type FieldTypesMappings ¶ 

type FieldTypesMappings struct {
	FieldTypes        []FieldTypes               `json:"field_types"`
	RuntimeFieldTypes []ClusterRuntimeFieldTypes `json:"runtime_field_types,omitempty"`
}

FieldTypesMappings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L96-L99

func NewFieldTypesMappings ¶ added in v8.5.0 

func NewFieldTypesMappings() *FieldTypesMappings

NewFieldTypesMappings returns a FieldTypesMappings.

type FieldValue ¶ 

type FieldValue interface{}

FieldValue holds the union for the following types: 

int64
float64
string
bool
nil
interface{}

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L25-L37

type FieldValueFactorScoreFunction ¶ 

type FieldValueFactorScoreFunction struct {
	Factor   *float64                                           `json:"factor,omitempty"`
	Field    string                                             `json:"field"`
	Missing  *float64                                           `json:"missing,omitempty"`
	Modifier *fieldvaluefactormodifier.FieldValueFactorModifier `json:"modifier,omitempty"`
}

FieldValueFactorScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L70-L75

func NewFieldValueFactorScoreFunction ¶ added in v8.5.0 

func NewFieldValueFactorScoreFunction() *FieldValueFactorScoreFunction

NewFieldValueFactorScoreFunction returns a FieldValueFactorScoreFunction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/FielddataFrequencyFilter.ts#L22-L26

func NewFielddataFrequencyFilter ¶ added in v8.5.0 

func NewFielddataFrequencyFilter() *FielddataFrequencyFilter

NewFielddataFrequencyFilter returns a FielddataFrequencyFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/fielddata/types.ts#L20-L48

func NewFielddataRecord ¶ added in v8.5.0 

func NewFielddataRecord() *FielddataRecord

NewFielddataRecord returns a FielddataRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L69-L74

func NewFielddataStats ¶ added in v8.5.0 

func NewFielddataStats() *FielddataStats

NewFielddataStats returns a FielddataStats.

type Fields ¶ 

type Fields []string

Fields type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L120-L120

type FieldsUsageBody ¶ 

type FieldsUsageBody struct {
	FieldsUsageBody map[string]UsageStatsIndex `json:"-"`
	Shards_         ShardStatistics            `json:"_shards"`
}

FieldsUsageBody type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L32-L36

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/FileCountSnapshotStats.ts#L22-L25

func NewFileCountSnapshotStats ¶ added in v8.5.0 

func NewFileCountSnapshotStats() *FileCountSnapshotStats

NewFileCountSnapshotStats returns a FileCountSnapshotStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L50-L54

func NewFileDetails ¶ added in v8.5.0 

func NewFileDetails() *FileDetails

NewFileDetails returns a FileDetails.

type FileSystem ¶ 

type FileSystem struct {
	Data      []DataPathStats  `json:"data,omitempty"`
	IoStats   *IoStats         `json:"io_stats,omitempty"`
	Timestamp *int64           `json:"timestamp,omitempty"`
	Total     *FileSystemTotal `json:"total,omitempty"`
}

FileSystem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L280-L285

func NewFileSystem ¶ added in v8.5.0 

func NewFileSystem() *FileSystem

NewFileSystem returns a FileSystem.

type FileSystemTotal ¶ 

type FileSystemTotal struct {
	Available        *string `json:"available,omitempty"`
	AvailableInBytes *int64  `json:"available_in_bytes,omitempty"`
	Free             *string `json:"free,omitempty"`
	FreeInBytes      *int64  `json:"free_in_bytes,omitempty"`
	Total            *string `json:"total,omitempty"`
	TotalInBytes     *int64  `json:"total_in_bytes,omitempty"`
}

FileSystemTotal type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L301-L308

func NewFileSystemTotal ¶ added in v8.5.0 

func NewFileSystemTotal() *FileSystemTotal

NewFileSystemTotal returns a FileSystemTotal.

type FillMaskInferenceOptions ¶ 

type FillMaskInferenceOptions 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 *TokenizationConfigContainer `json:"tokenization,omitempty"`
}

FillMaskInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L235-L243

func NewFillMaskInferenceOptions ¶ added in v8.5.0 

func NewFillMaskInferenceOptions() *FillMaskInferenceOptions

NewFillMaskInferenceOptions returns a FillMaskInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L364-L371

func NewFillMaskInferenceUpdateOptions ¶ added in v8.5.0 

func NewFillMaskInferenceUpdateOptions() *FillMaskInferenceUpdateOptions

NewFillMaskInferenceUpdateOptions returns a FillMaskInferenceUpdateOptions.

type FilterAggregate ¶ 

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

FilterAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L494-L495

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Filter.ts#L31-L41

func NewFilterRef ¶ added in v8.5.0 

func NewFilterRef() *FilterRef

NewFilterRef returns a FilterRef.

type FiltersAggregate ¶ 

type FiltersAggregate struct {
	Buckets BucketsFiltersBucket   `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

FiltersAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L567-L568

func NewFiltersAggregate ¶ added in v8.5.0 

func NewFiltersAggregate() *FiltersAggregate

NewFiltersAggregate returns a FiltersAggregate.

type FiltersAggregation ¶ 

type FiltersAggregation struct {
	Filters        *BucketsQuery          `json:"filters,omitempty"`
	Keyed          *bool                  `json:"keyed,omitempty"`
	Meta           map[string]interface{} `json:"meta,omitempty"`
	Name           *string                `json:"name,omitempty"`
	OtherBucket    *bool                  `json:"other_bucket,omitempty"`
	OtherBucketKey *string                `json:"other_bucket_key,omitempty"`
}

FiltersAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L169-L174

func NewFiltersAggregation ¶ added in v8.5.0 

func NewFiltersAggregation() *FiltersAggregation

NewFiltersAggregation returns a FiltersAggregation.

type FiltersBucket ¶ 

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

FiltersBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L570-L570

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

type FingerprintAnalyzer ¶ 

type FingerprintAnalyzer struct {
	MaxOutputSize    int      `json:"max_output_size"`
	PreserveOriginal bool     `json:"preserve_original"`
	Separator        string   `json:"separator"`
	Stopwords        []string `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L37-L45

func NewFingerprintAnalyzer ¶ added in v8.5.0 

func NewFingerprintAnalyzer() *FingerprintAnalyzer

NewFingerprintAnalyzer returns a FingerprintAnalyzer.

type FingerprintTokenFilter ¶ 

type FingerprintTokenFilter struct {
	MaxOutputSize *int    `json:"max_output_size,omitempty"`
	Separator     *string `json:"separator,omitempty"`
	Type          string  `json:"type,omitempty"`
	Version       *string `json:"version,omitempty"`
}

FingerprintTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L193-L197

func NewFingerprintTokenFilter ¶ added in v8.5.0 

func NewFingerprintTokenFilter() *FingerprintTokenFilter

NewFingerprintTokenFilter returns a FingerprintTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L338-L340

func NewFlattened ¶ added in v8.5.0 

func NewFlattened() *Flattened

NewFlattened returns a Flattened.

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"`
	Type                     string              `json:"type,omitempty"`
}

FlattenedProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/complex.ts#L26-L37

func NewFlattenedProperty ¶ added in v8.5.0 

func NewFlattenedProperty() *FlattenedProperty

NewFlattenedProperty returns a FlattenedProperty.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L131-L134

func NewFloatNumberProperty ¶ added in v8.5.0 

func NewFloatNumberProperty() *FloatNumberProperty

NewFloatNumberProperty returns a FloatNumberProperty.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

FloatRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L38-L40

func NewFloatRangeProperty ¶ added in v8.5.0 

func NewFloatRangeProperty() *FloatRangeProperty

NewFloatRangeProperty returns a FloatRangeProperty.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L81-L86

func NewFlushStats ¶ added in v8.5.0 

func NewFlushStats() *FlushStats

NewFlushStats returns a FlushStats.

type FollowIndexStats ¶ 

type FollowIndexStats struct {
	Index  string          `json:"index"`
	Shards []CcrShardStats `json:"shards"`
}

FollowIndexStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/_types/FollowIndexStats.ts#L30-L33

func NewFollowIndexStats ¶ added in v8.5.0 

func NewFollowIndexStats() *FollowIndexStats

NewFollowIndexStats returns a FollowIndexStats.

type FollowStats ¶ 

type FollowStats struct {
	Indices []FollowIndexStats `json:"indices"`
}

FollowStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/stats/types.ts.ts#L41-L43

func NewFollowStats ¶ added in v8.5.0 

func NewFollowStats() *FollowStats

NewFollowStats returns a FollowStats.

type FollowerIndex ¶ 

type FollowerIndex struct {
	FollowerIndex string                                  `json:"follower_index"`
	LeaderIndex   string                                  `json:"leader_index"`
	Parameters    *FollowerIndexParameters                `json:"parameters,omitempty"`
	RemoteCluster string                                  `json:"remote_cluster"`
	Status        followerindexstatus.FollowerIndexStatus `json:"status"`
}

FollowerIndex type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/follow_info/types.ts#L22-L28

func NewFollowerIndex ¶ added in v8.5.0 

func NewFollowerIndex() *FollowerIndex

NewFollowerIndex returns a FollowerIndex.

type FollowerIndexParameters ¶ 

type FollowerIndexParameters struct {
	MaxOutstandingReadRequests    int      `json:"max_outstanding_read_requests"`
	MaxOutstandingWriteRequests   int      `json:"max_outstanding_write_requests"`
	MaxReadRequestOperationCount  int      `json:"max_read_request_operation_count"`
	MaxReadRequestSize            string   `json:"max_read_request_size"`
	MaxRetryDelay                 Duration `json:"max_retry_delay"`
	MaxWriteBufferCount           int      `json:"max_write_buffer_count"`
	MaxWriteBufferSize            string   `json:"max_write_buffer_size"`
	MaxWriteRequestOperationCount int      `json:"max_write_request_operation_count"`
	MaxWriteRequestSize           string   `json:"max_write_request_size"`
	ReadPollTimeout               Duration `json:"read_poll_timeout"`
}

FollowerIndexParameters type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/follow_info/types.ts#L38-L49

func NewFollowerIndexParameters ¶ added in v8.5.0 

func NewFollowerIndexParameters() *FollowerIndexParameters

NewFollowerIndexParameters returns a FollowerIndexParameters.

type ForceMergeConfiguration ¶ 

type ForceMergeConfiguration struct {
	MaxNumSegments int `json:"max_num_segments"`
}

ForceMergeConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L53-L55

func NewForceMergeConfiguration ¶ added in v8.5.0 

func NewForceMergeConfiguration() *ForceMergeConfiguration

NewForceMergeConfiguration returns a ForceMergeConfiguration.

type ForceMergeResponseBody ¶ added in v8.5.0 

type ForceMergeResponseBody struct {
	Shards_ ShardStatistics `json:"_shards"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/forcemerge/_types/response.ts#L22-L28

func NewForceMergeResponseBody ¶ added in v8.5.0 

func NewForceMergeResponseBody() *ForceMergeResponseBody

NewForceMergeResponseBody returns a ForceMergeResponseBody.

type ForeachProcessor ¶ 

type ForeachProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Processor     *ProcessorContainer  `json:"processor,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

ForeachProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L215-L219

func NewForeachProcessor ¶ added in v8.5.0 

func NewForeachProcessor() *ForeachProcessor

NewForeachProcessor returns a ForeachProcessor.

type FormattableMetricAggregation ¶ 

type FormattableMetricAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

FormattableMetricAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L44-L46

func NewFormattableMetricAggregation ¶ added in v8.5.0 

func NewFormattableMetricAggregation() *FormattableMetricAggregation

NewFormattableMetricAggregation returns a FormattableMetricAggregation.

type FoundStatus ¶ 

type FoundStatus struct {
	Found bool `json:"found"`
}

FoundStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/delete_privileges/types.ts#L20-L22

func NewFoundStatus ¶ added in v8.5.0 

func NewFoundStatus() *FoundStatus

NewFoundStatus returns a FoundStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L38-L42

func NewFrequencyEncodingPreprocessor ¶ added in v8.5.0 

func NewFrequencyEncodingPreprocessor() *FrequencyEncodingPreprocessor

NewFrequencyEncodingPreprocessor returns a FrequencyEncodingPreprocessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L342-L344

func NewFrozenIndices ¶ added in v8.5.0 

func NewFrozenIndices() *FrozenIndices

NewFrozenIndices returns a FrozenIndices.

type FunctionScore ¶ added in v8.5.0 

type FunctionScore struct {
	Exp              *DecayFunction                 `json:"exp,omitempty"`
	FieldValueFactor *FieldValueFactorScoreFunction `json:"field_value_factor,omitempty"`
	Filter           *Query                         `json:"filter,omitempty"`
	Gauss            *DecayFunction                 `json:"gauss,omitempty"`
	Linear           *DecayFunction                 `json:"linear,omitempty"`
	RandomScore      *RandomScoreFunction           `json:"random_score,omitempty"`
	ScriptScore      *ScriptScoreFunction           `json:"script_score,omitempty"`
	Weight           *float64                       `json:"weight,omitempty"`
}

FunctionScore type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L107-L127

func NewFunctionScore ¶ added in v8.5.0 

func NewFunctionScore() *FunctionScore

NewFunctionScore returns a FunctionScore.

type FunctionScoreQuery ¶ 

type FunctionScoreQuery struct {
	Boost      *float32                             `json:"boost,omitempty"`
	BoostMode  *functionboostmode.FunctionBoostMode `json:"boost_mode,omitempty"`
	Functions  []FunctionScore                      `json:"functions,omitempty"`
	MaxBoost   *float64                             `json:"max_boost,omitempty"`
	MinScore   *float64                             `json:"min_score,omitempty"`
	Query      *Query                               `json:"query,omitempty"`
	QueryName_ *string                              `json:"_name,omitempty"`
	ScoreMode  *functionscoremode.FunctionScoreMode `json:"score_mode,omitempty"`
}

FunctionScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L52-L59

func NewFunctionScoreQuery ¶ added in v8.5.0 

func NewFunctionScoreQuery() *FunctionScoreQuery

NewFunctionScoreQuery returns a FunctionScoreQuery.

type Fuzziness ¶ 

type Fuzziness interface{}

Fuzziness holds the union for the following types: 

string
int

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L114-L114

type FuzzyQuery ¶ 

type FuzzyQuery struct {
	Boost          *float32   `json:"boost,omitempty"`
	Fuzziness      *Fuzziness `json:"fuzziness,omitempty"`
	MaxExpansions  *int       `json:"max_expansions,omitempty"`
	PrefixLength   *int       `json:"prefix_length,omitempty"`
	QueryName_     *string    `json:"_name,omitempty"`
	Rewrite        *string    `json:"rewrite,omitempty"`
	Transpositions *bool      `json:"transpositions,omitempty"`
	Value          string     `json:"value"`
}

FuzzyQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L40-L51

func NewFuzzyQuery ¶ added in v8.5.0 

func NewFuzzyQuery() *FuzzyQuery

NewFuzzyQuery returns a FuzzyQuery.

type GarbageCollector ¶ 

type GarbageCollector struct {
	Collectors map[string]GarbageCollectorTotal `json:"collectors,omitempty"`
}

GarbageCollector type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L357-L359

func NewGarbageCollector ¶ added in v8.5.0 

func NewGarbageCollector() *GarbageCollector

NewGarbageCollector returns a GarbageCollector.

type GarbageCollectorTotal ¶ 

type GarbageCollectorTotal struct {
	CollectionCount        *int64  `json:"collection_count,omitempty"`
	CollectionTime         *string `json:"collection_time,omitempty"`
	CollectionTimeInMillis *int64  `json:"collection_time_in_millis,omitempty"`
}

GarbageCollectorTotal type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L361-L365

func NewGarbageCollectorTotal ¶ added in v8.5.0 

func NewGarbageCollectorTotal() *GarbageCollectorTotal

NewGarbageCollectorTotal returns a GarbageCollectorTotal.

type GeoBoundingBoxQuery ¶ 

type GeoBoundingBoxQuery struct {
	Boost               *float32                                 `json:"boost,omitempty"`
	GeoBoundingBoxQuery map[string]GeoBounds                     `json:"-"`
	IgnoreUnmapped      *bool                                    `json:"ignore_unmapped,omitempty"`
	QueryName_          *string                                  `json:"_name,omitempty"`
	Type                *geoexecution.GeoExecution               `json:"type,omitempty"`
	ValidationMethod    *geovalidationmethod.GeoValidationMethod `json:"validation_method,omitempty"`
}

GeoBoundingBoxQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L32-L41

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

type GeoBounds ¶ 

type GeoBounds interface {
	// contains filtered or unexported methods
}

GeoBounds holds the union for the following types: 

CoordsGeoBounds
TopLeftBottomRightGeoBounds
TopRightBottomLeftGeoBounds
WktGeoBounds

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L119-L132

type GeoBoundsAggregate ¶ 

type GeoBoundsAggregate struct {
	Bounds *GeoBounds             `json:"bounds,omitempty"`
	Meta   map[string]interface{} `json:"meta,omitempty"`
}

GeoBoundsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L302-L305

func NewGeoBoundsAggregate ¶ added in v8.5.0 

func NewGeoBoundsAggregate() *GeoBoundsAggregate

NewGeoBoundsAggregate returns a GeoBoundsAggregate.

type GeoBoundsAggregation ¶ 

type GeoBoundsAggregation struct {
	Field         *string  `json:"field,omitempty"`
	Missing       *Missing `json:"missing,omitempty"`
	Script        *Script  `json:"script,omitempty"`
	WrapLongitude *bool    `json:"wrap_longitude,omitempty"`
}

GeoBoundsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L72-L74

func NewGeoBoundsAggregation ¶ added in v8.5.0 

func NewGeoBoundsAggregation() *GeoBoundsAggregation

NewGeoBoundsAggregation returns a GeoBoundsAggregation.

type GeoCentroidAggregate ¶ 

type GeoCentroidAggregate struct {
	Count    int64                  `json:"count"`
	Location *GeoLocation           `json:"location,omitempty"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
}

GeoCentroidAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L307-L311

func NewGeoCentroidAggregate ¶ added in v8.5.0 

func NewGeoCentroidAggregate() *GeoCentroidAggregate

NewGeoCentroidAggregate returns a GeoCentroidAggregate.

type GeoCentroidAggregation ¶ 

type GeoCentroidAggregation struct {
	Count    *int64       `json:"count,omitempty"`
	Field    *string      `json:"field,omitempty"`
	Location *GeoLocation `json:"location,omitempty"`
	Missing  *Missing     `json:"missing,omitempty"`
	Script   *Script      `json:"script,omitempty"`
}

GeoCentroidAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L76-L79

func NewGeoCentroidAggregation ¶ added in v8.5.0 

func NewGeoCentroidAggregation() *GeoCentroidAggregation

NewGeoCentroidAggregation returns a GeoCentroidAggregation.

type GeoDecayFunction ¶ 

type GeoDecayFunction struct {
	GeoDecayFunction map[string]DecayPlacementGeoLocationDistance `json:"-"`
	MultiValueMode   *multivaluemode.MultiValueMode               `json:"multi_value_mode,omitempty"`
}

GeoDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L96-L98

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    map[string]interface{} `json:"meta,omitempty"`
}

GeoDistanceAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L549-L553

func NewGeoDistanceAggregate ¶ added in v8.5.0 

func NewGeoDistanceAggregate() *GeoDistanceAggregate

NewGeoDistanceAggregate returns a GeoDistanceAggregate.

type GeoDistanceAggregation ¶ 

type GeoDistanceAggregation struct {
	DistanceType *geodistancetype.GeoDistanceType `json:"distance_type,omitempty"`
	Field        *string                          `json:"field,omitempty"`
	Meta         map[string]interface{}           `json:"meta,omitempty"`
	Name         *string                          `json:"name,omitempty"`
	Origin       *GeoLocation                     `json:"origin,omitempty"`
	Ranges       []AggregationRange               `json:"ranges,omitempty"`
	Unit         *distanceunit.DistanceUnit       `json:"unit,omitempty"`
}

GeoDistanceAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L176-L182

func NewGeoDistanceAggregation ¶ added in v8.5.0 

func NewGeoDistanceAggregation() *GeoDistanceAggregation

NewGeoDistanceAggregation returns a GeoDistanceAggregation.

type GeoDistanceFeatureQuery ¶ 

type GeoDistanceFeatureQuery struct {
	Boost      *float32    `json:"boost,omitempty"`
	Field      string      `json:"field"`
	Origin     GeoLocation `json:"origin"`
	Pivot      string      `json:"pivot"`
	QueryName_ *string     `json:"_name,omitempty"`
}

GeoDistanceFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L46-L49

func NewGeoDistanceFeatureQuery ¶ added in v8.5.0 

func NewGeoDistanceFeatureQuery() *GeoDistanceFeatureQuery

NewGeoDistanceFeatureQuery returns a GeoDistanceFeatureQuery.

type GeoDistanceQuery ¶ 

type GeoDistanceQuery struct {
	Boost            *float32                                 `json:"boost,omitempty"`
	Distance         *string                                  `json:"distance,omitempty"`
	DistanceType     *geodistancetype.GeoDistanceType         `json:"distance_type,omitempty"`
	GeoDistanceQuery map[string]GeoLocation                   `json:"-"`
	QueryName_       *string                                  `json:"_name,omitempty"`
	ValidationMethod *geovalidationmethod.GeoValidationMethod `json:"validation_method,omitempty"`
}

GeoDistanceQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L48-L57

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

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"`
	Order           *sortorder.SortOrder             `json:"order,omitempty"`
	Unit            *distanceunit.DistanceUnit       `json:"unit,omitempty"`
}

GeoDistanceSort type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L58-L66

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

type GeoHashGridAggregate ¶ 

type GeoHashGridAggregate struct {
	Buckets BucketsGeoHashGridBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

GeoHashGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L505-L507

func NewGeoHashGridAggregate ¶ added in v8.5.0 

func NewGeoHashGridAggregate() *GeoHashGridAggregate

NewGeoHashGridAggregate returns a GeoHashGridAggregate.

type GeoHashGridAggregation ¶ 

type GeoHashGridAggregation struct {
	Bounds    *GeoBounds             `json:"bounds,omitempty"`
	Field     *string                `json:"field,omitempty"`
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,omitempty"`
	Precision *GeoHashPrecision      `json:"precision,omitempty"`
	ShardSize *int                   `json:"shard_size,omitempty"`
	Size      *int                   `json:"size,omitempty"`
}

GeoHashGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L184-L190

func NewGeoHashGridAggregation ¶ added in v8.5.0 

func NewGeoHashGridAggregation() *GeoHashGridAggregation

NewGeoHashGridAggregation returns a GeoHashGridAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L509-L511

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

type GeoHashLocation ¶ 

type GeoHashLocation struct {
	Geohash string `json:"geohash"`
}

GeoHashLocation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L115-L117

func NewGeoHashLocation ¶ added in v8.5.0 

func NewGeoHashLocation() *GeoHashLocation

NewGeoHashLocation returns a GeoHashLocation.

type GeoHashPrecision ¶ 

type GeoHashPrecision interface{}

GeoHashPrecision holds the union for the following types: 

int
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L76-L80

type GeoHexGridAggregate ¶ added in v8.5.0 

type GeoHexGridAggregate struct {
	Buckets BucketsGeoHexGridBucket `json:"buckets"`
	Meta    map[string]interface{}  `json:"meta,omitempty"`
}

GeoHexGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L521-L522

func NewGeoHexGridAggregate ¶ added in v8.5.0 

func NewGeoHexGridAggregate() *GeoHexGridAggregate

NewGeoHexGridAggregate returns a GeoHexGridAggregate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L524-L526

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

type GeoIpDownloadStatistics ¶ 

type GeoIpDownloadStatistics struct {
	// DatabaseCount Current number of databases available for use.
	DatabaseCount int `json:"database_count"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/geo_ip_stats/types.ts#L24-L35

func NewGeoIpDownloadStatistics ¶ added in v8.5.0 

func NewGeoIpDownloadStatistics() *GeoIpDownloadStatistics

NewGeoIpDownloadStatistics returns a GeoIpDownloadStatistics.

type GeoIpNodeDatabaseName ¶ 

type GeoIpNodeDatabaseName struct {
	// Name Name of the database.
	Name string `json:"name"`
}

GeoIpNodeDatabaseName type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/geo_ip_stats/types.ts#L45-L48

func NewGeoIpNodeDatabaseName ¶ added in v8.5.0 

func NewGeoIpNodeDatabaseName() *GeoIpNodeDatabaseName

NewGeoIpNodeDatabaseName returns a GeoIpNodeDatabaseName.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/geo_ip_stats/types.ts#L37-L43

func NewGeoIpNodeDatabases ¶ added in v8.5.0 

func NewGeoIpNodeDatabases() *GeoIpNodeDatabases

NewGeoIpNodeDatabases returns a GeoIpNodeDatabases.

type GeoIpProcessor ¶ 

type GeoIpProcessor struct {
	DatabaseFile  *string              `json:"database_file,omitempty"`
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	FirstOnly     *bool                `json:"first_only,omitempty"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Properties    []string             `json:"properties,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

GeoIpProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L106-L113

func NewGeoIpProcessor ¶ added in v8.5.0 

func NewGeoIpProcessor() *GeoIpProcessor

NewGeoIpProcessor returns a GeoIpProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L59-L65

func NewGeoLine ¶ added in v8.5.0 

func NewGeoLine() *GeoLine

NewGeoLine returns a GeoLine.

type GeoLineAggregate ¶ 

type GeoLineAggregate struct {
	Geometry   GeoLine                `json:"geometry"`
	Meta       map[string]interface{} `json:"meta,omitempty"`
	Properties interface{}            `json:"properties,omitempty"`
	Type       string                 `json:"type"`
}

GeoLineAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L775-L782

func NewGeoLineAggregate ¶ added in v8.5.0 

func NewGeoLineAggregate() *GeoLineAggregate

NewGeoLineAggregate returns a GeoLineAggregate.

type GeoLineAggregation ¶ 

type GeoLineAggregation struct {
	IncludeSort *bool                `json:"include_sort,omitempty"`
	Point       GeoLinePoint         `json:"point"`
	Size        *int                 `json:"size,omitempty"`
	Sort        GeoLineSort          `json:"sort"`
	SortOrder   *sortorder.SortOrder `json:"sort_order,omitempty"`
}

GeoLineAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L81-L87

func NewGeoLineAggregation ¶ added in v8.5.0 

func NewGeoLineAggregation() *GeoLineAggregation

NewGeoLineAggregation returns a GeoLineAggregation.

type GeoLinePoint ¶ 

type GeoLinePoint struct {
	Field string `json:"field"`
}

GeoLinePoint type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L93-L95

func NewGeoLinePoint ¶ added in v8.5.0 

func NewGeoLinePoint() *GeoLinePoint

NewGeoLinePoint returns a GeoLinePoint.

type GeoLineSort ¶ 

type GeoLineSort struct {
	Field string `json:"field"`
}

GeoLineSort type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L89-L91

func NewGeoLineSort ¶ added in v8.5.0 

func NewGeoLineSort() *GeoLineSort

NewGeoLineSort returns a GeoLineSort.

type GeoLocation ¶ 

type GeoLocation interface{}

GeoLocation holds the union for the following types: 

LatLonGeoLocation
GeoHashLocation
[]float64
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L94-L108

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"`
	// Meta Metadata about the field.
	Meta       map[string]string   `json:"meta,omitempty"`
	NullValue  *GeoLocation        `json:"null_value,omitempty"`
	Properties map[string]Property `json:"properties,omitempty"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

GeoPointProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/geo.ts#L23-L28

func NewGeoPointProperty ¶ added in v8.5.0 

func NewGeoPointProperty() *GeoPointProperty

NewGeoPointProperty returns a GeoPointProperty.

type GeoPolygonPoints ¶ 

type GeoPolygonPoints struct {
	Points []GeoLocation `json:"points"`
}

GeoPolygonPoints type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L59-L61

func NewGeoPolygonPoints ¶ added in v8.5.0 

func NewGeoPolygonPoints() *GeoPolygonPoints

NewGeoPolygonPoints returns a GeoPolygonPoints.

type GeoPolygonQuery ¶ 

type GeoPolygonQuery struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L63-L71

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

type GeoShape ¶ 

type GeoShape interface{}

GeoShape type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L56-L57

type GeoShapeFieldQuery ¶ 

type GeoShapeFieldQuery struct {
	IndexedShape *FieldLookup                       `json:"indexed_shape,omitempty"`
	Relation     *geoshaperelation.GeoShapeRelation `json:"relation,omitempty"`
	Shape        interface{}                        `json:"shape,omitempty"`
}

GeoShapeFieldQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L78-L82

func NewGeoShapeFieldQuery ¶ added in v8.5.0 

func NewGeoShapeFieldQuery() *GeoShapeFieldQuery

NewGeoShapeFieldQuery returns a GeoShapeFieldQuery.

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"`
	// 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"`
	Similarity  *string                        `json:"similarity,omitempty"`
	Store       *bool                          `json:"store,omitempty"`
	Strategy    *geostrategy.GeoStrategy       `json:"strategy,omitempty"`
	Type        string                         `json:"type,omitempty"`
}

GeoShapeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/geo.ts#L37-L50

func NewGeoShapeProperty ¶ added in v8.5.0 

func NewGeoShapeProperty() *GeoShapeProperty

NewGeoShapeProperty returns a GeoShapeProperty.

type GeoShapeQuery ¶ 

type GeoShapeQuery struct {
	Boost          *float32                      `json:"boost,omitempty"`
	GeoShapeQuery  map[string]GeoShapeFieldQuery `json:"-"`
	IgnoreUnmapped *bool                         `json:"ignore_unmapped,omitempty"`
	QueryName_     *string                       `json:"_name,omitempty"`
}

GeoShapeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/geo.ts#L86-L91

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

type GeoTileGridAggregate ¶ 

type GeoTileGridAggregate struct {
	Buckets BucketsGeoTileGridBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

GeoTileGridAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L513-L515

func NewGeoTileGridAggregate ¶ added in v8.5.0 

func NewGeoTileGridAggregate() *GeoTileGridAggregate

NewGeoTileGridAggregate returns a GeoTileGridAggregate.

type GeoTileGridAggregation ¶ 

type GeoTileGridAggregation struct {
	Bounds    *GeoBounds             `json:"bounds,omitempty"`
	Field     *string                `json:"field,omitempty"`
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,omitempty"`
	Precision *int                   `json:"precision,omitempty"`
	ShardSize *int                   `json:"shard_size,omitempty"`
	Size      *int                   `json:"size,omitempty"`
}

GeoTileGridAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L192-L198

func NewGeoTileGridAggregation ¶ added in v8.5.0 

func NewGeoTileGridAggregation() *GeoTileGridAggregation

NewGeoTileGridAggregation returns a GeoTileGridAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L517-L519

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

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 values. Must be explicitly
	// mapped as a `geo_point` field. If the field contains an array
	// `geohex_grid` aggregates all array values.
	Field string                 `json:"field"`
	Meta  map[string]interface{} `json:"meta,omitempty"`
	Name  *string                `json:"name,omitempty"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L200-L226

func NewGeohexGridAggregation ¶ added in v8.5.0 

func NewGeohexGridAggregation() *GeohexGridAggregation

NewGeohexGridAggregation returns a GeohexGridAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L37-L42

func NewGetMigrationFeature ¶ added in v8.5.0 

func NewGetMigrationFeature() *GetMigrationFeature

NewGetMigrationFeature returns a GetMigrationFeature.

type GetResult ¶ 

type GetResult struct {
	Fields       map[string]interface{} `json:"fields,omitempty"`
	Found        bool                   `json:"found"`
	Id_          string                 `json:"_id"`
	Index_       string                 `json:"_index"`
	PrimaryTerm_ *int64                 `json:"_primary_term,omitempty"`
	Routing_     *string                `json:"_routing,omitempty"`
	SeqNo_       *int64                 `json:"_seq_no,omitempty"`
	Source_      interface{}            `json:"_source,omitempty"`
	Version_     *int64                 `json:"_version,omitempty"`
}

GetResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/get/types.ts#L25-L35

func NewGetResult ¶ added in v8.5.0 

func NewGetResult() *GetResult

NewGetResult returns a GetResult.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/get_script_context/types.ts#L22-L25

func NewGetScriptContext ¶ added in v8.5.0 

func NewGetScriptContext() *GetScriptContext

NewGetScriptContext returns a GetScriptContext.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L88-L99

func NewGetStats ¶ added in v8.5.0 

func NewGetStats() *GetStats

NewGetStats returns a GetStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_user_profile/types.ts#L25-L28

func NewGetUserProfileErrors ¶ added in v8.5.0 

func NewGetUserProfileErrors() *GetUserProfileErrors

NewGetUserProfileErrors returns a GetUserProfileErrors.

type GlobalAggregate ¶ 

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

GlobalAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L491-L492

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

type GlobalAggregation ¶ 

type GlobalAggregation struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
}

GlobalAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L228-L228

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L187-L189

func NewGlobalPrivilege ¶ added in v8.5.0 

func NewGlobalPrivilege() *GlobalPrivilege

NewGlobalPrivilege returns a GlobalPrivilege.

type GoogleNormalizedDistanceHeuristic ¶ 

type GoogleNormalizedDistanceHeuristic struct {
	BackgroundIsSuperset *bool `json:"background_is_superset,omitempty"`
}

GoogleNormalizedDistanceHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L327-L329

func NewGoogleNormalizedDistanceHeuristic ¶ added in v8.5.0 

func NewGoogleNormalizedDistanceHeuristic() *GoogleNormalizedDistanceHeuristic

NewGoogleNormalizedDistanceHeuristic returns a GoogleNormalizedDistanceHeuristic.

type GrantApiKey ¶ 

type GrantApiKey struct {
	Expiration      *string                     `json:"expiration,omitempty"`
	Metadata        map[string]interface{}      `json:"metadata,omitempty"`
	Name            string                      `json:"name"`
	RoleDescriptors []map[string]RoleDescriptor `json:"role_descriptors,omitempty"`
}

GrantApiKey type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/grant_api_key/types.ts#L25-L32

func NewGrantApiKey ¶ added in v8.5.0 

func NewGrantApiKey() *GrantApiKey

NewGrantApiKey returns a GrantApiKey.

type GrokProcessor ¶ 

type GrokProcessor struct {
	Description        *string              `json:"description,omitempty"`
	Field              string               `json:"field"`
	If                 *string              `json:"if,omitempty"`
	IgnoreFailure      *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing      *bool                `json:"ignore_missing,omitempty"`
	OnFailure          []ProcessorContainer `json:"on_failure,omitempty"`
	PatternDefinitions map[string]string    `json:"pattern_definitions,omitempty"`
	Patterns           []string             `json:"patterns"`
	Tag                *string              `json:"tag,omitempty"`
	TraceMatch         *bool                `json:"trace_match,omitempty"`
}

GrokProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L221-L227

func NewGrokProcessor ¶ added in v8.5.0 

func NewGrokProcessor() *GrokProcessor

NewGrokProcessor returns a GrokProcessor.

type Groupings ¶ 

type Groupings struct {
	DateHistogram *DateHistogramGrouping `json:"date_histogram,omitempty"`
	Histogram     *HistogramGrouping     `json:"histogram,omitempty"`
	Terms         *TermsGrouping         `json:"terms,omitempty"`
}

Groupings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/_types/Groupings.ts#L24-L28

func NewGroupings ¶ added in v8.5.0 

func NewGroupings() *Groupings

NewGroupings returns a Groupings.

type GsubProcessor ¶ 

type GsubProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Pattern       string               `json:"pattern"`
	Replacement   string               `json:"replacement"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

GsubProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L229-L235

func NewGsubProcessor ¶ added in v8.5.0 

func NewGsubProcessor() *GsubProcessor

NewGsubProcessor returns a GsubProcessor.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L136-L139

func NewHalfFloatNumberProperty ¶ added in v8.5.0 

func NewHalfFloatNumberProperty() *HalfFloatNumberProperty

NewHalfFloatNumberProperty returns a HalfFloatNumberProperty.

type HasChildQuery ¶ 

type HasChildQuery struct {
	Boost          *float32                       `json:"boost,omitempty"`
	IgnoreUnmapped *bool                          `json:"ignore_unmapped,omitempty"`
	InnerHits      *InnerHits                     `json:"inner_hits,omitempty"`
	MaxChildren    *int                           `json:"max_children,omitempty"`
	MinChildren    *int                           `json:"min_children,omitempty"`
	Query          *Query                         `json:"query,omitempty"`
	QueryName_     *string                        `json:"_name,omitempty"`
	ScoreMode      *childscoremode.ChildScoreMode `json:"score_mode,omitempty"`
	Type           string                         `json:"type"`
}

HasChildQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/joining.ts#L41-L51

func NewHasChildQuery ¶ added in v8.5.0 

func NewHasChildQuery() *HasChildQuery

NewHasChildQuery returns a HasChildQuery.

type HasParentQuery ¶ 

type HasParentQuery struct {
	Boost          *float32   `json:"boost,omitempty"`
	IgnoreUnmapped *bool      `json:"ignore_unmapped,omitempty"`
	InnerHits      *InnerHits `json:"inner_hits,omitempty"`
	ParentType     string     `json:"parent_type"`
	Query          *Query     `json:"query,omitempty"`
	QueryName_     *string    `json:"_name,omitempty"`
	Score          *bool      `json:"score,omitempty"`
}

HasParentQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/joining.ts#L53-L61

func NewHasParentQuery ¶ added in v8.5.0 

func NewHasParentQuery() *HasParentQuery

NewHasParentQuery returns a HasParentQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/has_privileges_user_profile/types.ts#L39-L42

func NewHasPrivilegesUserProfileErrors ¶ added in v8.5.0 

func NewHasPrivilegesUserProfileErrors() *HasPrivilegesUserProfileErrors

NewHasPrivilegesUserProfileErrors returns a HasPrivilegesUserProfileErrors.

type HdrMethod ¶ 

type HdrMethod struct {
	NumberOfSignificantValueDigits *int `json:"number_of_significant_value_digits,omitempty"`
}

HdrMethod type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L119-L121

func NewHdrMethod ¶ added in v8.5.0 

func NewHdrMethod() *HdrMethod

NewHdrMethod returns a HdrMethod.

type HdrPercentileRanksAggregate ¶ 

type HdrPercentileRanksAggregate struct {
	Meta   map[string]interface{} `json:"meta,omitempty"`
	Values Percentiles            `json:"values"`
}

HdrPercentileRanksAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L168-L169

func NewHdrPercentileRanksAggregate ¶ added in v8.5.0 

func NewHdrPercentileRanksAggregate() *HdrPercentileRanksAggregate

NewHdrPercentileRanksAggregate returns a HdrPercentileRanksAggregate.

type HdrPercentilesAggregate ¶ 

type HdrPercentilesAggregate struct {
	Meta   map[string]interface{} `json:"meta,omitempty"`
	Values Percentiles            `json:"values"`
}

HdrPercentilesAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L165-L166

func NewHdrPercentilesAggregate ¶ added in v8.5.0 

func NewHdrPercentilesAggregate() *HdrPercentilesAggregate

NewHdrPercentilesAggregate returns a HdrPercentilesAggregate.

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"`
}

HealthRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/health/types.ts#L23-L94

func NewHealthRecord ¶ added in v8.5.0 

func NewHealthRecord() *HealthRecord

NewHealthRecord returns a HealthRecord.

type HelpRecord ¶ 

type HelpRecord struct {
	Endpoint string `json:"endpoint"`
}

HelpRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/help/types.ts#L20-L22

func NewHelpRecord ¶ added in v8.5.0 

func NewHelpRecord() *HelpRecord

NewHelpRecord returns a HelpRecord.

type Highlight ¶ 

type Highlight struct {
	BoundaryChars         *string                                      `json:"boundary_chars,omitempty"`
	BoundaryMaxScan       *int                                         `json:"boundary_max_scan,omitempty"`
	BoundaryScanner       *boundaryscanner.BoundaryScanner             `json:"boundary_scanner,omitempty"`
	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          *int                                         `json:"fragment_size,omitempty"`
	Fragmenter            *highlighterfragmenter.HighlighterFragmenter `json:"fragmenter,omitempty"`
	HighlightFilter       *bool                                        `json:"highlight_filter,omitempty"`
	HighlightQuery        *Query                                       `json:"highlight_query,omitempty"`
	MaxAnalyzedOffset     *int                                         `json:"max_analyzed_offset,omitempty"`
	MaxFragmentLength     *int                                         `json:"max_fragment_length,omitempty"`
	NoMatchSize           *int                                         `json:"no_match_size,omitempty"`
	NumberOfFragments     *int                                         `json:"number_of_fragments,omitempty"`
	Options               map[string]interface{}                       `json:"options,omitempty"`
	Order                 *highlighterorder.HighlighterOrder           `json:"order,omitempty"`
	PhraseLimit           *int                                         `json:"phrase_limit,omitempty"`
	PostTags              []string                                     `json:"post_tags,omitempty"`
	PreTags               []string                                     `json:"pre_tags,omitempty"`
	RequireFieldMatch     *bool                                        `json:"require_field_match,omitempty"`
	TagsSchema            *highlightertagsschema.HighlighterTagsSchema `json:"tags_schema,omitempty"`
	Type                  *highlightertype.HighlighterType             `json:"type,omitempty"`
}

Highlight type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/highlighting.ts#L57-L60

func NewHighlight ¶ added in v8.5.0 

func NewHighlight() *Highlight

NewHighlight returns a Highlight.

type HighlightField ¶ 

type HighlightField struct {
	Analyzer              *Analyzer                                    `json:"analyzer,omitempty"`
	BoundaryChars         *string                                      `json:"boundary_chars,omitempty"`
	BoundaryMaxScan       *int                                         `json:"boundary_max_scan,omitempty"`
	BoundaryScanner       *boundaryscanner.BoundaryScanner             `json:"boundary_scanner,omitempty"`
	BoundaryScannerLocale *string                                      `json:"boundary_scanner_locale,omitempty"`
	ForceSource           *bool                                        `json:"force_source,omitempty"`
	FragmentOffset        *int                                         `json:"fragment_offset,omitempty"`
	FragmentSize          *int                                         `json:"fragment_size,omitempty"`
	Fragmenter            *highlighterfragmenter.HighlighterFragmenter `json:"fragmenter,omitempty"`
	HighlightFilter       *bool                                        `json:"highlight_filter,omitempty"`
	HighlightQuery        *Query                                       `json:"highlight_query,omitempty"`
	MatchedFields         []string                                     `json:"matched_fields,omitempty"`
	MaxAnalyzedOffset     *int                                         `json:"max_analyzed_offset,omitempty"`
	MaxFragmentLength     *int                                         `json:"max_fragment_length,omitempty"`
	NoMatchSize           *int                                         `json:"no_match_size,omitempty"`
	NumberOfFragments     *int                                         `json:"number_of_fragments,omitempty"`
	Options               map[string]interface{}                       `json:"options,omitempty"`
	Order                 *highlighterorder.HighlighterOrder           `json:"order,omitempty"`
	PhraseLimit           *int                                         `json:"phrase_limit,omitempty"`
	PostTags              []string                                     `json:"post_tags,omitempty"`
	PreTags               []string                                     `json:"pre_tags,omitempty"`
	RequireFieldMatch     *bool                                        `json:"require_field_match,omitempty"`
	TagsSchema            *highlightertagsschema.HighlighterTagsSchema `json:"tags_schema,omitempty"`
	Type                  *highlightertype.HighlighterType             `json:"type,omitempty"`
}

HighlightField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/highlighting.ts#L88-L92

func NewHighlightField ¶ added in v8.5.0 

func NewHighlightField() *HighlightField

NewHighlightField returns a HighlightField.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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    map[string]interface{} `json:"meta,omitempty"`
}

HistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L339-L340

func NewHistogramAggregate ¶ added in v8.5.0 

func NewHistogramAggregate() *HistogramAggregate

NewHistogramAggregate returns a HistogramAggregate.

type HistogramAggregation ¶ 

type HistogramAggregation struct {
	ExtendedBounds *ExtendedBoundsdouble  `json:"extended_bounds,omitempty"`
	Field          *string                `json:"field,omitempty"`
	Format         *string                `json:"format,omitempty"`
	HardBounds     *ExtendedBoundsdouble  `json:"hard_bounds,omitempty"`
	Interval       *float64               `json:"interval,omitempty"`
	Keyed          *bool                  `json:"keyed,omitempty"`
	Meta           map[string]interface{} `json:"meta,omitempty"`
	MinDocCount    *int                   `json:"min_doc_count,omitempty"`
	Missing        *float64               `json:"missing,omitempty"`
	Name           *string                `json:"name,omitempty"`
	Offset         *float64               `json:"offset,omitempty"`
	Order          *AggregateOrder        `json:"order,omitempty"`
	Script         *Script                `json:"script,omitempty"`
}

HistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L235-L247

func NewHistogramAggregation ¶ added in v8.5.0 

func NewHistogramAggregation() *HistogramAggregation

NewHistogramAggregation returns a HistogramAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L342-L345

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

type HistogramGrouping ¶ 

type HistogramGrouping struct {
	Fields   []string `json:"fields"`
	Interval int64    `json:"interval"`
}

HistogramGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/_types/Groupings.ts#L44-L47

func NewHistogramGrouping ¶ added in v8.5.0 

func NewHistogramGrouping() *HistogramGrouping

NewHistogramGrouping returns a HistogramGrouping.

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"`
	Type       string              `json:"type,omitempty"`
}

HistogramProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L54-L57

func NewHistogramProperty ¶ added in v8.5.0 

func NewHistogramProperty() *HistogramProperty

NewHistogramProperty returns a HistogramProperty.

type Hit ¶ 

type Hit struct {
	Explanation_       *Explanation               `json:"_explanation,omitempty"`
	Fields             map[string]interface{}     `json:"fields,omitempty"`
	Highlight          map[string][]string        `json:"highlight,omitempty"`
	Id_                string                     `json:"_id"`
	IgnoredFieldValues map[string][]string        `json:"ignored_field_values,omitempty"`
	Ignored_           []string                   `json:"_ignored,omitempty"`
	Index_             string                     `json:"_index"`
	InnerHits          map[string]InnerHitsResult `json:"inner_hits,omitempty"`
	MatchedQueries     []string                   `json:"matched_queries,omitempty"`
	Nested_            *NestedIdentity            `json:"_nested,omitempty"`
	Node_              *string                    `json:"_node,omitempty"`
	PrimaryTerm_       *int64                     `json:"_primary_term,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_            interface{}                `json:"_source,omitempty"`
	Version_           *int64                     `json:"_version,omitempty"`
}

Hit type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L40-L64

func NewHit ¶ added in v8.5.0 

func NewHit() *Hit

NewHit returns a Hit.

type HitsEvent ¶ 

type HitsEvent struct {
	Fields map[string][]interface{} `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"`
	// Source_ Original JSON body passed for the event at index time.
	Source_ interface{} `json:"_source,omitempty"`
}

HitsEvent type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/eql/_types/EqlHits.ts#L41-L49

func NewHitsEvent ¶ added in v8.5.0 

func NewHitsEvent() *HitsEvent

NewHitsEvent returns a HitsEvent.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L66-L72

func NewHitsMetadata ¶ added in v8.5.0 

func NewHitsMetadata() *HitsMetadata

NewHitsMetadata returns a HitsMetadata.

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 []interface{} `json:"join_keys"`
}

HitsSequence type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/eql/_types/EqlHits.ts#L51-L59

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L231-L234

func NewHoltLinearModelSettings ¶ added in v8.5.0 

func NewHoltLinearModelSettings() *HoltLinearModelSettings

NewHoltLinearModelSettings returns a HoltLinearModelSettings.

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      *string                 `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy    `json:"gap_policy,omitempty"`
	Meta        map[string]interface{}  `json:"meta,omitempty"`
	Minimize    *bool                   `json:"minimize,omitempty"`
	Model       string                  `json:"model,omitempty"`
	Name        *string                 `json:"name,omitempty"`
	Predict     *int                    `json:"predict,omitempty"`
	Settings    HoltLinearModelSettings `json:"settings"`
	Window      *int                    `json:"window,omitempty"`
}

HoltMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L217-L220

func NewHoltMovingAverageAggregation ¶ added in v8.5.0 

func NewHoltMovingAverageAggregation() *HoltMovingAverageAggregation

NewHoltMovingAverageAggregation returns a HoltMovingAverageAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L235-L242

func NewHoltWintersModelSettings ¶ added in v8.5.0 

func NewHoltWintersModelSettings() *HoltWintersModelSettings

NewHoltWintersModelSettings returns a HoltWintersModelSettings.

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      *string                  `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy     `json:"gap_policy,omitempty"`
	Meta        map[string]interface{}   `json:"meta,omitempty"`
	Minimize    *bool                    `json:"minimize,omitempty"`
	Model       string                   `json:"model,omitempty"`
	Name        *string                  `json:"name,omitempty"`
	Predict     *int                     `json:"predict,omitempty"`
	Settings    HoltWintersModelSettings `json:"settings"`
	Window      *int                     `json:"window,omitempty"`
}

HoltWintersMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L222-L225

func NewHoltWintersMovingAverageAggregation ¶ added in v8.5.0 

func NewHoltWintersMovingAverageAggregation() *HoltWintersMovingAverageAggregation

NewHoltWintersMovingAverageAggregation returns a HoltWintersMovingAverageAggregation.

type Hop ¶ 

type Hop struct {
	Connections *Hop               `json:"connections,omitempty"`
	Query       Query              `json:"query"`
	Vertices    []VertexDefinition `json:"vertices"`
}

Hop type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/Hop.ts#L23-L27

func NewHop ¶ added in v8.5.0 

func NewHop() *Hop

NewHop returns a Hop.

type HotThread ¶ 

type HotThread struct {
	Hosts    []string `json:"hosts"`
	NodeId   string   `json:"node_id"`
	NodeName string   `json:"node_name"`
	Threads  []string `json:"threads"`
}

HotThread type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/hot_threads/types.ts#L23-L28

func NewHotThread ¶ added in v8.5.0 

func NewHotThread() *HotThread

NewHotThread returns a HotThread.

type HourAndMinute ¶ 

type HourAndMinute struct {
	Hour   []int `json:"hour"`
	Minute []int `json:"minute"`
}

HourAndMinute type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L110-L113

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 {
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

HtmlStripCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/char_filters.ts#L43-L45

func NewHtmlStripCharFilter ¶ added in v8.5.0 

func NewHtmlStripCharFilter() *HtmlStripCharFilter

NewHtmlStripCharFilter returns a HtmlStripCharFilter.

type Http ¶ 

type Http struct {
	Clients     []Client `json:"clients,omitempty"`
	CurrentOpen *int     `json:"current_open,omitempty"`
	TotalOpened *int64   `json:"total_opened,omitempty"`
}

Http type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L260-L264

func NewHttp ¶ added in v8.5.0 

func NewHttp() *Http

NewHttp returns a Http.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L218-L222

func NewHttpEmailAttachment ¶ added in v8.5.0 

func NewHttpEmailAttachment() *HttpEmailAttachment

NewHttpEmailAttachment returns a HttpEmailAttachment.

type HttpHeaders ¶ 

type HttpHeaders map[string][]string

HttpHeaders type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L138-L138

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L54-L57

func NewHttpInputBasicAuthentication ¶ added in v8.5.0 

func NewHttpInputBasicAuthentication() *HttpInputBasicAuthentication

NewHttpInputBasicAuthentication returns a HttpInputBasicAuthentication.

type HttpInputProxy ¶ 

type HttpInputProxy struct {
	Host string `json:"host"`
	Port uint   `json:"port"`
}

HttpInputProxy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L67-L70

func NewHttpInputProxy ¶ added in v8.5.0 

func NewHttpInputProxy() *HttpInputProxy

NewHttpInputProxy returns a HttpInputProxy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L72-L86

func NewHttpInputRequestDefinition ¶ added in v8.5.0 

func NewHttpInputRequestDefinition() *HttpInputRequestDefinition

NewHttpInputRequestDefinition returns a HttpInputRequestDefinition.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L300-L300

func NewHttpInputRequestResult ¶ added in v8.5.0 

func NewHttpInputRequestResult() *HttpInputRequestResult

NewHttpInputRequestResult returns a HttpInputRequestResult.

type HttpInputResponseResult ¶ 

type HttpInputResponseResult struct {
	Body    string              `json:"body"`
	Headers map[string][]string `json:"headers"`
	Status  int                 `json:"status"`
}

HttpInputResponseResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L302-L306

func NewHttpInputResponseResult ¶ added in v8.5.0 

func NewHttpInputResponseResult() *HttpInputResponseResult

NewHttpInputResponseResult returns a HttpInputResponseResult.

type HunspellTokenFilter ¶ 

type HunspellTokenFilter struct {
	Dedup       *bool   `json:"dedup,omitempty"`
	Dictionary  *string `json:"dictionary,omitempty"`
	Locale      string  `json:"locale"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L199-L205

func NewHunspellTokenFilter ¶ added in v8.5.0 

func NewHunspellTokenFilter() *HunspellTokenFilter

NewHunspellTokenFilter returns a HunspellTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L205-L219

func NewHyperparameter ¶ added in v8.5.0 

func NewHyperparameter() *Hyperparameter

NewHyperparameter returns a Hyperparameter.

type Hyperparameters ¶ 

type Hyperparameters struct {
	Alpha                                  *float64 `json:"alpha,omitempty"`
	DownsampleFactor                       *float64 `json:"downsample_factor,omitempty"`
	Eta                                    *float64 `json:"eta,omitempty"`
	EtaGrowthRatePerTree                   *float64 `json:"eta_growth_rate_per_tree,omitempty"`
	FeatureBagFraction                     *float64 `json:"feature_bag_fraction,omitempty"`
	Gamma                                  *float64 `json:"gamma,omitempty"`
	Lambda                                 *float64 `json:"lambda,omitempty"`
	MaxAttemptsToAddTree                   *int     `json:"max_attempts_to_add_tree,omitempty"`
	MaxOptimizationRoundsPerHyperparameter *int     `json:"max_optimization_rounds_per_hyperparameter,omitempty"`
	MaxTrees                               *int     `json:"max_trees,omitempty"`
	NumFolds                               *int     `json:"num_folds,omitempty"`
	NumSplitsPerFeature                    *int     `json:"num_splits_per_feature,omitempty"`
	SoftTreeDepthLimit                     *int     `json:"soft_tree_depth_limit,omitempty"`
	SoftTreeDepthTolerance                 *float64 `json:"soft_tree_depth_tolerance,omitempty"`
}

Hyperparameters type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L395-L410

func NewHyperparameters ¶ added in v8.5.0 

func NewHyperparameters() *Hyperparameters

NewHyperparameters returns a Hyperparameters.

type HyphenationDecompounderTokenFilter ¶ 

type HyphenationDecompounderTokenFilter struct {
	HyphenationPatternsPath *string  `json:"hyphenation_patterns_path,omitempty"`
	MaxSubwordSize          *int     `json:"max_subword_size,omitempty"`
	MinSubwordSize          *int     `json:"min_subword_size,omitempty"`
	MinWordSize             *int     `json:"min_word_size,omitempty"`
	OnlyLongestMatch        *bool    `json:"only_longest_match,omitempty"`
	Type                    string   `json:"type,omitempty"`
	Version                 *string  `json:"version,omitempty"`
	WordList                []string `json:"word_list,omitempty"`
	WordListPath            *string  `json:"word_list_path,omitempty"`
}

HyphenationDecompounderTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L57-L59

func NewHyphenationDecompounderTokenFilter ¶ added in v8.5.0 

func NewHyphenationDecompounderTokenFilter() *HyphenationDecompounderTokenFilter

NewHyphenationDecompounderTokenFilter returns a HyphenationDecompounderTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L67-L71

func NewIcuAnalyzer ¶ added in v8.5.0 

func NewIcuAnalyzer() *IcuAnalyzer

NewIcuAnalyzer returns a IcuAnalyzer.

type IcuCollationTokenFilter ¶ 

type IcuCollationTokenFilter struct {
	Alternate              *icucollationalternate.IcuCollationAlternate         `json:"alternate,omitempty"`
	CaseFirst              *icucollationcasefirst.IcuCollationCaseFirst         `json:"caseFirst,omitempty"`
	CaseLevel              *bool                                                `json:"caseLevel,omitempty"`
	Country                *string                                              `json:"country,omitempty"`
	Decomposition          *icucollationdecomposition.IcuCollationDecomposition `json:"decomposition,omitempty"`
	HiraganaQuaternaryMode *bool                                                `json:"hiraganaQuaternaryMode,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:"variableTop,omitempty"`
	Variant                *string                                              `json:"variant,omitempty"`
	Version                *string                                              `json:"version,omitempty"`
}

IcuCollationTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L51-L65

func NewIcuCollationTokenFilter ¶ added in v8.5.0 

func NewIcuCollationTokenFilter() *IcuCollationTokenFilter

NewIcuCollationTokenFilter returns a IcuCollationTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L46-L49

func NewIcuFoldingTokenFilter ¶ added in v8.5.0 

func NewIcuFoldingTokenFilter() *IcuFoldingTokenFilter

NewIcuFoldingTokenFilter returns a IcuFoldingTokenFilter.

type IcuNormalizationCharFilter ¶ 

type IcuNormalizationCharFilter struct {
	Mode    *icunormalizationmode.IcuNormalizationMode `json:"mode,omitempty"`
	Name    *icunormalizationtype.IcuNormalizationType `json:"name,omitempty"`
	Type    string                                     `json:"type,omitempty"`
	Version *string                                    `json:"version,omitempty"`
}

IcuNormalizationCharFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L40-L44

func NewIcuNormalizationCharFilter ¶ added in v8.5.0 

func NewIcuNormalizationCharFilter() *IcuNormalizationCharFilter

NewIcuNormalizationCharFilter returns a IcuNormalizationCharFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L35-L38

func NewIcuNormalizationTokenFilter ¶ added in v8.5.0 

func NewIcuNormalizationTokenFilter() *IcuNormalizationTokenFilter

NewIcuNormalizationTokenFilter returns a IcuNormalizationTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L30-L33

func NewIcuTokenizer ¶ added in v8.5.0 

func NewIcuTokenizer() *IcuTokenizer

NewIcuTokenizer returns a IcuTokenizer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/icu-plugin.ts#L24-L28

func NewIcuTransformTokenFilter ¶ added in v8.5.0 

func NewIcuTransformTokenFilter() *IcuTransformTokenFilter

NewIcuTransformTokenFilter returns a IcuTransformTokenFilter.

type Ids ¶ 

type Ids []string

Ids type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L56-L56

type IdsQuery ¶ 

type IdsQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Values     []string `json:"values,omitempty"`
}

IdsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L53-L55

func NewIdsQuery ¶ added in v8.5.0 

func NewIdsQuery() *IdsQuery

NewIdsQuery returns a IdsQuery.

type Ilm ¶ 

type Ilm struct {
	PolicyCount int                   `json:"policy_count"`
	PolicyStats []IlmPolicyStatistics `json:"policy_stats"`
}

Ilm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L154-L157

func NewIlm ¶ added in v8.5.0 

func NewIlm() *Ilm

NewIlm returns a Ilm.

type IlmActions ¶ added in v8.5.0 

type IlmActions interface{}

IlmActions type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L45-L45

type IlmPolicy ¶ added in v8.5.0 

type IlmPolicy struct {
	Meta_  map[string]interface{} `json:"_meta,omitempty"`
	Phases Phases                 `json:"phases"`
}

IlmPolicy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Policy.ts#L23-L26

func NewIlmPolicy ¶ added in v8.5.0 

func NewIlmPolicy() *IlmPolicy

NewIlmPolicy returns a IlmPolicy.

type IlmPolicyStatistics ¶ 

type IlmPolicyStatistics struct {
	IndicesManaged int    `json:"indices_managed"`
	Phases         Phases `json:"phases"`
}

IlmPolicyStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L149-L152

func NewIlmPolicyStatistics ¶ added in v8.5.0 

func NewIlmPolicyStatistics() *IlmPolicyStatistics

NewIlmPolicyStatistics returns a IlmPolicyStatistics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L131-L136

func NewInProgress ¶ added in v8.5.0 

func NewInProgress() *InProgress

NewInProgress returns a InProgress.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L256-L265

func NewIndexAction ¶ added in v8.5.0 

func NewIndexAction() *IndexAction

NewIndexAction returns a IndexAction.

type IndexAliases ¶ 

type IndexAliases struct {
	Aliases map[string]AliasDefinition `json:"aliases"`
}

IndexAliases type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/get_alias/IndicesGetAliasResponse.ts#L36-L38

func NewIndexAliases ¶ added in v8.5.0 

func NewIndexAliases() *IndexAliases

NewIndexAliases returns a IndexAliases.

type IndexAndDataStreamAction ¶ 

type IndexAndDataStreamAction struct {
	DataStream string `json:"data_stream"`
	Index      string `json:"index"`
}

IndexAndDataStreamAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/modify_data_stream/types.ts#L28-L31

func NewIndexAndDataStreamAction ¶ added in v8.5.0 

func NewIndexAndDataStreamAction() *IndexAndDataStreamAction

NewIndexAndDataStreamAction returns a IndexAndDataStreamAction.

type IndexCapabilities ¶ 

type IndexCapabilities struct {
	RollupJobs []RollupJobSummary `json:"rollup_jobs"`
}

IndexCapabilities type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotIndexDetails.ts#L23-L28

func NewIndexDetails ¶ added in v8.5.0 

func NewIndexDetails() *IndexDetails

NewIndexDetails returns a IndexDetails.

type IndexField ¶ 

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

IndexField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L46-L48

func NewIndexField ¶ added in v8.5.0 

func NewIndexField() *IndexField

NewIndexField returns a IndexField.

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"`
	UnassignedShards    int                         `json:"unassigned_shards"`
}

IndexHealthStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/health/types.ts#L24-L34

func NewIndexHealthStats ¶ added in v8.5.0 

func NewIndexHealthStats() *IndexHealthStats

NewIndexHealthStats returns a IndexHealthStats.

type IndexMappingRecord ¶ 

type IndexMappingRecord struct {
	Item     *TypeMapping `json:"item,omitempty"`
	Mappings TypeMapping  `json:"mappings"`
}

IndexMappingRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/get_mapping/IndicesGetMappingResponse.ts#L28-L31

func NewIndexMappingRecord ¶ added in v8.5.0 

func NewIndexMappingRecord() *IndexMappingRecord

NewIndexMappingRecord returns a IndexMappingRecord.

type IndexPatterns ¶ 

type IndexPatterns []string

IndexPatterns type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L64-L64

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/has_privileges/types.ts#L33-L44

func NewIndexPrivilegesCheck ¶ added in v8.5.0 

func NewIndexPrivilegesCheck() *IndexPrivilegesCheck

NewIndexPrivilegesCheck returns a IndexPrivilegesCheck.

type IndexResult ¶ 

type IndexResult struct {
	Response IndexResultSummary `json:"response"`
}

IndexResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L271-L277

func NewIndexResultSummary ¶ added in v8.5.0 

func NewIndexResultSummary() *IndexResultSummary

NewIndexResultSummary returns a IndexResultSummary.

type IndexRouting ¶ 

type IndexRouting struct {
	Allocation *IndexRoutingAllocation `json:"allocation,omitempty"`
	Rebalance  *IndexRoutingRebalance  `json:"rebalance,omitempty"`
}

IndexRouting type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexRouting.ts#L62-L64

func NewIndexRoutingAllocationDisk ¶ added in v8.5.0 

func NewIndexRoutingAllocationDisk() *IndexRoutingAllocationDisk

NewIndexRoutingAllocationDisk returns a IndexRoutingAllocationDisk.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexRouting.ts#L52-L55

func NewIndexRoutingAllocationInclude ¶ added in v8.5.0 

func NewIndexRoutingAllocationInclude() *IndexRoutingAllocationInclude

NewIndexRoutingAllocationInclude returns a IndexRoutingAllocationInclude.

type IndexRoutingAllocationInitialRecovery ¶ 

type IndexRoutingAllocationInitialRecovery struct {
	Id_ *string `json:"_id,omitempty"`
}

IndexRoutingAllocationInitialRecovery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexRouting.ts#L57-L59

func NewIndexRoutingAllocationInitialRecovery ¶ added in v8.5.0 

func NewIndexRoutingAllocationInitialRecovery() *IndexRoutingAllocationInitialRecovery

NewIndexRoutingAllocationInitialRecovery returns a IndexRoutingAllocationInitialRecovery.

type IndexRoutingRebalance ¶ 

type IndexRoutingRebalance struct {
	Enable indexroutingrebalanceoptions.IndexRoutingRebalanceOptions `json:"enable"`
}

IndexRoutingRebalance type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSegmentSort.ts#L22-L27

func NewIndexSegmentSort ¶ added in v8.5.0 

func NewIndexSegmentSort() *IndexSegmentSort

NewIndexSegmentSort returns a IndexSegmentSort.

type IndexSettingBlocks ¶ 

type IndexSettingBlocks struct {
	Metadata            *bool  `json:"metadata,omitempty"`
	Read                *bool  `json:"read,omitempty"`
	ReadOnly            *bool  `json:"read_only,omitempty"`
	ReadOnlyAllowDelete *bool  `json:"read_only_allow_delete,omitempty"`
	Write               string `json:"write,omitempty"`
}

IndexSettingBlocks type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L245-L251

func NewIndexSettingBlocks ¶ added in v8.5.0 

func NewIndexSettingBlocks() *IndexSettingBlocks

NewIndexSettingBlocks returns a IndexSettingBlocks.

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 *string                                  `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]interface{}                   `json:"-"`
	// IndexingPressure Configure indexing back pressure limits.
	IndexingPressure              *IndicesIndexingPressure `json:"indexing_pressure,omitempty"`
	IndexingSlowlog               *SlowlogSettings         `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    *int                  `json:"routing_partition_size,omitempty"`
	RoutingPath             []string              `json:"routing_path,omitempty"`
	Search                  *SettingsSearch       `json:"search,omitempty"`
	Settings                *IndexSettings        `json:"settings,omitempty"`
	Shards                  *int                  `json:"shards,omitempty"`
	// Similarity Configure custom similarity settings to customize how search results are
	// scored.
	Similarity  *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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L69-L168

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L310-L316

func NewIndexSettingsAnalysis ¶ added in v8.5.0 

func NewIndexSettingsAnalysis() *IndexSettingsAnalysis

NewIndexSettingsAnalysis returns a IndexSettingsAnalysis.

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 *bool `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"`
	// 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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L267-L300

func NewIndexSettingsLifecycle ¶ added in v8.5.0 

func NewIndexSettingsLifecycle() *IndexSettingsLifecycle

NewIndexSettingsLifecycle returns a IndexSettingsLifecycle.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L302-L308

func NewIndexSettingsLifecycleStep ¶ added in v8.5.0 

func NewIndexSettingsLifecycleStep() *IndexSettingsLifecycleStep

NewIndexSettingsLifecycleStep returns a IndexSettingsLifecycleStep.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L318-L321

func NewIndexSettingsTimeSeries ¶ added in v8.5.0 

func NewIndexSettingsTimeSeries() *IndexSettingsTimeSeries

NewIndexSettingsTimeSeries returns a IndexSettingsTimeSeries.

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"`
	Mappings *TypeMapping   `json:"mappings,omitempty"`
	Settings *IndexSettings `json:"settings,omitempty"`
}

IndexState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexState.ts#L26-L33

func NewIndexState ¶ added in v8.5.0 

func NewIndexState() *IndexState

NewIndexState returns a IndexState.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L49-L87

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      []string                              `json:"composed_of"`
	DataStream      *IndexTemplateDataStreamConfiguration `json:"data_stream,omitempty"`
	IndexPatterns   []string                              `json:"index_patterns"`
	Meta_           map[string]interface{}                `json:"_meta,omitempty"`
	Priority        *int64                                `json:"priority,omitempty"`
	Template        *IndexTemplateSummary                 `json:"template,omitempty"`
	Version         *int64                                `json:"version,omitempty"`
}

IndexTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexTemplate.ts#L27-L37

func NewIndexTemplate ¶ added in v8.5.0 

func NewIndexTemplate() *IndexTemplate

NewIndexTemplate returns a IndexTemplate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexTemplate.ts#L39-L50

func NewIndexTemplateDataStreamConfiguration ¶ added in v8.5.0 

func NewIndexTemplateDataStreamConfiguration() *IndexTemplateDataStreamConfiguration

NewIndexTemplateDataStreamConfiguration returns a IndexTemplateDataStreamConfiguration.

type IndexTemplateItem ¶ 

type IndexTemplateItem struct {
	IndexTemplate IndexTemplate `json:"index_template"`
	Name          string        `json:"name"`
}

IndexTemplateItem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L29-L32

func NewIndexTemplateItem ¶ added in v8.5.0 

func NewIndexTemplateItem() *IndexTemplateItem

NewIndexTemplateItem returns a IndexTemplateItem.

type IndexTemplateMapping ¶ 

type IndexTemplateMapping struct {
	Aliases  map[string]Alias `json:"aliases,omitempty"`
	Mappings *TypeMapping     `json:"mappings,omitempty"`
	Settings *IndexSettings   `json:"settings,omitempty"`
}

IndexTemplateMapping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L60-L64

func NewIndexTemplateMapping ¶ added in v8.5.0 

func NewIndexTemplateMapping() *IndexTemplateMapping

NewIndexTemplateMapping returns a IndexTemplateMapping.

type IndexTemplateSummary ¶ 

type IndexTemplateSummary struct {
	Aliases  map[string]Alias `json:"aliases,omitempty"`
	Mappings *TypeMapping     `json:"mappings,omitempty"`
	Settings *IndexSettings   `json:"settings,omitempty"`
}

IndexTemplateSummary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexTemplate.ts#L52-L56

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L262-L265

func NewIndexVersioning ¶ added in v8.5.0 

func NewIndexVersioning() *IndexVersioning

NewIndexVersioning returns a IndexVersioning.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L302-L311

func NewIndexingPressureMemorySummary ¶ added in v8.5.0 

func NewIndexingPressureMemorySummary() *IndexingPressureMemorySummary

NewIndexingPressureMemorySummary returns a IndexingPressureMemorySummary.

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"`
}

IndexingStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L101-L116

func NewIndexingStats ¶ added in v8.5.0 

func NewIndexingStats() *IndexingStats

NewIndexingStats returns a IndexingStats.

type Indices ¶ 

type Indices []string

Indices type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L61-L61

type IndicesAction ¶ added in v8.5.0 

type IndicesAction struct {
	Add         *AddAction         `json:"add,omitempty"`
	Remove      *RemoveAction      `json:"remove,omitempty"`
	RemoveIndex *RemoveIndexAction `json:"remove_index,omitempty"`
}

IndicesAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/update_aliases/types.ts#L23-L28

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/add_block/IndicesAddBlockResponse.ts#L30-L33

func NewIndicesBlockStatus ¶ added in v8.5.0 

func NewIndicesBlockStatus() *IndicesBlockStatus

NewIndicesBlockStatus returns a IndicesBlockStatus.

type IndicesIndexingPressure ¶ added in v8.5.0 

type IndicesIndexingPressure struct {
	Memory IndicesIndexingPressureMemory `json:"memory"`
}

IndicesIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L540-L542

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L544-L551

func NewIndicesIndexingPressureMemory ¶ added in v8.5.0 

func NewIndicesIndexingPressureMemory() *IndicesIndexingPressureMemory

NewIndicesIndexingPressureMemory returns a IndicesIndexingPressureMemory.

type IndicesModifyAction ¶ added in v8.5.0 

type IndicesModifyAction struct {
	AddBackingIndex    *IndexAndDataStreamAction `json:"add_backing_index,omitempty"`
	RemoveBackingIndex *IndexAndDataStreamAction `json:"remove_backing_index,omitempty"`
}

IndicesModifyAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/modify_data_stream/types.ts#L22-L26

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L297-L324

func NewIndicesOptions ¶ added in v8.5.0 

func NewIndicesOptions() *IndicesOptions

NewIndicesOptions returns a IndicesOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L81-L104

func NewIndicesPrivileges ¶ added in v8.5.0 

func NewIndicesPrivileges() *IndicesPrivileges

NewIndicesPrivileges returns a IndicesPrivileges.

type IndicesPrivilegesQuery ¶ 

type IndicesPrivilegesQuery interface{}

IndicesPrivilegesQuery holds the union for the following types: 

string
Query
RoleTemplateQuery

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L130-L138

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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/indices/types.ts#L20-L801

func NewIndicesRecord ¶ added in v8.5.0 

func NewIndicesRecord() *IndicesRecord

NewIndicesRecord returns a IndicesRecord.

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"`
	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          *ShardsTotalStats     `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L174-L201

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L49-L52

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L89-L98

func NewIndicesStats ¶ added in v8.5.0 

func NewIndicesStats() *IndicesStats

NewIndicesStats returns a IndicesStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/validate_query/IndicesValidateQueryResponse.ts#L32-L37

func NewIndicesValidationExplanation ¶ added in v8.5.0 

func NewIndicesValidationExplanation() *IndicesValidationExplanation

NewIndicesValidationExplanation returns a IndicesValidationExplanation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L137-L142

func NewIndicesVersions ¶ added in v8.5.0 

func NewIndicesVersions() *IndicesVersions

NewIndicesVersions returns a IndicesVersions.

type InferenceAggregate ¶ 

type InferenceAggregate struct {
	Data              map[string]interface{}       `json:"-"`
	FeatureImportance []InferenceFeatureImportance `json:"feature_importance,omitempty"`
	Meta              map[string]interface{}       `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L650-L661

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

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          *string                   `json:"format,omitempty"`
	GapPolicy       *gappolicy.GapPolicy      `json:"gap_policy,omitempty"`
	InferenceConfig *InferenceConfigContainer `json:"inference_config,omitempty"`
	Meta            map[string]interface{}    `json:"meta,omitempty"`
	ModelId         string                    `json:"model_id"`
	Name            *string                   `json:"name,omitempty"`
}

InferenceAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L171-L174

func NewInferenceAggregation ¶ added in v8.5.0 

func NewInferenceAggregation() *InferenceAggregation

NewInferenceAggregation returns a InferenceAggregation.

type InferenceClassImportance ¶ 

type InferenceClassImportance struct {
	ClassName  string  `json:"class_name"`
	Importance float64 `json:"importance"`
}

InferenceClassImportance type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L675-L678

func NewInferenceClassImportance ¶ added in v8.5.0 

func NewInferenceClassImportance() *InferenceClassImportance

NewInferenceClassImportance returns a InferenceClassImportance.

type InferenceConfig ¶ 

type InferenceConfig struct {
	Classification *InferenceConfigClassification `json:"classification,omitempty"`
	Regression     *InferenceConfigRegression     `json:"regression,omitempty"`
}

InferenceConfig type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L244-L250

func NewInferenceConfig ¶ added in v8.5.0 

func NewInferenceConfig() *InferenceConfig

NewInferenceConfig returns a InferenceConfig.

type InferenceConfigClassification ¶ 

type InferenceConfigClassification struct {
	NumTopClasses                 *int    `json:"num_top_classes,omitempty"`
	NumTopFeatureImportanceValues *int    `json:"num_top_feature_importance_values,omitempty"`
	PredictionFieldType           *string `json:"prediction_field_type,omitempty"`
	ResultsField                  *string `json:"results_field,omitempty"`
	TopClassesResultsField        *string `json:"top_classes_results_field,omitempty"`
}

InferenceConfigClassification type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L257-L263

func NewInferenceConfigClassification ¶ added in v8.5.0 

func NewInferenceConfigClassification() *InferenceConfigClassification

NewInferenceConfigClassification returns a InferenceConfigClassification.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L176-L182

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"`
	// 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"`
	// ZeroShotClassification Zeroshot classification configuration for inference.
	ZeroShotClassification *ZeroShotClassificationInferenceOptions `json:"zero_shot_classification,omitempty"`
}

InferenceConfigCreateContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L23-L67

func NewInferenceConfigCreateContainer ¶ added in v8.5.0 

func NewInferenceConfigCreateContainer() *InferenceConfigCreateContainer

NewInferenceConfigCreateContainer returns a InferenceConfigCreateContainer.

type InferenceConfigRegression ¶ 

type InferenceConfigRegression struct {
	NumTopFeatureImportanceValues *int    `json:"num_top_feature_importance_values,omitempty"`
	ResultsField                  *string `json:"results_field,omitempty"`
}

InferenceConfigRegression type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L252-L255

func NewInferenceConfigRegression ¶ added in v8.5.0 

func NewInferenceConfigRegression() *InferenceConfigRegression

NewInferenceConfigRegression returns a InferenceConfigRegression.

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"`
	// ZeroShotClassification Zeroshot classification configuration for inference.
	ZeroShotClassification *ZeroShotClassificationInferenceUpdateOptions `json:"zero_shot_classification,omitempty"`
}

InferenceConfigUpdateContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L259-L279

func NewInferenceConfigUpdateContainer ¶ added in v8.5.0 

func NewInferenceConfigUpdateContainer() *InferenceConfigUpdateContainer

NewInferenceConfigUpdateContainer returns a InferenceConfigUpdateContainer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L669-L673

func NewInferenceFeatureImportance ¶ added in v8.5.0 

func NewInferenceFeatureImportance() *InferenceFeatureImportance

NewInferenceFeatureImportance returns a InferenceFeatureImportance.

type InferenceProcessor ¶ 

type InferenceProcessor struct {
	Description     *string                `json:"description,omitempty"`
	FieldMap        map[string]interface{} `json:"field_map,omitempty"`
	If              *string                `json:"if,omitempty"`
	IgnoreFailure   *bool                  `json:"ignore_failure,omitempty"`
	InferenceConfig *InferenceConfig       `json:"inference_config,omitempty"`
	ModelId         string                 `json:"model_id"`
	OnFailure       []ProcessorContainer   `json:"on_failure,omitempty"`
	Tag             *string                `json:"tag,omitempty"`
	TargetField     *string                `json:"target_field,omitempty"`
}

InferenceProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L237-L242

func NewInferenceProcessor ¶ added in v8.5.0 

func NewInferenceProcessor() *InferenceProcessor

NewInferenceProcessor returns a InferenceProcessor.

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 []PredictedValue `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L412-L459

func NewInferenceResponseResult ¶ added in v8.5.0 

func NewInferenceResponseResult() *InferenceResponseResult

NewInferenceResponseResult returns a InferenceResponseResult.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L663-L667

func NewInferenceTopClassEntry ¶ added in v8.5.0 

func NewInferenceTopClassEntry() *InferenceTopClassEntry

NewInferenceTopClassEntry returns a InferenceTopClassEntry.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Anomaly.ts#L70-L73

func NewInfluence ¶ added in v8.5.0 

func NewInfluence() *Influence

NewInfluence returns a Influence.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Influencer.ts#L31-L83

func NewInfluencer ¶ added in v8.5.0 

func NewInfluencer() *Influencer

NewInfluencer returns a Influencer.

type InfoFeatureState ¶ 

type InfoFeatureState struct {
	FeatureName string   `json:"feature_name"`
	Indices     []string `json:"indices"`
}

InfoFeatureState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotInfoFeatureState.ts#L22-L25

func NewInfoFeatureState ¶ added in v8.5.0 

func NewInfoFeatureState() *InfoFeatureState

NewInfoFeatureState returns a InfoFeatureState.

type IngestPipeline ¶ added in v8.5.0 

type IngestPipeline struct {
	Description *string              `json:"description,omitempty"`
	OnFailure   []ProcessorContainer `json:"on_failure,omitempty"`
	Processors  []ProcessorContainer `json:"processors,omitempty"`
	Version     *int64               `json:"version,omitempty"`
}

IngestPipeline type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Pipeline.ts#L23-L28

func NewIngestPipeline ¶ added in v8.5.0 

func NewIngestPipeline() *IngestPipeline

NewIngestPipeline returns a IngestPipeline.

type IngestTotal ¶ 

type IngestTotal struct {
	Count        *int64                      `json:"count,omitempty"`
	Current      *int64                      `json:"current,omitempty"`
	Failed       *int64                      `json:"failed,omitempty"`
	Processors   []map[string]KeyedProcessor `json:"processors,omitempty"`
	TimeInMillis *int64                      `json:"time_in_millis,omitempty"`
}

IngestTotal type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L143-L149

func NewIngestTotal ¶ added in v8.5.0 

func NewIngestTotal() *IngestTotal

NewIngestTotal returns a IngestTotal.

type InlineGet ¶ 

type InlineGet struct {
	Fields       map[string]interface{} `json:"fields,omitempty"`
	Found        bool                   `json:"found"`
	Metadata     map[string]interface{} `json:"-"`
	PrimaryTerm_ *int64                 `json:"_primary_term,omitempty"`
	Routing_     *string                `json:"_routing,omitempty"`
	SeqNo_       *int64                 `json:"_seq_no,omitempty"`
	Source_      interface{}            `json:"_source,omitempty"`
}

InlineGet type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L286-L295

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

type InlineGetDictUserDefined ¶ 

type InlineGetDictUserDefined struct {
	Fields                   map[string]interface{} `json:"fields,omitempty"`
	Found                    bool                   `json:"found"`
	InlineGetDictUserDefined map[string]interface{} `json:"-"`
	PrimaryTerm_             *int64                 `json:"_primary_term,omitempty"`
	Routing_                 *string                `json:"_routing,omitempty"`
	SeqNo_                   *int64                 `json:"_seq_no,omitempty"`
	Source_                  map[string]interface{} `json:"_source"`
}

InlineGetDictUserDefined type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L286-L295

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

type InlineScript ¶ 

type InlineScript struct {
	Lang    *scriptlanguage.ScriptLanguage `json:"lang,omitempty"`
	Options map[string]string              `json:"options,omitempty"`
	Params  map[string]interface{}         `json:"params,omitempty"`
	Source  string                         `json:"source"`
}

InlineScript type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Scripting.ts#L45-L50

func NewInlineScript ¶ added in v8.5.0 

func NewInlineScript() *InlineScript

NewInlineScript returns a InlineScript.

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             *int                   `json:"from,omitempty"`
	Highlight        *Highlight             `json:"highlight,omitempty"`
	IgnoreUnmapped   *bool                  `json:"ignore_unmapped,omitempty"`
	Name             *string                `json:"name,omitempty"`
	ScriptFields     map[string]ScriptField `json:"script_fields,omitempty"`
	SeqNoPrimaryTerm *bool                  `json:"seq_no_primary_term,omitempty"`
	Size             *int                   `json:"size,omitempty"`
	Sort             []SortCombinations     `json:"sort,omitempty"`
	Source_          *SourceConfig          `json:"_source,omitempty"`
	StoredField      []string               `json:"stored_field,omitempty"`
	TrackScores      *bool                  `json:"track_scores,omitempty"`
	Version          *bool                  `json:"version,omitempty"`
}

InnerHits type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L106-L124

func NewInnerHits ¶ added in v8.5.0 

func NewInnerHits() *InnerHits

NewInnerHits returns a InnerHits.

type InnerHitsResult ¶ 

type InnerHitsResult struct {
	Hits *HitsMetadata `json:"hits,omitempty"`
}

InnerHitsResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L84-L86

func NewInnerHitsResult ¶ added in v8.5.0 

func NewInnerHitsResult() *InnerHitsResult

NewInnerHitsResult returns a InnerHitsResult.

type Input ¶ 

type Input struct {
	FieldNames []string `json:"field_names"`
}

Input type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L56-L58

func NewInput ¶ added in v8.5.0 

func NewInput() *Input

NewInput returns a Input.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L146-L149

func NewIntegerNumberProperty ¶ added in v8.5.0 

func NewIntegerNumberProperty() *IntegerNumberProperty

NewIntegerNumberProperty returns a IntegerNumberProperty.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

IntegerRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L42-L44

func NewIntegerRangeProperty ¶ added in v8.5.0 

func NewIntegerRangeProperty() *IntegerRangeProperty

NewIntegerRangeProperty returns a IntegerRangeProperty.

type Intervals ¶ added in v8.5.0 

type Intervals struct {
	AllOf    *IntervalsAllOf    `json:"all_of,omitempty"`
	AnyOf    *IntervalsAnyOf    `json:"any_of,omitempty"`
	Fuzzy    *IntervalsFuzzy    `json:"fuzzy,omitempty"`
	Match    *IntervalsMatch    `json:"match,omitempty"`
	Prefix   *IntervalsPrefix   `json:"prefix,omitempty"`
	Wildcard *IntervalsWildcard `json:"wildcard,omitempty"`
}

Intervals type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L63-L72

func NewIntervals ¶ added in v8.5.0 

func NewIntervals() *Intervals

NewIntervals returns a Intervals.

type IntervalsAllOf ¶ 

type IntervalsAllOf struct {
	Filter    *IntervalsFilter `json:"filter,omitempty"`
	Intervals []Intervals      `json:"intervals"`
	MaxGaps   *int             `json:"max_gaps,omitempty"`
	Ordered   *bool            `json:"ordered,omitempty"`
}

IntervalsAllOf type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L49-L56

func NewIntervalsAllOf ¶ added in v8.5.0 

func NewIntervalsAllOf() *IntervalsAllOf

NewIntervalsAllOf returns a IntervalsAllOf.

type IntervalsAnyOf ¶ 

type IntervalsAnyOf struct {
	Filter    *IntervalsFilter `json:"filter,omitempty"`
	Intervals []Intervals      `json:"intervals"`
}

IntervalsAnyOf type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L58-L61

func NewIntervalsAnyOf ¶ added in v8.5.0 

func NewIntervalsAnyOf() *IntervalsAnyOf

NewIntervalsAnyOf returns a IntervalsAnyOf.

type IntervalsFilter ¶ 

type IntervalsFilter struct {
	After          *Intervals `json:"after,omitempty"`
	Before         *Intervals `json:"before,omitempty"`
	ContainedBy    *Intervals `json:"contained_by,omitempty"`
	Containing     *Intervals `json:"containing,omitempty"`
	NotContainedBy *Intervals `json:"not_contained_by,omitempty"`
	NotContaining  *Intervals `json:"not_containing,omitempty"`
	NotOverlapping *Intervals `json:"not_overlapping,omitempty"`
	Overlapping    *Intervals `json:"overlapping,omitempty"`
	Script         *Script    `json:"script,omitempty"`
}

IntervalsFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L74-L86

func NewIntervalsFilter ¶ added in v8.5.0 

func NewIntervalsFilter() *IntervalsFilter

NewIntervalsFilter returns a IntervalsFilter.

type IntervalsFuzzy ¶ 

type IntervalsFuzzy struct {
	Analyzer       *string    `json:"analyzer,omitempty"`
	Fuzziness      *Fuzziness `json:"fuzziness,omitempty"`
	PrefixLength   *int       `json:"prefix_length,omitempty"`
	Term           string     `json:"term"`
	Transpositions *bool      `json:"transpositions,omitempty"`
	UseField       *string    `json:"use_field,omitempty"`
}

IntervalsFuzzy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L88-L97

func NewIntervalsFuzzy ¶ added in v8.5.0 

func NewIntervalsFuzzy() *IntervalsFuzzy

NewIntervalsFuzzy returns a IntervalsFuzzy.

type IntervalsMatch ¶ 

type IntervalsMatch struct {
	Analyzer *string          `json:"analyzer,omitempty"`
	Filter   *IntervalsFilter `json:"filter,omitempty"`
	MaxGaps  *int             `json:"max_gaps,omitempty"`
	Ordered  *bool            `json:"ordered,omitempty"`
	Query    string           `json:"query"`
	UseField *string          `json:"use_field,omitempty"`
}

IntervalsMatch type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L99-L108

func NewIntervalsMatch ¶ added in v8.5.0 

func NewIntervalsMatch() *IntervalsMatch

NewIntervalsMatch returns a IntervalsMatch.

type IntervalsPrefix ¶ 

type IntervalsPrefix struct {
	Analyzer *string `json:"analyzer,omitempty"`
	Prefix   string  `json:"prefix"`
	UseField *string `json:"use_field,omitempty"`
}

IntervalsPrefix type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L110-L114

func NewIntervalsPrefix ¶ added in v8.5.0 

func NewIntervalsPrefix() *IntervalsPrefix

NewIntervalsPrefix returns a IntervalsPrefix.

type IntervalsQuery ¶ 

type IntervalsQuery struct {
	AllOf      *IntervalsAllOf    `json:"all_of,omitempty"`
	AnyOf      *IntervalsAnyOf    `json:"any_of,omitempty"`
	Boost      *float32           `json:"boost,omitempty"`
	Fuzzy      *IntervalsFuzzy    `json:"fuzzy,omitempty"`
	Match      *IntervalsMatch    `json:"match,omitempty"`
	Prefix     *IntervalsPrefix   `json:"prefix,omitempty"`
	QueryName_ *string            `json:"_name,omitempty"`
	Wildcard   *IntervalsWildcard `json:"wildcard,omitempty"`
}

IntervalsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L116-L125

func NewIntervalsQuery ¶ added in v8.5.0 

func NewIntervalsQuery() *IntervalsQuery

NewIntervalsQuery returns a IntervalsQuery.

type IntervalsWildcard ¶ 

type IntervalsWildcard struct {
	Analyzer *string `json:"analyzer,omitempty"`
	Pattern  string  `json:"pattern"`
	UseField *string `json:"use_field,omitempty"`
}

IntervalsWildcard type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L127-L131

func NewIntervalsWildcard ¶ added in v8.5.0 

func NewIntervalsWildcard() *IntervalsWildcard

NewIntervalsWildcard returns a IntervalsWildcard.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L65-L73

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L138-L141

func NewInvocation ¶ added in v8.5.0 

func NewInvocation() *Invocation

NewInvocation returns a Invocation.

type IoStatDevice ¶ 

type IoStatDevice struct {
	DeviceName      *string `json:"device_name,omitempty"`
	Operations      *int64  `json:"operations,omitempty"`
	ReadKilobytes   *int64  `json:"read_kilobytes,omitempty"`
	ReadOperations  *int64  `json:"read_operations,omitempty"`
	WriteKilobytes  *int64  `json:"write_kilobytes,omitempty"`
	WriteOperations *int64  `json:"write_operations,omitempty"`
}

IoStatDevice type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L292-L299

func NewIoStatDevice ¶ added in v8.5.0 

func NewIoStatDevice() *IoStatDevice

NewIoStatDevice returns a IoStatDevice.

type IoStats ¶ 

type IoStats struct {
	Devices []IoStatDevice `json:"devices,omitempty"`
	Total   *IoStatDevice  `json:"total,omitempty"`
}

IoStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L287-L290

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L159-L162

func NewIpFilter ¶ added in v8.5.0 

func NewIpFilter() *IpFilter

NewIpFilter returns a IpFilter.

type IpPrefixAggregate ¶ added in v8.5.0 

type IpPrefixAggregate struct {
	Buckets BucketsIpPrefixBucket  `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

IpPrefixAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L628-L629

func NewIpPrefixAggregate ¶ added in v8.5.0 

func NewIpPrefixAggregate() *IpPrefixAggregate

NewIpPrefixAggregate returns a IpPrefixAggregate.

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 document 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"`
	Meta  map[string]interface{} `json:"meta,omitempty"`
	// MinDocCount Minimum number of documents for buckets to be included in the response.
	MinDocCount *int64  `json:"min_doc_count,omitempty"`
	Name        *string `json:"name,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L514-L543

func NewIpPrefixAggregation ¶ added in v8.5.0 

func NewIpPrefixAggregation() *IpPrefixAggregation

NewIpPrefixAggregation returns a IpPrefixAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L631-L636

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

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L59-L72

func NewIpProperty ¶ added in v8.5.0 

func NewIpProperty() *IpProperty

NewIpProperty returns a IpProperty.

type IpRangeAggregate ¶ 

type IpRangeAggregate struct {
	Buckets BucketsIpRangeBucket   `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

IpRangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L555-L557

func NewIpRangeAggregate ¶ added in v8.5.0 

func NewIpRangeAggregate() *IpRangeAggregate

NewIpRangeAggregate returns a IpRangeAggregate.

type IpRangeAggregation ¶ 

type IpRangeAggregation struct {
	Field  *string                   `json:"field,omitempty"`
	Meta   map[string]interface{}    `json:"meta,omitempty"`
	Name   *string                   `json:"name,omitempty"`
	Ranges []IpRangeAggregationRange `json:"ranges,omitempty"`
}

IpRangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L249-L252

func NewIpRangeAggregation ¶ added in v8.5.0 

func NewIpRangeAggregation() *IpRangeAggregation

NewIpRangeAggregation returns a IpRangeAggregation.

type IpRangeAggregationRange ¶ 

type IpRangeAggregationRange struct {
	From string  `json:"from,omitempty"`
	Mask *string `json:"mask,omitempty"`
	To   string  `json:"to,omitempty"`
}

IpRangeAggregationRange type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L254-L258

func NewIpRangeAggregationRange ¶ added in v8.5.0 

func NewIpRangeAggregationRange() *IpRangeAggregationRange

NewIpRangeAggregationRange returns a IpRangeAggregationRange.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L559-L563

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

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

IpRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L46-L48

func NewIpRangeProperty ¶ added in v8.5.0 

func NewIpRangeProperty() *IpRangeProperty

NewIpRangeProperty returns a IpRangeProperty.

type Job ¶ 

type Job struct {
	AllowLazyOpen                        bool             `json:"allow_lazy_open"`
	AnalysisConfig                       AnalysisConfig   `json:"analysis_config"`
	AnalysisLimits                       *AnalysisLimits  `json:"analysis_limits,omitempty"`
	BackgroundPersistInterval            *Duration        `json:"background_persist_interval,omitempty"`
	Blocked                              *JobBlocked      `json:"blocked,omitempty"`
	CreateTime                           *DateTime        `json:"create_time,omitempty"`
	CustomSettings                       interface{}      `json:"custom_settings,omitempty"`
	DailyModelSnapshotRetentionAfterDays *int64           `json:"daily_model_snapshot_retention_after_days,omitempty"`
	DataDescription                      DataDescription  `json:"data_description"`
	DatafeedConfig                       *MLDatafeed      `json:"datafeed_config,omitempty"`
	Deleting                             *bool            `json:"deleting,omitempty"`
	Description                          *string          `json:"description,omitempty"`
	FinishedTime                         *DateTime        `json:"finished_time,omitempty"`
	Groups                               []string         `json:"groups,omitempty"`
	JobId                                string           `json:"job_id"`
	JobType                              *string          `json:"job_type,omitempty"`
	JobVersion                           *string          `json:"job_version,omitempty"`
	ModelPlotConfig                      *ModelPlotConfig `json:"model_plot_config,omitempty"`
	ModelSnapshotId                      *string          `json:"model_snapshot_id,omitempty"`
	ModelSnapshotRetentionDays           int64            `json:"model_snapshot_retention_days"`
	RenormalizationWindowDays            *int64           `json:"renormalization_window_days,omitempty"`
	ResultsIndexName                     string           `json:"results_index_name"`
	ResultsRetentionDays                 *int64           `json:"results_retention_days,omitempty"`
}

Job type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L51-L75

func NewJob ¶ added in v8.5.0 

func NewJob() *Job

NewJob returns a Job.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L169-L172

func NewJobBlocked ¶ added in v8.5.0 

func NewJobBlocked() *JobBlocked

NewJobBlocked returns a JobBlocked.

type JobConfig ¶ 

type JobConfig struct {
	AllowLazyOpen                        *bool            `json:"allow_lazy_open,omitempty"`
	AnalysisConfig                       AnalysisConfig   `json:"analysis_config"`
	AnalysisLimits                       *AnalysisLimits  `json:"analysis_limits,omitempty"`
	BackgroundPersistInterval            *Duration        `json:"background_persist_interval,omitempty"`
	CustomSettings                       interface{}      `json:"custom_settings,omitempty"`
	DailyModelSnapshotRetentionAfterDays *int64           `json:"daily_model_snapshot_retention_after_days,omitempty"`
	DataDescription                      DataDescription  `json:"data_description"`
	DatafeedConfig                       *DatafeedConfig  `json:"datafeed_config,omitempty"`
	Description                          *string          `json:"description,omitempty"`
	Groups                               []string         `json:"groups,omitempty"`
	JobId                                *string          `json:"job_id,omitempty"`
	JobType                              *string          `json:"job_type,omitempty"`
	ModelPlotConfig                      *ModelPlotConfig `json:"model_plot_config,omitempty"`
	ModelSnapshotRetentionDays           *int64           `json:"model_snapshot_retention_days,omitempty"`
	RenormalizationWindowDays            *int64           `json:"renormalization_window_days,omitempty"`
	ResultsIndexName                     *string          `json:"results_index_name,omitempty"`
	ResultsRetentionDays                 *int64           `json:"results_retention_days,omitempty"`
}

JobConfig type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L77-L95

func NewJobConfig ¶ added in v8.5.0 

func NewJobConfig() *JobConfig

NewJobConfig returns a JobConfig.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L120-L127

func NewJobForecastStatistics ¶ added in v8.5.0 

func NewJobForecastStatistics() *JobForecastStatistics

NewJobForecastStatistics returns a JobForecastStatistics.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L44-L49

func NewJobStatistics ¶ added in v8.5.0 

func NewJobStatistics() *JobStatistics

NewJobStatistics returns a JobStatistics.

type JobStats ¶ 

type JobStats struct {
	AssignmentExplanation *string               `json:"assignment_explanation,omitempty"`
	DataCounts            DataCounts            `json:"data_counts"`
	Deleting              *bool                 `json:"deleting,omitempty"`
	ForecastsStats        JobForecastStatistics `json:"forecasts_stats"`
	JobId                 string                `json:"job_id"`
	ModelSizeStats        ModelSizeStats        `json:"model_size_stats"`
	Node                  *DiscoveryNode        `json:"node,omitempty"`
	OpenTime              *DateTime             `json:"open_time,omitempty"`
	State                 jobstate.JobState     `json:"state"`
	TimingStats           JobTimingStats        `json:"timing_stats"`
}

JobStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L96-L107

func NewJobStats ¶ added in v8.5.0 

func NewJobStats() *JobStats

NewJobStats returns a JobStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Job.ts#L109-L118

func NewJobTimingStats ¶ added in v8.5.0 

func NewJobTimingStats() *JobTimingStats

NewJobTimingStats returns a JobTimingStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L346-L352

func NewJobUsage ¶ added in v8.5.0 

func NewJobUsage() *JobUsage

NewJobUsage returns a JobUsage.

type JobsRecord ¶ 

type JobsRecord struct {
	// AssignmentExplanation why the job is or is not assigned to a node
	AssignmentExplanation *string `json:"assignment_explanation,omitempty"`
	// BucketsCount bucket count
	BucketsCount *string `json:"buckets.count,omitempty"`
	// BucketsTimeExpAvg exponential average bucket processing time (milliseconds)
	BucketsTimeExpAvg *string `json:"buckets.time.exp_avg,omitempty"`
	// BucketsTimeExpAvgHour exponential average bucket processing time by hour (milliseconds)
	BucketsTimeExpAvgHour *string `json:"buckets.time.exp_avg_hour,omitempty"`
	// BucketsTimeMax maximum bucket processing time
	BucketsTimeMax *string `json:"buckets.time.max,omitempty"`
	// BucketsTimeMin minimum bucket processing time
	BucketsTimeMin *string `json:"buckets.time.min,omitempty"`
	// BucketsTimeTotal total bucket processing time
	BucketsTimeTotal *string `json:"buckets.time.total,omitempty"`
	// DataBuckets total bucket count
	DataBuckets *string `json:"data.buckets,omitempty"`
	// DataEarliestRecord earliest record time
	DataEarliestRecord *string `json:"data.earliest_record,omitempty"`
	// DataEmptyBuckets number of empty buckets
	DataEmptyBuckets *string `json:"data.empty_buckets,omitempty"`
	// DataInputBytes total input bytes
	DataInputBytes *ByteSize `json:"data.input_bytes,omitempty"`
	// DataInputFields total field count
	DataInputFields *string `json:"data.input_fields,omitempty"`
	// DataInputRecords total record count
	DataInputRecords *string `json:"data.input_records,omitempty"`
	// DataInvalidDates number of records with invalid dates
	DataInvalidDates *string `json:"data.invalid_dates,omitempty"`
	// DataLast last time data was seen
	DataLast *string `json:"data.last,omitempty"`
	// DataLastEmptyBucket last time an empty bucket occurred
	DataLastEmptyBucket *string `json:"data.last_empty_bucket,omitempty"`
	// DataLastSparseBucket last time a sparse bucket occurred
	DataLastSparseBucket *string `json:"data.last_sparse_bucket,omitempty"`
	// DataLatestRecord latest record time
	DataLatestRecord *string `json:"data.latest_record,omitempty"`
	// DataMissingFields number of records with missing fields
	DataMissingFields *string `json:"data.missing_fields,omitempty"`
	// DataOutOfOrderTimestamps number of records handled out of order
	DataOutOfOrderTimestamps *string `json:"data.out_of_order_timestamps,omitempty"`
	// DataProcessedFields number of processed fields
	DataProcessedFields *string `json:"data.processed_fields,omitempty"`
	// DataProcessedRecords number of processed records
	DataProcessedRecords *string `json:"data.processed_records,omitempty"`
	// DataSparseBuckets number of sparse buckets
	DataSparseBuckets *string `json:"data.sparse_buckets,omitempty"`
	// ForecastsMemoryAvg average memory used by forecasts
	ForecastsMemoryAvg *string `json:"forecasts.memory.avg,omitempty"`
	// ForecastsMemoryMax maximum memory used by forecasts
	ForecastsMemoryMax *string `json:"forecasts.memory.max,omitempty"`
	// ForecastsMemoryMin minimum memory used by forecasts
	ForecastsMemoryMin *string `json:"forecasts.memory.min,omitempty"`
	// ForecastsMemoryTotal total memory used by all forecasts
	ForecastsMemoryTotal *string `json:"forecasts.memory.total,omitempty"`
	// ForecastsRecordsAvg average record count for forecasts
	ForecastsRecordsAvg *string `json:"forecasts.records.avg,omitempty"`
	// ForecastsRecordsMax maximum record count for forecasts
	ForecastsRecordsMax *string `json:"forecasts.records.max,omitempty"`
	// ForecastsRecordsMin minimum record count for forecasts
	ForecastsRecordsMin *string `json:"forecasts.records.min,omitempty"`
	// ForecastsRecordsTotal total record count for all forecasts
	ForecastsRecordsTotal *string `json:"forecasts.records.total,omitempty"`
	// ForecastsTimeAvg average runtime for all forecasts (milliseconds)
	ForecastsTimeAvg *string `json:"forecasts.time.avg,omitempty"`
	// ForecastsTimeMax maximum run time for forecasts
	ForecastsTimeMax *string `json:"forecasts.time.max,omitempty"`
	// ForecastsTimeMin minimum runtime for forecasts
	ForecastsTimeMin *string `json:"forecasts.time.min,omitempty"`
	// ForecastsTimeTotal total runtime for all forecasts
	ForecastsTimeTotal *string `json:"forecasts.time.total,omitempty"`
	// ForecastsTotal total number of forecasts
	ForecastsTotal *string `json:"forecasts.total,omitempty"`
	// Id the job_id
	Id *string `json:"id,omitempty"`
	// ModelBucketAllocationFailures number of bucket allocation failures
	ModelBucketAllocationFailures *string `json:"model.bucket_allocation_failures,omitempty"`
	// ModelByFields count of 'by' fields
	ModelByFields *string `json:"model.by_fields,omitempty"`
	// ModelBytes model size
	ModelBytes *ByteSize `json:"model.bytes,omitempty"`
	// ModelBytesExceeded how much the model has exceeded the limit
	ModelBytesExceeded *ByteSize `json:"model.bytes_exceeded,omitempty"`
	// ModelCategorizationStatus current categorization status
	ModelCategorizationStatus *categorizationstatus.CategorizationStatus `json:"model.categorization_status,omitempty"`
	// ModelCategorizedDocCount count of categorized documents
	ModelCategorizedDocCount *string `json:"model.categorized_doc_count,omitempty"`
	// ModelDeadCategoryCount count of dead categories
	ModelDeadCategoryCount *string `json:"model.dead_category_count,omitempty"`
	// ModelFailedCategoryCount count of failed categories
	ModelFailedCategoryCount *string `json:"model.failed_category_count,omitempty"`
	// ModelFrequentCategoryCount count of frequent categories
	ModelFrequentCategoryCount *string `json:"model.frequent_category_count,omitempty"`
	// ModelLogTime when the model stats were gathered
	ModelLogTime *string `json:"model.log_time,omitempty"`
	// ModelMemoryLimit model memory limit
	ModelMemoryLimit *string `json:"model.memory_limit,omitempty"`
	// ModelMemoryStatus current memory status
	ModelMemoryStatus *memorystatus.MemoryStatus `json:"model.memory_status,omitempty"`
	// ModelOverFields count of 'over' fields
	ModelOverFields *string `json:"model.over_fields,omitempty"`
	// ModelPartitionFields count of 'partition' fields
	ModelPartitionFields *string `json:"model.partition_fields,omitempty"`
	// ModelRareCategoryCount count of rare categories
	ModelRareCategoryCount *string `json:"model.rare_category_count,omitempty"`
	// ModelTimestamp the time of the last record when the model stats were gathered
	ModelTimestamp *string `json:"model.timestamp,omitempty"`
	// ModelTotalCategoryCount count of categories
	ModelTotalCategoryCount *string `json:"model.total_category_count,omitempty"`
	// NodeAddress network address of the assigned node
	NodeAddress *string `json:"node.address,omitempty"`
	// NodeEphemeralId ephemeral id of the assigned node
	NodeEphemeralId *string `json:"node.ephemeral_id,omitempty"`
	// NodeId id of the assigned node
	NodeId *string `json:"node.id,omitempty"`
	// NodeName name of the assigned node
	NodeName *string `json:"node.name,omitempty"`
	// OpenedTime the amount of time the job has been opened
	OpenedTime *string `json:"opened_time,omitempty"`
	// State the job state
	State *jobstate.JobState `json:"state,omitempty"`
}

JobsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/ml_jobs/types.ts#L24-L325

func NewJobsRecord ¶ added in v8.5.0 

func NewJobsRecord() *JobsRecord

NewJobsRecord returns a JobsRecord.

type JoinProcessor ¶ 

type JoinProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Separator     string               `json:"separator"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

JoinProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L265-L269

func NewJoinProcessor ¶ added in v8.5.0 

func NewJoinProcessor() *JoinProcessor

NewJoinProcessor returns a JoinProcessor.

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"`
	Type       string              `json:"type,omitempty"`
}

JoinProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L83-L87

func NewJoinProperty ¶ added in v8.5.0 

func NewJoinProperty() *JoinProperty

NewJoinProperty returns a JoinProperty.

type JsonProcessor ¶ 

type JsonProcessor struct {
	AddToRoot                 *bool                                                        `json:"add_to_root,omitempty"`
	AddToRootConflictStrategy *jsonprocessorconflictstrategy.JsonProcessorConflictStrategy `json:"add_to_root_conflict_strategy,omitempty"`
	AllowDuplicateKeys        *bool                                                        `json:"allow_duplicate_keys,omitempty"`
	Description               *string                                                      `json:"description,omitempty"`
	Field                     string                                                       `json:"field"`
	If                        *string                                                      `json:"if,omitempty"`
	IgnoreFailure             *bool                                                        `json:"ignore_failure,omitempty"`
	OnFailure                 []ProcessorContainer                                         `json:"on_failure,omitempty"`
	Tag                       *string                                                      `json:"tag,omitempty"`
	TargetField               *string                                                      `json:"target_field,omitempty"`
}

JsonProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L271-L277

func NewJsonProcessor ¶ added in v8.5.0 

func NewJsonProcessor() *JsonProcessor

NewJsonProcessor returns a JsonProcessor.

type Jvm ¶ 

type Jvm struct {
	BufferPools    map[string]NodeBufferPool `json:"buffer_pools,omitempty"`
	Classes        *JvmClasses               `json:"classes,omitempty"`
	Gc             *GarbageCollector         `json:"gc,omitempty"`
	Mem            *JvmMemoryStats           `json:"mem,omitempty"`
	Threads        *JvmThreads               `json:"threads,omitempty"`
	Timestamp      *int64                    `json:"timestamp,omitempty"`
	Uptime         *string                   `json:"uptime,omitempty"`
	UptimeInMillis *int64                    `json:"uptime_in_millis,omitempty"`
}

Jvm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L318-L327

func NewJvm ¶ added in v8.5.0 

func NewJvm() *Jvm

NewJvm returns a Jvm.

type JvmClasses ¶ 

type JvmClasses struct {
	CurrentLoadedCount *int64 `json:"current_loaded_count,omitempty"`
	TotalLoadedCount   *int64 `json:"total_loaded_count,omitempty"`
	TotalUnloadedCount *int64 `json:"total_unloaded_count,omitempty"`
}

JvmClasses type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L351-L355

func NewJvmClasses ¶ added in v8.5.0 

func NewJvmClasses() *JvmClasses

NewJvmClasses returns a JvmClasses.

type JvmMemoryStats ¶ 

type JvmMemoryStats struct {
	HeapCommittedInBytes    *int64          `json:"heap_committed_in_bytes,omitempty"`
	HeapMaxInBytes          *int64          `json:"heap_max_in_bytes,omitempty"`
	HeapUsedInBytes         *int64          `json:"heap_used_in_bytes,omitempty"`
	HeapUsedPercent         *int64          `json:"heap_used_percent,omitempty"`
	NonHeapCommittedInBytes *int64          `json:"non_heap_committed_in_bytes,omitempty"`
	NonHeapUsedInBytes      *int64          `json:"non_heap_used_in_bytes,omitempty"`
	Pools                   map[string]Pool `json:"pools,omitempty"`
}

JvmMemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L329-L337

func NewJvmMemoryStats ¶ added in v8.5.0 

func NewJvmMemoryStats() *JvmMemoryStats

NewJvmMemoryStats returns a JvmMemoryStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/get_memory_stats/types.ts#L50-L63

func NewJvmStats ¶ added in v8.5.0 

func NewJvmStats() *JvmStats

NewJvmStats returns a JvmStats.

type JvmThreads ¶ 

type JvmThreads struct {
	Count     *int64 `json:"count,omitempty"`
	PeakCount *int64 `json:"peak_count,omitempty"`
}

JvmThreads type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L346-L349

func NewJvmThreads ¶ added in v8.5.0 

func NewJvmThreads() *JvmThreads

NewJvmThreads returns a JvmThreads.

type KStemTokenFilter ¶ 

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

KStemTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L238-L240

func NewKStemTokenFilter ¶ added in v8.5.0 

func NewKStemTokenFilter() *KStemTokenFilter

NewKStemTokenFilter returns a KStemTokenFilter.

type KeepTypesTokenFilter ¶ 

type KeepTypesTokenFilter struct {
	Mode    *keeptypesmode.KeepTypesMode `json:"mode,omitempty"`
	Type    string                       `json:"type,omitempty"`
	Types   []string                     `json:"types,omitempty"`
	Version *string                      `json:"version,omitempty"`
}

KeepTypesTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L217-L221

func NewKeepTypesTokenFilter ¶ added in v8.5.0 

func NewKeepTypesTokenFilter() *KeepTypesTokenFilter

NewKeepTypesTokenFilter returns a KeepTypesTokenFilter.

type KeepWordsTokenFilter ¶ 

type KeepWordsTokenFilter struct {
	KeepWords     []string `json:"keep_words,omitempty"`
	KeepWordsCase *bool    `json:"keep_words_case,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L223-L228

func NewKeepWordsTokenFilter ¶ added in v8.5.0 

func NewKeepWordsTokenFilter() *KeepWordsTokenFilter

NewKeepWordsTokenFilter returns a KeepWordsTokenFilter.

type KeyValueProcessor ¶ 

type KeyValueProcessor struct {
	Description   *string              `json:"description,omitempty"`
	ExcludeKeys   []string             `json:"exclude_keys,omitempty"`
	Field         string               `json:"field"`
	FieldSplit    string               `json:"field_split"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	IncludeKeys   []string             `json:"include_keys,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Prefix        *string              `json:"prefix,omitempty"`
	StripBrackets *bool                `json:"strip_brackets,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
	TrimKey       *string              `json:"trim_key,omitempty"`
	TrimValue     *string              `json:"trim_value,omitempty"`
	ValueSplit    string               `json:"value_split"`
}

KeyValueProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L286-L298

func NewKeyValueProcessor ¶ added in v8.5.0 

func NewKeyValueProcessor() *KeyValueProcessor

NewKeyValueProcessor returns a KeyValueProcessor.

type KeyedPercentiles ¶ 

type KeyedPercentiles map[string]string

KeyedPercentiles type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L157-L157

type KeyedProcessor ¶ 

type KeyedProcessor struct {
	Stats *Processor `json:"stats,omitempty"`
	Type  *string    `json:"type,omitempty"`
}

KeyedProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L151-L154

func NewKeyedProcessor ¶ added in v8.5.0 

func NewKeyedProcessor() *KeyedProcessor

NewKeyedProcessor returns a KeyedProcessor.

type KeywordAnalyzer ¶ 

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

KeywordAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L47-L50

func NewKeywordAnalyzer ¶ added in v8.5.0 

func NewKeywordAnalyzer() *KeywordAnalyzer

NewKeywordAnalyzer returns a KeywordAnalyzer.

type KeywordMarkerTokenFilter ¶ 

type KeywordMarkerTokenFilter struct {
	IgnoreCase      *bool    `json:"ignore_case,omitempty"`
	Keywords        []string `json:"keywords,omitempty"`
	KeywordsPath    *string  `json:"keywords_path,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L230-L236

func NewKeywordMarkerTokenFilter ¶ added in v8.5.0 

func NewKeywordMarkerTokenFilter() *KeywordMarkerTokenFilter

NewKeywordMarkerTokenFilter returns a KeywordMarkerTokenFilter.

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"`
	Properties               map[string]Property `json:"properties,omitempty"`
	Similarity               *string             `json:"similarity,omitempty"`
	SplitQueriesOnWhitespace *bool               `json:"split_queries_on_whitespace,omitempty"`
	Store                    *bool               `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L89-L104

func NewKeywordProperty ¶ added in v8.5.0 

func NewKeywordProperty() *KeywordProperty

NewKeywordProperty returns a KeywordProperty.

type KeywordTokenizer ¶ 

type KeywordTokenizer struct {
	BufferSize int     `json:"buffer_size"`
	Type       string  `json:"type,omitempty"`
	Version    *string `json:"version,omitempty"`
}

KeywordTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L61-L64

func NewKeywordTokenizer ¶ added in v8.5.0 

func NewKeywordTokenizer() *KeywordTokenizer

NewKeywordTokenizer returns a KeywordTokenizer.

type KibanaToken ¶ added in v8.5.0 

type KibanaToken struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

KibanaToken type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/enroll_kibana/Response.ts#L27-L30

func NewKibanaToken ¶ added in v8.5.0 

func NewKibanaToken() *KibanaToken

NewKibanaToken returns a KibanaToken.

type KnnQuery ¶ 

type KnnQuery 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"`
	// K The final number of nearest neighbors to return as top hits
	K int64 `json:"k"`
	// NumCandidates The number of nearest neighbor candidates to consider per shard
	NumCandidates int64 `json:"num_candidates"`
	// QueryVector The query vector
	QueryVector []float64 `json:"query_vector"`
}

KnnQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Knn.ts#L24-L37

func NewKnnQuery ¶ added in v8.5.0 

func NewKnnQuery() *KnnQuery

NewKnnQuery returns a KnnQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L25-L29

func NewKuromojiAnalyzer ¶ added in v8.5.0 

func NewKuromojiAnalyzer() *KuromojiAnalyzer

NewKuromojiAnalyzer returns a KuromojiAnalyzer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L31-L35

func NewKuromojiIterationMarkCharFilter ¶ added in v8.5.0 

func NewKuromojiIterationMarkCharFilter() *KuromojiIterationMarkCharFilter

NewKuromojiIterationMarkCharFilter returns a KuromojiIterationMarkCharFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L37-L40

func NewKuromojiPartOfSpeechTokenFilter ¶ added in v8.5.0 

func NewKuromojiPartOfSpeechTokenFilter() *KuromojiPartOfSpeechTokenFilter

NewKuromojiPartOfSpeechTokenFilter returns a KuromojiPartOfSpeechTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L42-L45

func NewKuromojiReadingFormTokenFilter ¶ added in v8.5.0 

func NewKuromojiReadingFormTokenFilter() *KuromojiReadingFormTokenFilter

NewKuromojiReadingFormTokenFilter returns a KuromojiReadingFormTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L47-L50

func NewKuromojiStemmerTokenFilter ¶ added in v8.5.0 

func NewKuromojiStemmerTokenFilter() *KuromojiStemmerTokenFilter

NewKuromojiStemmerTokenFilter returns a KuromojiStemmerTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/kuromoji-plugin.ts#L58-L67

func NewKuromojiTokenizer ¶ added in v8.5.0 

func NewKuromojiTokenizer() *KuromojiTokenizer

NewKuromojiTokenizer returns a KuromojiTokenizer.

type LanguageAnalyzer ¶ 

type LanguageAnalyzer struct {
	Language      language.Language `json:"language"`
	StemExclusion []string          `json:"stem_exclusion"`
	Stopwords     []string          `json:"stopwords,omitempty"`
	StopwordsPath *string           `json:"stopwords_path,omitempty"`
	Type          string            `json:"type,omitempty"`
	Version       *string           `json:"version,omitempty"`
}

LanguageAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L52-L59

func NewLanguageAnalyzer ¶ added in v8.5.0 

func NewLanguageAnalyzer() *LanguageAnalyzer

NewLanguageAnalyzer returns a LanguageAnalyzer.

type LanguageContext ¶ 

type LanguageContext struct {
	Contexts []string                      `json:"contexts"`
	Language scriptlanguage.ScriptLanguage `json:"language"`
}

LanguageContext type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 float64 `json:"alpha"`
}

LaplaceSmoothingModel type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L212-L214

func NewLaplaceSmoothingModel ¶ added in v8.5.0 

func NewLaplaceSmoothingModel() *LaplaceSmoothingModel

NewLaplaceSmoothingModel returns a LaplaceSmoothingModel.

type LatLonGeoLocation ¶ 

type LatLonGeoLocation struct {
	Lat float64 `json:"lat"`
	Lon float64 `json:"lon"`
}

LatLonGeoLocation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L110-L113

func NewLatLonGeoLocation ¶ added in v8.5.0 

func NewLatLonGeoLocation() *LatLonGeoLocation

NewLatLonGeoLocation returns a LatLonGeoLocation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L47-L52

func NewLatest ¶ added in v8.5.0 

func NewLatest() *Latest

NewLatest returns a Latest.

type LengthTokenFilter ¶ 

type LengthTokenFilter struct {
	Max     *int    `json:"max,omitempty"`
	Min     *int    `json:"min,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

LengthTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L242-L246

func NewLengthTokenFilter ¶ added in v8.5.0 

func NewLengthTokenFilter() *LengthTokenFilter

NewLengthTokenFilter returns a LengthTokenFilter.

type LetterTokenizer ¶ 

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

LetterTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L66-L68

func NewLetterTokenizer ¶ added in v8.5.0 

func NewLetterTokenizer() *LetterTokenizer

NewLetterTokenizer returns a LetterTokenizer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/license/_types/License.ts#L42-L53

func NewLicense ¶ added in v8.5.0 

func NewLicense() *License

NewLicense returns a License.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/license/get/types.ts#L25-L38

func NewLicenseInformation ¶ added in v8.5.0 

func NewLicenseInformation() *LicenseInformation

NewLicenseInformation returns a LicenseInformation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/get_lifecycle/types.ts#L24-L28

func NewLifecycle ¶ added in v8.5.0 

func NewLifecycle() *Lifecycle

NewLifecycle returns a Lifecycle.

type LifecycleExplain ¶ 

type LifecycleExplain interface {
	// contains filtered or unexported methods
}

LifecycleExplain holds the union for the following types: 

LifecycleExplainManaged
LifecycleExplainUnmanaged

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/explain_lifecycle/types.ts#L59-L62

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,omitempty"`
	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                 string                          `json:"managed,omitempty"`
	Phase                   string                          `json:"phase"`
	PhaseExecution          *LifecycleExplainPhaseExecution `json:"phase_execution,omitempty"`
	PhaseTime               *DateTime                       `json:"phase_time,omitempty"`
	PhaseTimeMillis         *int64                          `json:"phase_time_millis,omitempty"`
	Policy                  string                          `json:"policy"`
	Step                    *string                         `json:"step,omitempty"`
	StepInfo                map[string]interface{}          `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/explain_lifecycle/types.ts#L26-L52

func NewLifecycleExplainManaged ¶ added in v8.5.0 

func NewLifecycleExplainManaged() *LifecycleExplainManaged

NewLifecycleExplainManaged returns a LifecycleExplainManaged.

type LifecycleExplainPhaseExecution ¶ 

type LifecycleExplainPhaseExecution struct {
	ModifiedDateInMillis int64  `json:"modified_date_in_millis"`
	Policy               string `json:"policy"`
	Version              int64  `json:"version"`
}

LifecycleExplainPhaseExecution type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/explain_lifecycle/types.ts#L64-L68

func NewLifecycleExplainPhaseExecution ¶ added in v8.5.0 

func NewLifecycleExplainPhaseExecution() *LifecycleExplainPhaseExecution

NewLifecycleExplainPhaseExecution returns a LifecycleExplainPhaseExecution.

type LifecycleExplainUnmanaged ¶ 

type LifecycleExplainUnmanaged struct {
	Index   string `json:"index"`
	Managed string `json:"managed,omitempty"`
}

LifecycleExplainUnmanaged type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/explain_lifecycle/types.ts#L54-L57

func NewLifecycleExplainUnmanaged ¶ added in v8.5.0 

func NewLifecycleExplainUnmanaged() *LifecycleExplainUnmanaged

NewLifecycleExplainUnmanaged returns a LifecycleExplainUnmanaged.

type Like ¶ 

type Like interface{}

Like holds the union for the following types: 

string
LikeDocument

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L103-L108

type LikeDocument ¶ 

type LikeDocument struct {
	Doc              interface{}              `json:"doc,omitempty"`
	Fields           []string                 `json:"fields,omitempty"`
	Id_              *string                  `json:"_id,omitempty"`
	Index_           *string                  `json:"_index,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L91-L101

func NewLikeDocument ¶ added in v8.5.0 

func NewLikeDocument() *LikeDocument

NewLikeDocument returns a LikeDocument.

type LimitTokenCountTokenFilter ¶ 

type LimitTokenCountTokenFilter struct {
	ConsumeAllTokens *bool   `json:"consume_all_tokens,omitempty"`
	MaxTokenCount    *int    `json:"max_token_count,omitempty"`
	Type             string  `json:"type,omitempty"`
	Version          *string `json:"version,omitempty"`
}

LimitTokenCountTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L248-L252

func NewLimitTokenCountTokenFilter ¶ added in v8.5.0 

func NewLimitTokenCountTokenFilter() *LimitTokenCountTokenFilter

NewLimitTokenCountTokenFilter returns a LimitTokenCountTokenFilter.

type Limits ¶ 

type Limits struct {
	EffectiveMaxModelMemoryLimit string  `json:"effective_max_model_memory_limit"`
	MaxModelMemoryLimit          *string `json:"max_model_memory_limit,omitempty"`
	TotalMlMemory                string  `json:"total_ml_memory"`
}

Limits type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/info/types.ts#L34-L38

func NewLimits ¶ added in v8.5.0 

func NewLimits() *Limits

NewLimits returns a Limits.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L216-L220

func NewLinearInterpolationSmoothingModel ¶ added in v8.5.0 

func NewLinearInterpolationSmoothingModel() *LinearInterpolationSmoothingModel

NewLinearInterpolationSmoothingModel returns a LinearInterpolationSmoothingModel.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Minimize    *bool                  `json:"minimize,omitempty"`
	Model       string                 `json:"model,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Predict     *int                   `json:"predict,omitempty"`
	Settings    EmptyObject            `json:"settings"`
	Window      *int                   `json:"window,omitempty"`
}

LinearMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L202-L205

func NewLinearMovingAverageAggregation ¶ added in v8.5.0 

func NewLinearMovingAverageAggregation() *LinearMovingAverageAggregation

NewLinearMovingAverageAggregation returns a LinearMovingAverageAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L281-L285

func NewLoggingAction ¶ added in v8.5.0 

func NewLoggingAction() *LoggingAction

NewLoggingAction returns a LoggingAction.

type LoggingResult ¶ 

type LoggingResult struct {
	LoggedText string `json:"logged_text"`
}

LoggingResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L287-L289

func NewLoggingResult ¶ added in v8.5.0 

func NewLoggingResult() *LoggingResult

NewLoggingResult returns a LoggingResult.

type LogstashPipeline ¶ added in v8.5.0 

type LogstashPipeline struct {
	Description      string           `json:"description"`
	LastModified     DateTime         `json:"last_modified"`
	Pipeline         string           `json:"pipeline"`
	PipelineMetadata PipelineMetadata `json:"pipeline_metadata"`
	PipelineSettings PipelineSettings `json:"pipeline_settings"`
	Username         string           `json:"username"`
}

LogstashPipeline type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/logstash/_types/Pipeline.ts#L37-L44

func NewLogstashPipeline ¶ added in v8.5.0 

func NewLogstashPipeline() *LogstashPipeline

NewLogstashPipeline returns a LogstashPipeline.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L151-L154

func NewLongNumberProperty ¶ added in v8.5.0 

func NewLongNumberProperty() *LongNumberProperty

NewLongNumberProperty returns a LongNumberProperty.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

LongRangeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/range.ts#L50-L52

func NewLongRangeProperty ¶ added in v8.5.0 

func NewLongRangeProperty() *LongRangeProperty

NewLongRangeProperty returns a LongRangeProperty.

type LongRareTermsAggregate ¶ 

type LongRareTermsAggregate struct {
	Buckets BucketsLongRareTermsBucket `json:"buckets"`
	Meta    map[string]interface{}     `json:"meta,omitempty"`
}

LongRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L430-L435

func NewLongRareTermsAggregate ¶ added in v8.5.0 

func NewLongRareTermsAggregate() *LongRareTermsAggregate

NewLongRareTermsAggregate returns a LongRareTermsAggregate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L437-L440

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

type LongTermsAggregate ¶ 

type LongTermsAggregate struct {
	Buckets                 BucketsLongTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{} `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

LongTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L398-L403

func NewLongTermsAggregate ¶ added in v8.5.0 

func NewLongTermsAggregate() *LongTermsAggregate

NewLongTermsAggregate returns a LongTermsAggregate.

type LongTermsBucket ¶ 

type LongTermsBucket struct {
	Aggregations  map[string]Aggregate `json:"-"`
	DocCount      int64                `json:"doc_count"`
	DocCountError *int64               `json:"doc_count_error,omitempty"`
	Key           int64                `json:"key"`
	KeyAsString   *string              `json:"key_as_string,omitempty"`
}

LongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L405-L408

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

type LowercaseNormalizer ¶ 

type LowercaseNormalizer struct {
	Type string `json:"type,omitempty"`
}

LowercaseNormalizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/normalizers.ts#L26-L28

func NewLowercaseNormalizer ¶ added in v8.5.0 

func NewLowercaseNormalizer() *LowercaseNormalizer

NewLowercaseNormalizer returns a LowercaseNormalizer.

type LowercaseProcessor ¶ 

type LowercaseProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

LowercaseProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L300-L304

func NewLowercaseProcessor ¶ added in v8.5.0 

func NewLowercaseProcessor() *LowercaseProcessor

NewLowercaseProcessor returns a LowercaseProcessor.

type LowercaseTokenFilter ¶ 

type LowercaseTokenFilter struct {
	Language *string `json:"language,omitempty"`
	Type     string  `json:"type,omitempty"`
	Version  *string `json:"version,omitempty"`
}

LowercaseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L254-L257

func NewLowercaseTokenFilter ¶ added in v8.5.0 

func NewLowercaseTokenFilter() *LowercaseTokenFilter

NewLowercaseTokenFilter returns a LowercaseTokenFilter.

type LowercaseTokenizer ¶ 

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

LowercaseTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L70-L72

func NewLowercaseTokenizer ¶ added in v8.5.0 

func NewLowercaseTokenizer() *LowercaseTokenizer

NewLowercaseTokenizer returns a LowercaseTokenizer.

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        map[string]RuntimeField `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L37-L58

func NewMLDatafeed ¶ added in v8.5.0 

func NewMLDatafeed() *MLDatafeed

NewMLDatafeed returns a MLDatafeed.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Filter.ts#L22-L29

func NewMLFilter ¶ added in v8.5.0 

func NewMLFilter() *MLFilter

NewMLFilter returns a MLFilter.

type MTermVectorsOperation ¶ added in v8.5.0 

type MTermVectorsOperation struct {
	Doc             interface{}              `json:"doc,omitempty"`
	FieldStatistics *bool                    `json:"field_statistics,omitempty"`
	Fields          []string                 `json:"fields,omitempty"`
	Filter          *TermVectorsFilter       `json:"filter,omitempty"`
	Id_             string                   `json:"_id"`
	Index_          *string                  `json:"_index,omitempty"`
	Offsets         *bool                    `json:"offsets,omitempty"`
	Payloads        *bool                    `json:"payloads,omitempty"`
	Positions       *bool                    `json:"positions,omitempty"`
	Routing         *string                  `json:"routing,omitempty"`
	TermStatistics  *bool                    `json:"term_statistics,omitempty"`
	Version         *int64                   `json:"version,omitempty"`
	VersionType     *versiontype.VersionType `json:"version_type,omitempty"`
}

MTermVectorsOperation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/mtermvectors/types.ts#L35-L49

func NewMTermVectorsOperation ¶ added in v8.5.0 

func NewMTermVectorsOperation() *MTermVectorsOperation

NewMTermVectorsOperation returns a MTermVectorsOperation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L354-L361

func NewMachineLearning ¶ added in v8.5.0 

func NewMachineLearning() *MachineLearning

NewMachineLearning returns a MachineLearning.

type ManageUserPrivileges ¶ 

type ManageUserPrivileges struct {
	Applications []string `json:"applications"`
}

ManageUserPrivileges type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L195-L197

func NewManageUserPrivileges ¶ added in v8.5.0 

func NewManageUserPrivileges() *ManageUserPrivileges

NewManageUserPrivileges returns a ManageUserPrivileges.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/char_filters.ts#L47-L51

func NewMappingCharFilter ¶ added in v8.5.0 

func NewMappingCharFilter() *MappingCharFilter

NewMappingCharFilter returns a MappingCharFilter.

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 *bool                                `json:"ignore_malformed,omitempty"`
	NestedFields    *MappingLimitSettingsNestedFields    `json:"nested_fields,omitempty"`
	NestedObjects   *MappingLimitSettingsNestedObjects   `json:"nested_objects,omitempty"`
	TotalFields     *MappingLimitSettingsTotalFields     `json:"total_fields,omitempty"`
}

MappingLimitSettings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L402-L415

func NewMappingLimitSettings ¶ added in v8.5.0 

func NewMappingLimitSettings() *MappingLimitSettings

NewMappingLimitSettings returns a MappingLimitSettings.

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 *int `json:"limit,omitempty"`
}

MappingLimitSettingsDepth type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L427-L434

func NewMappingLimitSettingsDepth ¶ added in v8.5.0 

func NewMappingLimitSettingsDepth() *MappingLimitSettingsDepth

NewMappingLimitSettingsDepth returns a MappingLimitSettingsDepth.

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
	// apply best effort to fix any issues, but features in technical preview are
	// not subject to the support SLA of official GA features.
	Limit *int `json:"limit,omitempty"`
}

MappingLimitSettingsDimensionFields type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L464-L470

func NewMappingLimitSettingsDimensionFields ¶ added in v8.5.0 

func NewMappingLimitSettingsDimensionFields() *MappingLimitSettingsDimensionFields

NewMappingLimitSettingsDimensionFields returns a MappingLimitSettingsDimensionFields.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L455-L462

func NewMappingLimitSettingsFieldNameLength ¶ added in v8.5.0 

func NewMappingLimitSettingsFieldNameLength() *MappingLimitSettingsFieldNameLength

NewMappingLimitSettingsFieldNameLength returns a MappingLimitSettingsFieldNameLength.

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 *int `json:"limit,omitempty"`
}

MappingLimitSettingsNestedFields type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L436-L444

func NewMappingLimitSettingsNestedFields ¶ added in v8.5.0 

func NewMappingLimitSettingsNestedFields() *MappingLimitSettingsNestedFields

NewMappingLimitSettingsNestedFields returns a MappingLimitSettingsNestedFields.

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 *int `json:"limit,omitempty"`
}

MappingLimitSettingsNestedObjects type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L446-L453

func NewMappingLimitSettingsNestedObjects ¶ added in v8.5.0 

func NewMappingLimitSettingsNestedObjects() *MappingLimitSettingsNestedObjects

NewMappingLimitSettingsNestedObjects returns a MappingLimitSettingsNestedObjects.

type MappingLimitSettingsTotalFields ¶ 

type MappingLimitSettingsTotalFields struct {
	// 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 *int `json:"limit,omitempty"`
}

MappingLimitSettingsTotalFields type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L417-L425

func NewMappingLimitSettingsTotalFields ¶ added in v8.5.0 

func NewMappingLimitSettingsTotalFields() *MappingLimitSettingsTotalFields

NewMappingLimitSettingsTotalFields returns a MappingLimitSettingsTotalFields.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/master/types.ts#L20-L39

func NewMasterRecord ¶ added in v8.5.0 

func NewMasterRecord() *MasterRecord

NewMasterRecord returns a MasterRecord.

type MatchAllQuery ¶ 

type MatchAllQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

MatchAllQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/MatchAllQuery.ts#L22-L22

func NewMatchAllQuery ¶ added in v8.5.0 

func NewMatchAllQuery() *MatchAllQuery

NewMatchAllQuery returns a MatchAllQuery.

type MatchBoolPrefixQuery ¶ 

type MatchBoolPrefixQuery struct {
	Analyzer            *string             `json:"analyzer,omitempty"`
	Boost               *float32            `json:"boost,omitempty"`
	Fuzziness           *Fuzziness          `json:"fuzziness,omitempty"`
	FuzzyRewrite        *string             `json:"fuzzy_rewrite,omitempty"`
	FuzzyTranspositions *bool               `json:"fuzzy_transpositions,omitempty"`
	MaxExpansions       *int                `json:"max_expansions,omitempty"`
	MinimumShouldMatch  *MinimumShouldMatch `json:"minimum_should_match,omitempty"`
	Operator            *operator.Operator  `json:"operator,omitempty"`
	PrefixLength        *int                `json:"prefix_length,omitempty"`
	Query               string              `json:"query"`
	QueryName_          *string             `json:"_name,omitempty"`
}

MatchBoolPrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L160-L171

func NewMatchBoolPrefixQuery ¶ added in v8.5.0 

func NewMatchBoolPrefixQuery() *MatchBoolPrefixQuery

NewMatchBoolPrefixQuery returns a MatchBoolPrefixQuery.

type MatchNoneQuery ¶ 

type MatchNoneQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
}

MatchNoneQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/MatchNoneQuery.ts#L22-L22

func NewMatchNoneQuery ¶ added in v8.5.0 

func NewMatchNoneQuery() *MatchNoneQuery

NewMatchNoneQuery returns a MatchNoneQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L208-L233

func NewMatchOnlyTextProperty ¶ added in v8.5.0 

func NewMatchOnlyTextProperty() *MatchOnlyTextProperty

NewMatchOnlyTextProperty returns a MatchOnlyTextProperty.

type MatchPhrasePrefixQuery ¶ 

type MatchPhrasePrefixQuery struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	Boost          *float32                       `json:"boost,omitempty"`
	MaxExpansions  *int                           `json:"max_expansions,omitempty"`
	Query          string                         `json:"query"`
	QueryName_     *string                        `json:"_name,omitempty"`
	Slop           *int                           `json:"slop,omitempty"`
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchPhrasePrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L182-L189

func NewMatchPhrasePrefixQuery ¶ added in v8.5.0 

func NewMatchPhrasePrefixQuery() *MatchPhrasePrefixQuery

NewMatchPhrasePrefixQuery returns a MatchPhrasePrefixQuery.

type MatchPhraseQuery ¶ 

type MatchPhraseQuery struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	Boost          *float32                       `json:"boost,omitempty"`
	Query          string                         `json:"query"`
	QueryName_     *string                        `json:"_name,omitempty"`
	Slop           *int                           `json:"slop,omitempty"`
	ZeroTermsQuery *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchPhraseQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L173-L180

func NewMatchPhraseQuery ¶ added in v8.5.0 

func NewMatchPhraseQuery() *MatchPhraseQuery

NewMatchPhraseQuery returns a MatchPhraseQuery.

type MatchQuery ¶ 

type MatchQuery struct {
	Analyzer                        *string                        `json:"analyzer,omitempty"`
	AutoGenerateSynonymsPhraseQuery *bool                          `json:"auto_generate_synonyms_phrase_query,omitempty"`
	Boost                           *float32                       `json:"boost,omitempty"`
	CutoffFrequency                 *float64                       `json:"cutoff_frequency,omitempty"`
	Fuzziness                       *Fuzziness                     `json:"fuzziness,omitempty"`
	FuzzyRewrite                    *string                        `json:"fuzzy_rewrite,omitempty"`
	FuzzyTranspositions             *bool                          `json:"fuzzy_transpositions,omitempty"`
	Lenient                         *bool                          `json:"lenient,omitempty"`
	MaxExpansions                   *int                           `json:"max_expansions,omitempty"`
	MinimumShouldMatch              *MinimumShouldMatch            `json:"minimum_should_match,omitempty"`
	Operator                        *operator.Operator             `json:"operator,omitempty"`
	PrefixLength                    *int                           `json:"prefix_length,omitempty"`
	Query                           string                         `json:"query"`
	QueryName_                      *string                        `json:"_name,omitempty"`
	ZeroTermsQuery                  *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MatchQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L133-L158

func NewMatchQuery ¶ added in v8.5.0 

func NewMatchQuery() *MatchQuery

NewMatchQuery returns a MatchQuery.

type MatrixAggregation ¶ 

type MatrixAggregation struct {
	Fields  []string               `json:"fields,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
	Missing map[string]float64     `json:"missing,omitempty"`
	Name    *string                `json:"name,omitempty"`
}

MatrixAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/matrix.ts#L26-L29

func NewMatrixAggregation ¶ added in v8.5.0 

func NewMatrixAggregation() *MatrixAggregation

NewMatrixAggregation returns a MatrixAggregation.

type MatrixStatsAggregate ¶ 

type MatrixStatsAggregate struct {
	DocCount int64                  `json:"doc_count"`
	Fields   []MatrixStatsFields    `json:"fields"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
}

MatrixStatsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L748-L752

func NewMatrixStatsAggregate ¶ added in v8.5.0 

func NewMatrixStatsAggregate() *MatrixStatsAggregate

NewMatrixStatsAggregate returns a MatrixStatsAggregate.

type MatrixStatsAggregation ¶ 

type MatrixStatsAggregation struct {
	Fields  []string               `json:"fields,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
	Missing map[string]float64     `json:"missing,omitempty"`
	Mode    *sortmode.SortMode     `json:"mode,omitempty"`
	Name    *string                `json:"name,omitempty"`
}

MatrixStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/matrix.ts#L31-L33

func NewMatrixStatsAggregation ¶ added in v8.5.0 

func NewMatrixStatsAggregation() *MatrixStatsAggregation

NewMatrixStatsAggregation returns a MatrixStatsAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L754-L763

func NewMatrixStatsFields ¶ added in v8.5.0 

func NewMatrixStatsFields() *MatrixStatsFields

NewMatrixStatsFields returns a MatrixStatsFields.

type MaxAggregate ¶ 

type MaxAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L199-L200

func NewMaxAggregate ¶ added in v8.5.0 

func NewMaxAggregate() *MaxAggregate

NewMaxAggregate returns a MaxAggregate.

type MaxAggregation ¶ 

type MaxAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

MaxAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L97-L97

func NewMaxAggregation ¶ added in v8.5.0 

func NewMaxAggregation() *MaxAggregation

NewMaxAggregation returns a MaxAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

MaxBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L184-L184

func NewMaxBucketAggregation ¶ added in v8.5.0 

func NewMaxBucketAggregation() *MaxBucketAggregation

NewMaxBucketAggregation returns a MaxBucketAggregation.

type MedianAbsoluteDeviationAggregate ¶ 

type MedianAbsoluteDeviationAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L193-L194

func NewMedianAbsoluteDeviationAggregate ¶ added in v8.5.0 

func NewMedianAbsoluteDeviationAggregate() *MedianAbsoluteDeviationAggregate

NewMedianAbsoluteDeviationAggregate returns a MedianAbsoluteDeviationAggregate.

type MedianAbsoluteDeviationAggregation ¶ 

type MedianAbsoluteDeviationAggregation struct {
	Compression *float64 `json:"compression,omitempty"`
	Field       *string  `json:"field,omitempty"`
	Format      *string  `json:"format,omitempty"`
	Missing     *Missing `json:"missing,omitempty"`
	Script      *Script  `json:"script,omitempty"`
}

MedianAbsoluteDeviationAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L99-L101

func NewMedianAbsoluteDeviationAggregation ¶ added in v8.5.0 

func NewMedianAbsoluteDeviationAggregation() *MedianAbsoluteDeviationAggregation

NewMedianAbsoluteDeviationAggregation returns a MedianAbsoluteDeviationAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/get_memory_stats/types.ts#L90-L111

func NewMemMlStats ¶ added in v8.5.0 

func NewMemMlStats() *MemMlStats

NewMemMlStats returns a MemMlStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/get_memory_stats/types.ts#L65-L88

func NewMemStats ¶ added in v8.5.0 

func NewMemStats() *MemStats

NewMemStats returns a MemStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/get_memory_stats/types.ts#L25-L48

func NewMemory ¶ added in v8.5.0 

func NewMemory() *Memory

NewMemory returns a Memory.

type MemoryStats ¶ 

type MemoryStats struct {
	AdjustedTotalInBytes *int64  `json:"adjusted_total_in_bytes,omitempty"`
	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         *int64  `json:"total_in_bytes,omitempty"`
	TotalVirtual         *string `json:"total_virtual,omitempty"`
	TotalVirtualInBytes  *int64  `json:"total_virtual_in_bytes,omitempty"`
	UsedInBytes          *int64  `json:"used_in_bytes,omitempty"`
}

MemoryStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L242-L253

func NewMemoryStats ¶ added in v8.5.0 

func NewMemoryStats() *MemoryStats

NewMemoryStats returns a MemoryStats.

type Merge ¶ 

type Merge struct {
	Scheduler *MergeScheduler `json:"scheduler,omitempty"`
}

Merge type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L323-L325

func NewMerge ¶ added in v8.5.0 

func NewMerge() *Merge

NewMerge returns a Merge.

type MergeScheduler ¶ 

type MergeScheduler struct {
	MaxMergeCount  *int `json:"max_merge_count,omitempty"`
	MaxThreadCount *int `json:"max_thread_count,omitempty"`
}

MergeScheduler type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L327-L330

func NewMergeScheduler ¶ added in v8.5.0 

func NewMergeScheduler() *MergeScheduler

NewMergeScheduler returns a MergeScheduler.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L118-L135

func NewMergesStats ¶ added in v8.5.0 

func NewMergesStats() *MergesStats

NewMergesStats returns a MergesStats.

type Metadata ¶ 

type Metadata map[string]interface{}

Metadata type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L91-L91

type Metrics ¶ 

type Metrics []string

Metrics type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L70-L70

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/mget/types.ts#L32-L55

func NewMgetOperation ¶ added in v8.5.0 

func NewMgetOperation() *MgetOperation

NewMgetOperation returns a MgetOperation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponse.ts#L44-L48

func NewMigrationFeatureIndexInfo ¶ added in v8.5.0 

func NewMigrationFeatureIndexInfo() *MigrationFeatureIndexInfo

NewMigrationFeatureIndexInfo returns a MigrationFeatureIndexInfo.

type MinAggregate ¶ 

type MinAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L196-L197

func NewMinAggregate ¶ added in v8.5.0 

func NewMinAggregate() *MinAggregate

NewMinAggregate returns a MinAggregate.

type MinAggregation ¶ 

type MinAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

MinAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L103-L103

func NewMinAggregation ¶ added in v8.5.0 

func NewMinAggregation() *MinAggregation

NewMinAggregation returns a MinAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

MinBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L186-L186

func NewMinBucketAggregation ¶ added in v8.5.0 

func NewMinBucketAggregation() *MinBucketAggregation

NewMinBucketAggregation returns a MinBucketAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/info/types.ts#L34-L40

func NewMinimalLicenseInformation ¶ added in v8.5.0 

func NewMinimalLicenseInformation() *MinimalLicenseInformation

NewMinimalLicenseInformation returns a MinimalLicenseInformation.

type MinimumShouldMatch ¶ 

type MinimumShouldMatch interface{}

MinimumShouldMatch holds the union for the following types: 

int
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L143-L147

type Missing ¶ 

type Missing interface{}

Missing holds the union for the following types: 

string
int
float64
bool

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/AggregationContainer.ts#L211-L211

type MissingAggregate ¶ 

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

MissingAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L482-L483

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

type MissingAggregation ¶ 

type MissingAggregation struct {
	Field   *string                `json:"field,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
	Missing *Missing               `json:"missing,omitempty"`
	Name    *string                `json:"name,omitempty"`
}

MissingAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L260-L263

func NewMissingAggregation ¶ added in v8.5.0 

func NewMissingAggregation() *MissingAggregation

NewMissingAggregation returns a MissingAggregation.

type MlCounter ¶ 

type MlCounter struct {
	Count int64 `json:"count"`
}

MlCounter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L240-L242

func NewMlCounter ¶ added in v8.5.0 

func NewMlCounter() *MlCounter

NewMlCounter returns a MlCounter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L169-L174

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L176-L180

func NewMlDataFrameAnalyticsJobsAnalysis ¶ added in v8.5.0 

func NewMlDataFrameAnalyticsJobsAnalysis() *MlDataFrameAnalyticsJobsAnalysis

NewMlDataFrameAnalyticsJobsAnalysis returns a MlDataFrameAnalyticsJobsAnalysis.

type MlDataFrameAnalyticsJobsCount ¶ 

type MlDataFrameAnalyticsJobsCount struct {
	Count int64 `json:"count"`
}

MlDataFrameAnalyticsJobsCount type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L186-L188

func NewMlDataFrameAnalyticsJobsCount ¶ added in v8.5.0 

func NewMlDataFrameAnalyticsJobsCount() *MlDataFrameAnalyticsJobsCount

NewMlDataFrameAnalyticsJobsCount returns a MlDataFrameAnalyticsJobsCount.

type MlDataFrameAnalyticsJobsMemory ¶ 

type MlDataFrameAnalyticsJobsMemory struct {
	PeakUsageBytes JobStatistics `json:"peak_usage_bytes"`
}

MlDataFrameAnalyticsJobsMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L182-L184

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L190-L195

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L213-L218

func NewMlInferenceDeployments ¶ added in v8.5.0 

func NewMlInferenceDeployments() *MlInferenceDeployments

NewMlInferenceDeployments returns a MlInferenceDeployments.

type MlInferenceDeploymentsTimeMs ¶ 

type MlInferenceDeploymentsTimeMs struct {
	Avg float64 `json:"avg"`
}

MlInferenceDeploymentsTimeMs type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L220-L222

func NewMlInferenceDeploymentsTimeMs ¶ added in v8.5.0 

func NewMlInferenceDeploymentsTimeMs() *MlInferenceDeploymentsTimeMs

NewMlInferenceDeploymentsTimeMs returns a MlInferenceDeploymentsTimeMs.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L197-L202

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L224-L228

func NewMlInferenceIngestProcessorCount ¶ added in v8.5.0 

func NewMlInferenceIngestProcessorCount() *MlInferenceIngestProcessorCount

NewMlInferenceIngestProcessorCount returns a MlInferenceIngestProcessorCount.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L204-L211

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"`
	Total          int64  `json:"total"`
}

MlInferenceTrainedModelsCount type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L230-L238

func NewMlInferenceTrainedModelsCount ¶ added in v8.5.0 

func NewMlInferenceTrainedModelsCount() *MlInferenceTrainedModelsCount

NewMlInferenceTrainedModelsCount returns a MlInferenceTrainedModelsCount.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L164-L167

func NewMlJobForecasts ¶ added in v8.5.0 

func NewMlJobForecasts() *MlJobForecasts

NewMlJobForecasts returns a MlJobForecasts.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/ModelPlot.ts#L23-L40

func NewModelPlotConfig ¶ added in v8.5.0 

func NewModelPlotConfig() *ModelPlotConfig

NewModelPlotConfig returns a ModelPlotConfig.

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"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Model.ts#L56-L78

func NewModelSizeStats ¶ added in v8.5.0 

func NewModelSizeStats() *ModelSizeStats

NewModelSizeStats returns a ModelSizeStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Model.ts#L25-L46

func NewModelSnapshot ¶ added in v8.5.0 

func NewModelSnapshot() *ModelSnapshot

NewModelSnapshot returns a ModelSnapshot.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Model.ts#L48-L54

func NewModelSnapshotUpgrade ¶ added in v8.5.0 

func NewModelSnapshotUpgrade() *ModelSnapshotUpgrade

NewModelSnapshotUpgrade returns a ModelSnapshotUpgrade.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L363-L366

func NewMonitoring ¶ added in v8.5.0 

func NewMonitoring() *Monitoring

NewMonitoring returns a Monitoring.

type MoreLikeThisQuery ¶ 

type MoreLikeThisQuery struct {
	Analyzer               *string                  `json:"analyzer,omitempty"`
	Boost                  *float32                 `json:"boost,omitempty"`
	BoostTerms             *float64                 `json:"boost_terms,omitempty"`
	FailOnUnsupportedField *bool                    `json:"fail_on_unsupported_field,omitempty"`
	Fields                 []string                 `json:"fields,omitempty"`
	Include                *bool                    `json:"include,omitempty"`
	Like                   []Like                   `json:"like"`
	MaxDocFreq             *int                     `json:"max_doc_freq,omitempty"`
	MaxQueryTerms          *int                     `json:"max_query_terms,omitempty"`
	MaxWordLength          *int                     `json:"max_word_length,omitempty"`
	MinDocFreq             *int                     `json:"min_doc_freq,omitempty"`
	MinTermFreq            *int                     `json:"min_term_freq,omitempty"`
	MinWordLength          *int                     `json:"min_word_length,omitempty"`
	MinimumShouldMatch     *MinimumShouldMatch      `json:"minimum_should_match,omitempty"`
	PerFieldAnalyzer       map[string]string        `json:"per_field_analyzer,omitempty"`
	QueryName_             *string                  `json:"_name,omitempty"`
	Routing                *string                  `json:"routing,omitempty"`
	StopWords              []string                 `json:"stop_words,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L62-L89

func NewMoreLikeThisQuery ¶ added in v8.5.0 

func NewMoreLikeThisQuery() *MoreLikeThisQuery

NewMoreLikeThisQuery returns a MoreLikeThisQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/searchable_snapshots/mount/types.ts#L23-L27

func NewMountedSnapshot ¶ added in v8.5.0 

func NewMountedSnapshot() *MountedSnapshot

NewMountedSnapshot returns a MountedSnapshot.

type MovingAverageAggregation ¶ 

type MovingAverageAggregation interface {
	// contains filtered or unexported methods
}

MovingAverageAggregation holds the union for the following types: 

LinearMovingAverageAggregation
SimpleMovingAverageAggregation
EwmaMovingAverageAggregation
HoltMovingAverageAggregation
HoltWintersMovingAverageAggregation

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L188-L194

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Script      *string                `json:"script,omitempty"`
	Shift       *int                   `json:"shift,omitempty"`
	Window      *int                   `json:"window,omitempty"`
}

MovingFunctionAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L250-L254

func NewMovingFunctionAggregation ¶ added in v8.5.0 

func NewMovingFunctionAggregation() *MovingFunctionAggregation

NewMovingFunctionAggregation returns a MovingFunctionAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Keyed       *bool                  `json:"keyed,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Shift       *int                   `json:"shift,omitempty"`
	Window      *int                   `json:"window,omitempty"`
}

MovingPercentilesAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L256-L260

func NewMovingPercentilesAggregation ¶ added in v8.5.0 

func NewMovingPercentilesAggregation() *MovingPercentilesAggregation

NewMovingPercentilesAggregation returns a MovingPercentilesAggregation.

type MultiBucketAggregateBaseAdjacencyMatrixBucket ¶ 

type MultiBucketAggregateBaseAdjacencyMatrixBucket struct {
	Buckets BucketsAdjacencyMatrixBucket `json:"buckets"`
	Meta    map[string]interface{}       `json:"meta,omitempty"`
}

MultiBucketAggregateBaseAdjacencyMatrixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseAdjacencyMatrixBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseAdjacencyMatrixBucket() *MultiBucketAggregateBaseAdjacencyMatrixBucket

NewMultiBucketAggregateBaseAdjacencyMatrixBucket returns a MultiBucketAggregateBaseAdjacencyMatrixBucket.

type MultiBucketAggregateBaseCompositeBucket ¶ 

type MultiBucketAggregateBaseCompositeBucket struct {
	Buckets BucketsCompositeBucket `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseCompositeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseCompositeBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseCompositeBucket() *MultiBucketAggregateBaseCompositeBucket

NewMultiBucketAggregateBaseCompositeBucket returns a MultiBucketAggregateBaseCompositeBucket.

type MultiBucketAggregateBaseDateHistogramBucket ¶ 

type MultiBucketAggregateBaseDateHistogramBucket struct {
	Buckets BucketsDateHistogramBucket `json:"buckets"`
	Meta    map[string]interface{}     `json:"meta,omitempty"`
}

MultiBucketAggregateBaseDateHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseDateHistogramBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseDateHistogramBucket() *MultiBucketAggregateBaseDateHistogramBucket

NewMultiBucketAggregateBaseDateHistogramBucket returns a MultiBucketAggregateBaseDateHistogramBucket.

type MultiBucketAggregateBaseDoubleTermsBucket ¶ 

type MultiBucketAggregateBaseDoubleTermsBucket struct {
	Buckets BucketsDoubleTermsBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseDoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseDoubleTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseDoubleTermsBucket() *MultiBucketAggregateBaseDoubleTermsBucket

NewMultiBucketAggregateBaseDoubleTermsBucket returns a MultiBucketAggregateBaseDoubleTermsBucket.

type MultiBucketAggregateBaseFiltersBucket ¶ 

type MultiBucketAggregateBaseFiltersBucket struct {
	Buckets BucketsFiltersBucket   `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseFiltersBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseFiltersBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseFiltersBucket() *MultiBucketAggregateBaseFiltersBucket

NewMultiBucketAggregateBaseFiltersBucket returns a MultiBucketAggregateBaseFiltersBucket.

type MultiBucketAggregateBaseGeoHashGridBucket ¶ 

type MultiBucketAggregateBaseGeoHashGridBucket struct {
	Buckets BucketsGeoHashGridBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoHashGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseGeoHashGridBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseGeoHashGridBucket() *MultiBucketAggregateBaseGeoHashGridBucket

NewMultiBucketAggregateBaseGeoHashGridBucket returns a MultiBucketAggregateBaseGeoHashGridBucket.

type MultiBucketAggregateBaseGeoHexGridBucket ¶ added in v8.5.0 

type MultiBucketAggregateBaseGeoHexGridBucket struct {
	Buckets BucketsGeoHexGridBucket `json:"buckets"`
	Meta    map[string]interface{}  `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoHexGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseGeoHexGridBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseGeoHexGridBucket() *MultiBucketAggregateBaseGeoHexGridBucket

NewMultiBucketAggregateBaseGeoHexGridBucket returns a MultiBucketAggregateBaseGeoHexGridBucket.

type MultiBucketAggregateBaseGeoTileGridBucket ¶ 

type MultiBucketAggregateBaseGeoTileGridBucket struct {
	Buckets BucketsGeoTileGridBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseGeoTileGridBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseGeoTileGridBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseGeoTileGridBucket() *MultiBucketAggregateBaseGeoTileGridBucket

NewMultiBucketAggregateBaseGeoTileGridBucket returns a MultiBucketAggregateBaseGeoTileGridBucket.

type MultiBucketAggregateBaseHistogramBucket ¶ 

type MultiBucketAggregateBaseHistogramBucket struct {
	Buckets BucketsHistogramBucket `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseHistogramBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseHistogramBucket() *MultiBucketAggregateBaseHistogramBucket

NewMultiBucketAggregateBaseHistogramBucket returns a MultiBucketAggregateBaseHistogramBucket.

type MultiBucketAggregateBaseIpPrefixBucket ¶ added in v8.5.0 

type MultiBucketAggregateBaseIpPrefixBucket struct {
	Buckets BucketsIpPrefixBucket  `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseIpPrefixBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseIpPrefixBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseIpPrefixBucket() *MultiBucketAggregateBaseIpPrefixBucket

NewMultiBucketAggregateBaseIpPrefixBucket returns a MultiBucketAggregateBaseIpPrefixBucket.

type MultiBucketAggregateBaseIpRangeBucket ¶ 

type MultiBucketAggregateBaseIpRangeBucket struct {
	Buckets BucketsIpRangeBucket   `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseIpRangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseIpRangeBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseIpRangeBucket() *MultiBucketAggregateBaseIpRangeBucket

NewMultiBucketAggregateBaseIpRangeBucket returns a MultiBucketAggregateBaseIpRangeBucket.

type MultiBucketAggregateBaseLongRareTermsBucket ¶ 

type MultiBucketAggregateBaseLongRareTermsBucket struct {
	Buckets BucketsLongRareTermsBucket `json:"buckets"`
	Meta    map[string]interface{}     `json:"meta,omitempty"`
}

MultiBucketAggregateBaseLongRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseLongRareTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseLongRareTermsBucket() *MultiBucketAggregateBaseLongRareTermsBucket

NewMultiBucketAggregateBaseLongRareTermsBucket returns a MultiBucketAggregateBaseLongRareTermsBucket.

type MultiBucketAggregateBaseLongTermsBucket ¶ 

type MultiBucketAggregateBaseLongTermsBucket struct {
	Buckets BucketsLongTermsBucket `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseLongTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseLongTermsBucket() *MultiBucketAggregateBaseLongTermsBucket

NewMultiBucketAggregateBaseLongTermsBucket returns a MultiBucketAggregateBaseLongTermsBucket.

type MultiBucketAggregateBaseMultiTermsBucket ¶ 

type MultiBucketAggregateBaseMultiTermsBucket struct {
	Buckets BucketsMultiTermsBucket `json:"buckets"`
	Meta    map[string]interface{}  `json:"meta,omitempty"`
}

MultiBucketAggregateBaseMultiTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseMultiTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseMultiTermsBucket() *MultiBucketAggregateBaseMultiTermsBucket

NewMultiBucketAggregateBaseMultiTermsBucket returns a MultiBucketAggregateBaseMultiTermsBucket.

type MultiBucketAggregateBaseRangeBucket ¶ 

type MultiBucketAggregateBaseRangeBucket struct {
	Buckets BucketsRangeBucket     `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseRangeBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseRangeBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseRangeBucket() *MultiBucketAggregateBaseRangeBucket

NewMultiBucketAggregateBaseRangeBucket returns a MultiBucketAggregateBaseRangeBucket.

type MultiBucketAggregateBaseSignificantLongTermsBucket ¶ 

type MultiBucketAggregateBaseSignificantLongTermsBucket struct {
	Buckets BucketsSignificantLongTermsBucket `json:"buckets"`
	Meta    map[string]interface{}            `json:"meta,omitempty"`
}

MultiBucketAggregateBaseSignificantLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseSignificantLongTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseSignificantLongTermsBucket() *MultiBucketAggregateBaseSignificantLongTermsBucket

NewMultiBucketAggregateBaseSignificantLongTermsBucket returns a MultiBucketAggregateBaseSignificantLongTermsBucket.

type MultiBucketAggregateBaseSignificantStringTermsBucket ¶ 

type MultiBucketAggregateBaseSignificantStringTermsBucket struct {
	Buckets BucketsSignificantStringTermsBucket `json:"buckets"`
	Meta    map[string]interface{}              `json:"meta,omitempty"`
}

MultiBucketAggregateBaseSignificantStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseSignificantStringTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseSignificantStringTermsBucket() *MultiBucketAggregateBaseSignificantStringTermsBucket

NewMultiBucketAggregateBaseSignificantStringTermsBucket returns a MultiBucketAggregateBaseSignificantStringTermsBucket.

type MultiBucketAggregateBaseStringRareTermsBucket ¶ 

type MultiBucketAggregateBaseStringRareTermsBucket struct {
	Buckets BucketsStringRareTermsBucket `json:"buckets"`
	Meta    map[string]interface{}       `json:"meta,omitempty"`
}

MultiBucketAggregateBaseStringRareTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseStringRareTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseStringRareTermsBucket() *MultiBucketAggregateBaseStringRareTermsBucket

NewMultiBucketAggregateBaseStringRareTermsBucket returns a MultiBucketAggregateBaseStringRareTermsBucket.

type MultiBucketAggregateBaseStringTermsBucket ¶ 

type MultiBucketAggregateBaseStringTermsBucket struct {
	Buckets BucketsStringTermsBucket `json:"buckets"`
	Meta    map[string]interface{}   `json:"meta,omitempty"`
}

MultiBucketAggregateBaseStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseStringTermsBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseStringTermsBucket() *MultiBucketAggregateBaseStringTermsBucket

NewMultiBucketAggregateBaseStringTermsBucket returns a MultiBucketAggregateBaseStringTermsBucket.

type MultiBucketAggregateBaseVariableWidthHistogramBucket ¶ 

type MultiBucketAggregateBaseVariableWidthHistogramBucket struct {
	Buckets BucketsVariableWidthHistogramBucket `json:"buckets"`
	Meta    map[string]interface{}              `json:"meta,omitempty"`
}

MultiBucketAggregateBaseVariableWidthHistogramBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseVariableWidthHistogramBucket ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseVariableWidthHistogramBucket() *MultiBucketAggregateBaseVariableWidthHistogramBucket

NewMultiBucketAggregateBaseVariableWidthHistogramBucket returns a MultiBucketAggregateBaseVariableWidthHistogramBucket.

type MultiBucketAggregateBaseVoid ¶ 

type MultiBucketAggregateBaseVoid struct {
	Buckets BucketsVoid            `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

MultiBucketAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L326-L328

func NewMultiBucketAggregateBaseVoid ¶ added in v8.5.0 

func NewMultiBucketAggregateBaseVoid() *MultiBucketAggregateBaseVoid

NewMultiBucketAggregateBaseVoid returns a MultiBucketAggregateBaseVoid.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/mget/types.ts#L62-L66

func NewMultiGetError ¶ added in v8.5.0 

func NewMultiGetError() *MultiGetError

NewMultiGetError returns a MultiGetError.

type MultiMatchQuery ¶ 

type MultiMatchQuery struct {
	Analyzer                        *string                        `json:"analyzer,omitempty"`
	AutoGenerateSynonymsPhraseQuery *bool                          `json:"auto_generate_synonyms_phrase_query,omitempty"`
	Boost                           *float32                       `json:"boost,omitempty"`
	CutoffFrequency                 *float64                       `json:"cutoff_frequency,omitempty"`
	Fields                          []string                       `json:"fields,omitempty"`
	Fuzziness                       *Fuzziness                     `json:"fuzziness,omitempty"`
	FuzzyRewrite                    *string                        `json:"fuzzy_rewrite,omitempty"`
	FuzzyTranspositions             *bool                          `json:"fuzzy_transpositions,omitempty"`
	Lenient                         *bool                          `json:"lenient,omitempty"`
	MaxExpansions                   *int                           `json:"max_expansions,omitempty"`
	MinimumShouldMatch              *MinimumShouldMatch            `json:"minimum_should_match,omitempty"`
	Operator                        *operator.Operator             `json:"operator,omitempty"`
	PrefixLength                    *int                           `json:"prefix_length,omitempty"`
	Query                           string                         `json:"query"`
	QueryName_                      *string                        `json:"_name,omitempty"`
	Slop                            *int                           `json:"slop,omitempty"`
	TieBreaker                      *float64                       `json:"tie_breaker,omitempty"`
	Type                            *textquerytype.TextQueryType   `json:"type,omitempty"`
	ZeroTermsQuery                  *zerotermsquery.ZeroTermsQuery `json:"zero_terms_query,omitempty"`
}

MultiMatchQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L191-L217

func NewMultiMatchQuery ¶ added in v8.5.0 

func NewMultiMatchQuery() *MultiMatchQuery

NewMultiMatchQuery returns a MultiMatchQuery.

type MultiTermLookup ¶ 

type MultiTermLookup struct {
	Field   string   `json:"field"`
	Missing *Missing `json:"missing,omitempty"`
}

MultiTermLookup type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L276-L279

func NewMultiTermLookup ¶ added in v8.5.0 

func NewMultiTermLookup() *MultiTermLookup

NewMultiTermLookup returns a MultiTermLookup.

type MultiTermsAggregate ¶ 

type MultiTermsAggregate struct {
	Buckets                 BucketsMultiTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                  `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}  `json:"meta,omitempty"`
	SumOtherDocCount        *int64                  `json:"sum_other_doc_count,omitempty"`
}

MultiTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L460-L462

func NewMultiTermsAggregate ¶ added in v8.5.0 

func NewMultiTermsAggregate() *MultiTermsAggregate

NewMultiTermsAggregate returns a MultiTermsAggregate.

type MultiTermsAggregation ¶ 

type MultiTermsAggregation struct {
	CollectMode           *termsaggregationcollectmode.TermsAggregationCollectMode `json:"collect_mode,omitempty"`
	Meta                  map[string]interface{}                                   `json:"meta,omitempty"`
	MinDocCount           *int64                                                   `json:"min_doc_count,omitempty"`
	Name                  *string                                                  `json:"name,omitempty"`
	Order                 *AggregateOrder                                          `json:"order,omitempty"`
	ShardMinDocCount      *int64                                                   `json:"shard_min_doc_count,omitempty"`
	ShardSize             *int                                                     `json:"shard_size,omitempty"`
	ShowTermDocCountError *bool                                                    `json:"show_term_doc_count_error,omitempty"`
	Size                  *int                                                     `json:"size,omitempty"`
	Terms                 []MultiTermLookup                                        `json:"terms"`
}

MultiTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L265-L274

func NewMultiTermsAggregation ¶ added in v8.5.0 

func NewMultiTermsAggregation() *MultiTermsAggregation

NewMultiTermsAggregation returns a MultiTermsAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L464-L468

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

type MultiplexerTokenFilter ¶ 

type MultiplexerTokenFilter struct {
	Filters          []string `json:"filters"`
	PreserveOriginal *bool    `json:"preserve_original,omitempty"`
	Type             string   `json:"type,omitempty"`
	Version          *string  `json:"version,omitempty"`
}

MultiplexerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L259-L263

func NewMultiplexerTokenFilter ¶ added in v8.5.0 

func NewMultiplexerTokenFilter() *MultiplexerTokenFilter

NewMultiplexerTokenFilter returns a MultiplexerTokenFilter.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

Murmur3HashProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L74-L76

func NewMurmur3HashProperty ¶ added in v8.5.0 

func NewMurmur3HashProperty() *Murmur3HashProperty

NewMurmur3HashProperty returns a Murmur3HashProperty.

type MutualInformationHeuristic ¶ 

type MutualInformationHeuristic struct {
	BackgroundIsSuperset *bool `json:"background_is_superset,omitempty"`
	IncludeNegatives     *bool `json:"include_negatives,omitempty"`
}

MutualInformationHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L331-L334

func NewMutualInformationHeuristic ¶ added in v8.5.0 

func NewMutualInformationHeuristic() *MutualInformationHeuristic

NewMutualInformationHeuristic returns a MutualInformationHeuristic.

type NGramTokenFilter ¶ 

type NGramTokenFilter struct {
	MaxGram          *int    `json:"max_gram,omitempty"`
	MinGram          *int    `json:"min_gram,omitempty"`
	PreserveOriginal *bool   `json:"preserve_original,omitempty"`
	Type             string  `json:"type,omitempty"`
	Version          *string `json:"version,omitempty"`
}

NGramTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L265-L270

func NewNGramTokenFilter ¶ added in v8.5.0 

func NewNGramTokenFilter() *NGramTokenFilter

NewNGramTokenFilter returns a NGramTokenFilter.

type NGramTokenizer ¶ 

type NGramTokenizer struct {
	CustomTokenChars *string               `json:"custom_token_chars,omitempty"`
	MaxGram          int                   `json:"max_gram"`
	MinGram          int                   `json:"min_gram"`
	TokenChars       []tokenchar.TokenChar `json:"token_chars"`
	Type             string                `json:"type,omitempty"`
	Version          *string               `json:"version,omitempty"`
}

NGramTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L38-L44

func NewNGramTokenizer ¶ added in v8.5.0 

func NewNGramTokenizer() *NGramTokenizer

NewNGramTokenizer returns a NGramTokenizer.

type Names ¶ 

type Names []string

Names type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L73-L73

type NativeCode ¶ 

type NativeCode struct {
	BuildHash string `json:"build_hash"`
	Version   string `json:"version"`
}

NativeCode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/info/types.ts#L29-L32

func NewNativeCode ¶ added in v8.5.0 

func NewNativeCode() *NativeCode

NewNativeCode returns a NativeCode.

type NativeCodeInformation ¶ 

type NativeCodeInformation struct {
	BuildHash string `json:"build_hash"`
	Version   string `json:"version"`
}

NativeCodeInformation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/info/types.ts#L29-L32

func NewNativeCodeInformation ¶ added in v8.5.0 

func NewNativeCodeInformation() *NativeCodeInformation

NewNativeCodeInformation returns a NativeCodeInformation.

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"`
}

NerInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L225-L233

func NewNerInferenceOptions ¶ added in v8.5.0 

func NewNerInferenceOptions() *NerInferenceOptions

NewNerInferenceOptions returns a NerInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L357-L362

func NewNerInferenceUpdateOptions ¶ added in v8.5.0 

func NewNerInferenceUpdateOptions() *NerInferenceUpdateOptions

NewNerInferenceUpdateOptions returns a NerInferenceUpdateOptions.

type NestedAggregate ¶ 

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

NestedAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L485-L486

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

type NestedAggregation ¶ 

type NestedAggregation struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
	Path *string                `json:"path,omitempty"`
}

NestedAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L281-L283

func NewNestedAggregation ¶ added in v8.5.0 

func NewNestedAggregation() *NestedAggregation

NewNestedAggregation returns a NestedAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L88-L92

func NewNestedIdentity ¶ added in v8.5.0 

func NewNestedIdentity() *NestedIdentity

NewNestedIdentity returns a NestedIdentity.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

NestedProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/complex.ts#L39-L44

func NewNestedProperty ¶ added in v8.5.0 

func NewNestedProperty() *NestedProperty

NewNestedProperty returns a NestedProperty.

type NestedQuery ¶ 

type NestedQuery struct {
	Boost          *float32                       `json:"boost,omitempty"`
	IgnoreUnmapped *bool                          `json:"ignore_unmapped,omitempty"`
	InnerHits      *InnerHits                     `json:"inner_hits,omitempty"`
	Path           string                         `json:"path"`
	Query          *Query                         `json:"query,omitempty"`
	QueryName_     *string                        `json:"_name,omitempty"`
	ScoreMode      *childscoremode.ChildScoreMode `json:"score_mode,omitempty"`
}

NestedQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/joining.ts#L63-L71

func NewNestedQuery ¶ added in v8.5.0 

func NewNestedQuery() *NestedQuery

NewNestedQuery returns a NestedQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L30-L35

func NewNestedSortValue ¶ added in v8.5.0 

func NewNestedSortValue() *NestedSortValue

NewNestedSortValue returns a NestedSortValue.

type NeverCondition ¶ 

type NeverCondition struct {
}

NeverCondition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Conditions.ts#L69-L69

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L116-L143

func NewNlpBertTokenizationConfig ¶ added in v8.5.0 

func NewNlpBertTokenizationConfig() *NlpBertTokenizationConfig

NewNlpBertTokenizationConfig returns a NlpBertTokenizationConfig.

type NlpRobertaTokenizationConfig ¶ 

type NlpRobertaTokenizationConfig struct {
	// AddPrefixSpace Should the tokenizer prefix input with a space character
	AddPrefixSpace *bool `json:"add_prefix_space,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L145-L172

func NewNlpRobertaTokenizationConfig ¶ added in v8.5.0 

func NewNlpRobertaTokenizationConfig() *NlpRobertaTokenizationConfig

NewNlpRobertaTokenizationConfig returns a NlpRobertaTokenizationConfig.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L315-L320

func NewNlpTokenizationUpdateOptions ¶ added in v8.5.0 

func NewNlpTokenizationUpdateOptions() *NlpTokenizationUpdateOptions

NewNlpTokenizationUpdateOptions returns a NlpTokenizationUpdateOptions.

type Node ¶ 

type Node struct {
	SharedCache Shared `json:"shared_cache"`
}

Node type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
	Store            *AllocationStore     `json:"store,omitempty"`
	TransportAddress string               `json:"transport_address"`
	WeightRanking    int                  `json:"weight_ranking"`
}

NodeAllocationExplanation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L97-L106

func NewNodeAllocationExplanation ¶ added in v8.5.0 

func NewNodeAllocationExplanation() *NodeAllocationExplanation

NewNodeAllocationExplanation returns a NodeAllocationExplanation.

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"`
	ExternalId  string `json:"external_id"`
	// Id The unique identifier of the node.
	Id *string `json:"id,omitempty"`
	// Name The unique identifier of the node.
	Name  string              `json:"name"`
	Roles []noderole.NodeRole `json:"roles,omitempty"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Node.ts#L41-L57

func NewNodeAttributes ¶ added in v8.5.0 

func NewNodeAttributes() *NodeAttributes

NewNodeAttributes returns a NodeAttributes.

type NodeAttributesRecord ¶ 

type NodeAttributesRecord struct {
	// Attr attribute description
	Attr *string `json:"attr,omitempty"`
	// Host host name
	Host *string `json:"host,omitempty"`
	// Id unique node id
	Id *string `json:"id,omitempty"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// Node node name
	Node *string `json:"node,omitempty"`
	// Pid process id
	Pid *string `json:"pid,omitempty"`
	// Port bound transport port
	Port *string `json:"port,omitempty"`
	// Value attribute value
	Value *string `json:"value,omitempty"`
}

NodeAttributesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/nodeattrs/types.ts#L20-L55

func NewNodeAttributesRecord ¶ added in v8.5.0 

func NewNodeAttributesRecord() *NodeAttributesRecord

NewNodeAttributesRecord returns a NodeAttributesRecord.

type NodeBufferPool ¶ 

type NodeBufferPool struct {
	Count                *int64  `json:"count,omitempty"`
	TotalCapacity        *string `json:"total_capacity,omitempty"`
	TotalCapacityInBytes *int64  `json:"total_capacity_in_bytes,omitempty"`
	Used                 *string `json:"used,omitempty"`
	UsedInBytes          *int64  `json:"used_in_bytes,omitempty"`
}

NodeBufferPool type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L310-L316

func NewNodeBufferPool ¶ added in v8.5.0 

func NewNodeBufferPool() *NodeBufferPool

NewNodeBufferPool returns a NodeBufferPool.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L56-L60

func NewNodeDiskUsage ¶ added in v8.5.0 

func NewNodeDiskUsage() *NodeDiskUsage

NewNodeDiskUsage returns a NodeDiskUsage.

type NodeIds ¶ 

type NodeIds []string

NodeIds type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L58-L58

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L30-L66

func NewNodeInfo ¶ added in v8.5.0 

func NewNodeInfo() *NodeInfo

NewNodeInfo returns a NodeInfo.

type NodeInfoAction ¶ 

type NodeInfoAction struct {
	DestructiveRequiresName string `json:"destructive_requires_name"`
}

NodeInfoAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L173-L175

func NewNodeInfoAction ¶ added in v8.5.0 

func NewNodeInfoAction() *NodeInfoAction

NewNodeInfoAction returns a NodeInfoAction.

type NodeInfoAggregation ¶ 

type NodeInfoAggregation struct {
	Types []string `json:"types"`
}

NodeInfoAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L224-L226

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L193-L195

func NewNodeInfoBootstrap ¶ added in v8.5.0 

func NewNodeInfoBootstrap() *NodeInfoBootstrap

NewNodeInfoBootstrap returns a NodeInfoBootstrap.

type NodeInfoClient ¶ 

type NodeInfoClient struct {
	Type string `json:"type"`
}

NodeInfoClient type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L177-L179

func NewNodeInfoClient ¶ added in v8.5.0 

func NewNodeInfoClient() *NodeInfoClient

NewNodeInfoClient returns a NodeInfoClient.

type NodeInfoDiscover ¶ 

type NodeInfoDiscover struct {
	SeedHosts string `json:"seed_hosts"`
}

NodeInfoDiscover type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L169-L171

func NewNodeInfoDiscover ¶ added in v8.5.0 

func NewNodeInfoDiscover() *NodeInfoDiscover

NewNodeInfoDiscover returns a NodeInfoDiscover.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L295-L300

func NewNodeInfoHttp ¶ added in v8.5.0 

func NewNodeInfoHttp() *NodeInfoHttp

NewNodeInfoHttp returns a NodeInfoHttp.

type NodeInfoIngest ¶ 

type NodeInfoIngest struct {
	Processors []NodeInfoIngestProcessor `json:"processors"`
}

NodeInfoIngest type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L216-L218

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L127-L129

func NewNodeInfoIngestDownloader ¶ added in v8.5.0 

func NewNodeInfoIngestDownloader() *NodeInfoIngestDownloader

NewNodeInfoIngestDownloader returns a NodeInfoIngestDownloader.

type NodeInfoIngestInfo ¶ 

type NodeInfoIngestInfo struct {
	Downloader NodeInfoIngestDownloader `json:"downloader"`
}

NodeInfoIngestInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L123-L125

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L220-L222

func NewNodeInfoIngestProcessor ¶ added in v8.5.0 

func NewNodeInfoIngestProcessor() *NodeInfoIngestProcessor

NewNodeInfoIngestProcessor returns a NodeInfoIngestProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L302-L313

func NewNodeInfoJvmMemory ¶ added in v8.5.0 

func NewNodeInfoJvmMemory() *NodeInfoJvmMemory

NewNodeInfoJvmMemory returns a NodeInfoJvmMemory.

type NodeInfoMemory ¶ 

type NodeInfoMemory struct {
	Total        string `json:"total"`
	TotalInBytes int64  `json:"total_in_bytes"`
}

NodeInfoMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L315-L318

func NewNodeInfoMemory ¶ added in v8.5.0 

func NewNodeInfoMemory() *NodeInfoMemory

NewNodeInfoMemory returns a NodeInfoMemory.

type NodeInfoNetwork ¶ 

type NodeInfoNetwork struct {
	PrimaryInterface NodeInfoNetworkInterface `json:"primary_interface"`
	RefreshInterval  int                      `json:"refresh_interval"`
}

NodeInfoNetwork type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L320-L323

func NewNodeInfoNetwork ¶ added in v8.5.0 

func NewNodeInfoNetwork() *NodeInfoNetwork

NewNodeInfoNetwork returns a NodeInfoNetwork.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L325-L329

func NewNodeInfoNetworkInterface ¶ added in v8.5.0 

func NewNodeInfoNetworkInterface() *NodeInfoNetworkInterface

NewNodeInfoNetworkInterface returns a NodeInfoNetworkInterface.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L331-L340

func NewNodeInfoOSCPU ¶ added in v8.5.0 

func NewNodeInfoOSCPU() *NodeInfoOSCPU

NewNodeInfoOSCPU returns a NodeInfoOSCPU.

type NodeInfoPath ¶ 

type NodeInfoPath struct {
	Data []string `json:"data,omitempty"`
	Home string   `json:"home"`
	Logs string   `json:"logs"`
	Repo []string `json:"repo"`
}

NodeInfoPath type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L154-L159

func NewNodeInfoPath ¶ added in v8.5.0 

func NewNodeInfoPath() *NodeInfoPath

NewNodeInfoPath returns a NodeInfoPath.

type NodeInfoRepositories ¶ 

type NodeInfoRepositories struct {
	Url NodeInfoRepositoriesUrl `json:"url"`
}

NodeInfoRepositories type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L161-L163

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L165-L167

func NewNodeInfoRepositoriesUrl ¶ added in v8.5.0 

func NewNodeInfoRepositoriesUrl() *NodeInfoRepositoriesUrl

NewNodeInfoRepositoriesUrl returns a NodeInfoRepositoriesUrl.

type NodeInfoScript ¶ 

type NodeInfoScript struct {
	AllowedTypes               string `json:"allowed_types"`
	DisableMaxCompilationsRate string `json:"disable_max_compilations_rate"`
}

NodeInfoScript type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L273-L276

func NewNodeInfoScript ¶ added in v8.5.0 

func NewNodeInfoScript() *NodeInfoScript

NewNodeInfoScript returns a NodeInfoScript.

type NodeInfoSearch ¶ 

type NodeInfoSearch struct {
	Remote NodeInfoSearchRemote `json:"remote"`
}

NodeInfoSearch type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L278-L280

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L282-L284

func NewNodeInfoSearchRemote ¶ added in v8.5.0 

func NewNodeInfoSearchRemote() *NodeInfoSearchRemote

NewNodeInfoSearchRemote returns a NodeInfoSearchRemote.

type NodeInfoSettings ¶ 

type NodeInfoSettings struct {
	Action       *NodeInfoAction           `json:"action,omitempty"`
	Bootstrap    *NodeInfoBootstrap        `json:"bootstrap,omitempty"`
	Client       NodeInfoClient            `json:"client"`
	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"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L68-L84

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L131-L138

func NewNodeInfoSettingsCluster ¶ added in v8.5.0 

func NewNodeInfoSettingsCluster() *NodeInfoSettingsCluster

NewNodeInfoSettingsCluster returns a NodeInfoSettingsCluster.

type NodeInfoSettingsClusterElection ¶ 

type NodeInfoSettingsClusterElection struct {
	Strategy string `json:"strategy"`
}

NodeInfoSettingsClusterElection type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L144-L146

func NewNodeInfoSettingsClusterElection ¶ added in v8.5.0 

func NewNodeInfoSettingsClusterElection() *NodeInfoSettingsClusterElection

NewNodeInfoSettingsClusterElection returns a NodeInfoSettingsClusterElection.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L181-L186

func NewNodeInfoSettingsHttp ¶ added in v8.5.0 

func NewNodeInfoSettingsHttp() *NodeInfoSettingsHttp

NewNodeInfoSettingsHttp returns a NodeInfoSettingsHttp.

type NodeInfoSettingsHttpType ¶ 

type NodeInfoSettingsHttpType struct {
	Default string `json:"default"`
}

NodeInfoSettingsHttpType type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L188-L191

func NewNodeInfoSettingsHttpType ¶ added in v8.5.0 

func NewNodeInfoSettingsHttpType() *NodeInfoSettingsHttpType

NewNodeInfoSettingsHttpType returns a NodeInfoSettingsHttpType.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L86-L121

func NewNodeInfoSettingsIngest ¶ added in v8.5.0 

func NewNodeInfoSettingsIngest() *NodeInfoSettingsIngest

NewNodeInfoSettingsIngest returns a NodeInfoSettingsIngest.

type NodeInfoSettingsNetwork ¶ 

type NodeInfoSettingsNetwork struct {
	Host string `json:"host"`
}

NodeInfoSettingsNetwork type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L212-L214

func NewNodeInfoSettingsNetwork ¶ added in v8.5.0 

func NewNodeInfoSettingsNetwork() *NodeInfoSettingsNetwork

NewNodeInfoSettingsNetwork returns a NodeInfoSettingsNetwork.

type NodeInfoSettingsNode ¶ 

type NodeInfoSettingsNode struct {
	Attr                 map[string]interface{} `json:"attr"`
	MaxLocalStorageNodes *string                `json:"max_local_storage_nodes,omitempty"`
	Name                 string                 `json:"name"`
}

NodeInfoSettingsNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L148-L152

func NewNodeInfoSettingsNode ¶ added in v8.5.0 

func NewNodeInfoSettingsNode() *NodeInfoSettingsNode

NewNodeInfoSettingsNode returns a NodeInfoSettingsNode.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L197-L201

func NewNodeInfoSettingsTransport ¶ added in v8.5.0 

func NewNodeInfoSettingsTransport() *NodeInfoSettingsTransport

NewNodeInfoSettingsTransport returns a NodeInfoSettingsTransport.

type NodeInfoSettingsTransportFeatures ¶ 

type NodeInfoSettingsTransportFeatures struct {
	XPack string `json:"x-pack"`
}

NodeInfoSettingsTransportFeatures type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L208-L210

func NewNodeInfoSettingsTransportFeatures ¶ added in v8.5.0 

func NewNodeInfoSettingsTransportFeatures() *NodeInfoSettingsTransportFeatures

NewNodeInfoSettingsTransportFeatures returns a NodeInfoSettingsTransportFeatures.

type NodeInfoSettingsTransportType ¶ 

type NodeInfoSettingsTransportType struct {
	Default string `json:"default"`
}

NodeInfoSettingsTransportType type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L203-L206

func NewNodeInfoSettingsTransportType ¶ added in v8.5.0 

func NewNodeInfoSettingsTransportType() *NodeInfoSettingsTransportType

NewNodeInfoSettingsTransportType returns a NodeInfoSettingsTransportType.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L342-L346

func NewNodeInfoTransport ¶ added in v8.5.0 

func NewNodeInfoTransport() *NodeInfoTransport

NewNodeInfoTransport returns a NodeInfoTransport.

type NodeInfoXpack ¶ 

type NodeInfoXpack struct {
	License      *NodeInfoXpackLicense  `json:"license,omitempty"`
	Notification map[string]interface{} `json:"notification,omitempty"`
	Security     NodeInfoXpackSecurity  `json:"security"`
}

NodeInfoXpack type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L228-L232

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L265-L267

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L269-L271

func NewNodeInfoXpackLicenseType ¶ added in v8.5.0 

func NewNodeInfoXpackLicenseType() *NodeInfoXpackLicenseType

NewNodeInfoXpackLicenseType returns a NodeInfoXpackLicenseType.

type NodeInfoXpackSecurity ¶ 

type NodeInfoXpackSecurity struct {
	Authc     *NodeInfoXpackSecurityAuthc `json:"authc,omitempty"`
	Enabled   string                      `json:"enabled"`
	Http      NodeInfoXpackSecuritySsl    `json:"http"`
	Transport *NodeInfoXpackSecuritySsl   `json:"transport,omitempty"`
}

NodeInfoXpackSecurity type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L234-L239

func NewNodeInfoXpackSecurity ¶ added in v8.5.0 

func NewNodeInfoXpackSecurity() *NodeInfoXpackSecurity

NewNodeInfoXpackSecurity returns a NodeInfoXpackSecurity.

type NodeInfoXpackSecurityAuthc ¶ 

type NodeInfoXpackSecurityAuthc struct {
	Realms NodeInfoXpackSecurityAuthcRealms `json:"realms"`
	Token  NodeInfoXpackSecurityAuthcToken  `json:"token"`
}

NodeInfoXpackSecurityAuthc type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L245-L248

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L250-L254

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L260-L263

func NewNodeInfoXpackSecurityAuthcRealmsStatus ¶ added in v8.5.0 

func NewNodeInfoXpackSecurityAuthcRealmsStatus() *NodeInfoXpackSecurityAuthcRealmsStatus

NewNodeInfoXpackSecurityAuthcRealmsStatus returns a NodeInfoXpackSecurityAuthcRealmsStatus.

type NodeInfoXpackSecurityAuthcToken ¶ 

type NodeInfoXpackSecurityAuthcToken struct {
	Enabled string `json:"enabled"`
}

NodeInfoXpackSecurityAuthcToken type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L256-L258

func NewNodeInfoXpackSecurityAuthcToken ¶ added in v8.5.0 

func NewNodeInfoXpackSecurityAuthcToken() *NodeInfoXpackSecurityAuthcToken

NewNodeInfoXpackSecurityAuthcToken returns a NodeInfoXpackSecurityAuthcToken.

type NodeInfoXpackSecuritySsl ¶ 

type NodeInfoXpackSecuritySsl struct {
	Ssl map[string]string `json:"ssl"`
}

NodeInfoXpackSecuritySsl type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L241-L243

func NewNodeInfoXpackSecuritySsl ¶ added in v8.5.0 

func NewNodeInfoXpackSecuritySsl() *NodeInfoXpackSecuritySsl

NewNodeInfoXpackSecuritySsl returns a NodeInfoXpackSecuritySsl.

type NodeJvmInfo ¶ 

type NodeJvmInfo struct {
	BundledJdk                            bool              `json:"bundled_jdk"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L348-L362

func NewNodeJvmInfo ¶ added in v8.5.0 

func NewNodeJvmInfo() *NodeJvmInfo

NewNodeJvmInfo returns a NodeJvmInfo.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L364-L381

func NewNodeOperatingSystemInfo ¶ added in v8.5.0 

func NewNodeOperatingSystemInfo() *NodeOperatingSystemInfo

NewNodeOperatingSystemInfo returns a NodeOperatingSystemInfo.

type NodePackagingType ¶ 

type NodePackagingType struct {
	Count  int    `json:"count"`
	Flavor string `json:"flavor"`
	Type   string `json:"type"`
}

NodePackagingType type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L276-L280

func NewNodePackagingType ¶ added in v8.5.0 

func NewNodePackagingType() *NodePackagingType

NewNodePackagingType returns a NodePackagingType.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L383-L390

func NewNodeProcessInfo ¶ added in v8.5.0 

func NewNodeProcessInfo() *NodeProcessInfo

NewNodeProcessInfo returns a NodeProcessInfo.

type NodeReloadError ¶ 

type NodeReloadError struct {
	Name            string      `json:"name"`
	ReloadException *ErrorCause `json:"reload_exception,omitempty"`
}

NodeReloadError type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/NodeReloadResult.ts#L24-L27

func NewNodeReloadError ¶ added in v8.5.0 

func NewNodeReloadError() *NodeReloadError

NewNodeReloadError returns a NodeReloadError.

type NodeReloadResult ¶ 

type NodeReloadResult interface {
	// contains filtered or unexported methods
}

NodeReloadResult holds the union for the following types: 

Stats
NodeReloadError

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/NodeReloadResult.ts#L29-L30

type NodeRoles ¶ 

type NodeRoles []noderole.NodeRole

NodeRoles type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Node.ts#L91-L94

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"`
	Shard          int                                 `json:"shard"`
	State          shardroutingstate.ShardRoutingState `json:"state"`
	UnassignedInfo *UnassignedInformation              `json:"unassigned_info,omitempty"`
}

NodeShard type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Node.ts#L59-L69

func NewNodeShard ¶ added in v8.5.0 

func NewNodeShard() *NodeShard

NewNodeShard returns a NodeShard.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L29-L38

func NewNodeShutdownStatus ¶ added in v8.5.0 

func NewNodeShutdownStatus() *NodeShutdownStatus

NewNodeShutdownStatus returns a NodeShutdownStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Node.ts#L28-L39

func NewNodeStatistics ¶ added in v8.5.0 

func NewNodeStatistics() *NodeStatistics

NewNodeStatistics returns a NodeStatistics.

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[TaskId]TaskInfo `json:"tasks"`
	TransportAddress *string             `json:"transport_address,omitempty"`
}

NodeTasks type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/tasks/_types/TaskListResponseBase.ts#L49-L57

func NewNodeTasks ¶ added in v8.5.0 

func NewNodeTasks() *NodeTasks

NewNodeTasks returns a NodeTasks.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/info/types.ts#L286-L293

func NewNodeThreadPoolInfo ¶ added in v8.5.0 

func NewNodeThreadPoolInfo() *NodeThreadPoolInfo

NewNodeThreadPoolInfo returns a NodeThreadPoolInfo.

type NodeUsage ¶ 

type NodeUsage struct {
	Aggregations map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/usage/types.ts#L25-L30

func NewNodeUsage ¶ added in v8.5.0 

func NewNodeUsage() *NodeUsage

NewNodeUsage returns a NodeUsage.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L390-L395

func NewNodesContext ¶ added in v8.5.0 

func NewNodesContext() *NodesContext

NewNodesContext returns a NodesContext.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 *NodesIndexingPressureMemory `json:"memory,omitempty"`
}

NodesIndexingPressure type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L55-L57

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      *PressureMemory `json:"current,omitempty"`
	LimitInBytes *int64          `json:"limit_in_bytes,omitempty"`
	Total        *PressureMemory `json:"total,omitempty"`
}

NodesIndexingPressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L59-L63

func NewNodesIndexingPressureMemory ¶ added in v8.5.0 

func NewNodesIndexingPressureMemory() *NodesIndexingPressureMemory

NewNodesIndexingPressureMemory returns a NodesIndexingPressureMemory.

type NodesIngest ¶ added in v8.5.0 

type NodesIngest struct {
	Pipelines map[string]IngestTotal `json:"pipelines,omitempty"`
	Total     *IngestTotal           `json:"total,omitempty"`
}

NodesIngest type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L138-L141

func NewNodesIngest ¶ added in v8.5.0 

func NewNodesIngest() *NodesIngest

NewNodesIngest returns a NodesIngest.

type NodesRecord ¶ 

type NodesRecord struct {
	// Build es build hash
	Build *string `json:"build,omitempty"`
	// 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"`
	// Cpu recent cpu usage
	Cpu *string `json:"cpu,omitempty"`
	// DiskAvail available disk space
	DiskAvail *ByteSize `json:"disk.avail,omitempty"`
	// DiskTotal total disk space
	DiskTotal *ByteSize `json:"disk.total,omitempty"`
	// DiskUsed used disk space
	DiskUsed *ByteSize `json:"disk.used,omitempty"`
	// DiskUsedPercent used disk space percentage
	DiskUsedPercent *Percentage `json:"disk.used_percent,omitempty"`
	// FielddataEvictions fielddata evictions
	FielddataEvictions *string `json:"fielddata.evictions,omitempty"`
	// FielddataMemorySize used fielddata cache
	FielddataMemorySize *string `json:"fielddata.memory_size,omitempty"`
	// FileDescCurrent used file descriptors
	FileDescCurrent *string `json:"file_desc.current,omitempty"`
	// FileDescMax max file descriptors
	FileDescMax *string `json:"file_desc.max,omitempty"`
	// FileDescPercent used file descriptor ratio
	FileDescPercent *Percentage `json:"file_desc.percent,omitempty"`
	// Flavor es distribution flavor
	Flavor *string `json:"flavor,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"`
	// HeapCurrent used heap
	HeapCurrent *string `json:"heap.current,omitempty"`
	// HeapMax max configured heap
	HeapMax *string `json:"heap.max,omitempty"`
	// HeapPercent used heap ratio
	HeapPercent *Percentage `json:"heap.percent,omitempty"`
	// HttpAddress bound http address
	HttpAddress *string `json:"http_address,omitempty"`
	// Id unique node id
	Id *string `json:"id,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"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// Jdk jdk version
	Jdk *string `json:"jdk,omitempty"`
	// Load15m 15m load avg
	Load15m *string `json:"load_15m,omitempty"`
	// Load1m 1m load avg
	Load1m *string `json:"load_1m,omitempty"`
	// Load5m 5m load avg
	Load5m *string `json:"load_5m,omitempty"`
	// Master *:current master
	Master *string `json:"master,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"`
	// Name node name
	Name *string `json:"name,omitempty"`
	// NodeRole m:master eligible node, d:data node, i:ingest node, -:coordinating node only
	NodeRole *string `json:"node.role,omitempty"`
	// Pid process id
	Pid *string `json:"pid,omitempty"`
	// Port bound transport port
	Port *string `json:"port,omitempty"`
	// QueryCacheEvictions query cache evictions
	QueryCacheEvictions *string `json:"query_cache.evictions,omitempty"`
	// QueryCacheHitCount query cache hit counts
	QueryCacheHitCount *string `json:"query_cache.hit_count,omitempty"`
	// QueryCacheMemorySize used query cache
	QueryCacheMemorySize *string `json:"query_cache.memory_size,omitempty"`
	// QueryCacheMissCount query cache miss counts
	QueryCacheMissCount *string `json:"query_cache.miss_count,omitempty"`
	// RamCurrent used machine memory
	RamCurrent *string `json:"ram.current,omitempty"`
	// RamMax total machine memory
	RamMax *string `json:"ram.max,omitempty"`
	// RamPercent used machine memory ratio
	RamPercent *Percentage `json:"ram.percent,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"`
	// RequestCacheEvictions request cache evictions
	RequestCacheEvictions *string `json:"request_cache.evictions,omitempty"`
	// RequestCacheHitCount request cache hit counts
	RequestCacheHitCount *string `json:"request_cache.hit_count,omitempty"`
	// RequestCacheMemorySize used request cache
	RequestCacheMemorySize *string `json:"request_cache.memory_size,omitempty"`
	// RequestCacheMissCount request cache miss counts
	RequestCacheMissCount *string `json:"request_cache.miss_count,omitempty"`
	// ScriptCacheEvictions script cache evictions
	ScriptCacheEvictions *string `json:"script.cache_evictions,omitempty"`
	// ScriptCompilationLimitTriggered script cache compilation limit triggered
	ScriptCompilationLimitTriggered *string `json:"script.compilation_limit_triggered,omitempty"`
	// ScriptCompilations script compilations
	ScriptCompilations *string `json:"script.compilations,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"`
	// 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"`
	// 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"`
	// Type es distribution type
	Type *string `json:"type,omitempty"`
	// Uptime node uptime
	Uptime *string `json:"uptime,omitempty"`
	// Version es version
	Version *string `json:"version,omitempty"`
}

NodesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/nodes/types.ts#L23-L541

func NewNodesRecord ¶ added in v8.5.0 

func NewNodesRecord() *NodesRecord

NewNodesRecord returns a NodesRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L66-L72

func NewNoriAnalyzer ¶ added in v8.5.0 

func NewNoriAnalyzer() *NoriAnalyzer

NewNoriAnalyzer returns a NoriAnalyzer.

type NoriPartOfSpeechTokenFilter ¶ 

type NoriPartOfSpeechTokenFilter struct {
	Stoptags []string `json:"stoptags,omitempty"`
	Type     string   `json:"type,omitempty"`
	Version  *string  `json:"version,omitempty"`
}

NoriPartOfSpeechTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L272-L275

func NewNoriPartOfSpeechTokenFilter ¶ added in v8.5.0 

func NewNoriPartOfSpeechTokenFilter() *NoriPartOfSpeechTokenFilter

NewNoriPartOfSpeechTokenFilter returns a NoriPartOfSpeechTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L80-L86

func NewNoriTokenizer ¶ added in v8.5.0 

func NewNoriTokenizer() *NoriTokenizer

NewNoriTokenizer returns a NoriTokenizer.

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      *string                          `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy             `json:"gap_policy,omitempty"`
	Meta        map[string]interface{}           `json:"meta,omitempty"`
	Method      *normalizemethod.NormalizeMethod `json:"method,omitempty"`
	Name        *string                          `json:"name,omitempty"`
}

NormalizeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L262-L264

func NewNormalizeAggregation ¶ added in v8.5.0 

func NewNormalizeAggregation() *NormalizeAggregation

NewNormalizeAggregation returns a NormalizeAggregation.

type Normalizer ¶ 

type Normalizer interface {
	// contains filtered or unexported methods
}

Normalizer holds the union for the following types: 

LowercaseNormalizer
CustomNormalizer

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/normalizers.ts#L20-L24

type NumberRangeQuery ¶ 

type NumberRangeQuery struct {
	Boost      *float32                     `json:"boost,omitempty"`
	From       float64                      `json:"from,omitempty"`
	Gt         *float64                     `json:"gt,omitempty"`
	Gte        *float64                     `json:"gte,omitempty"`
	Lt         *float64                     `json:"lt,omitempty"`
	Lte        *float64                     `json:"lte,omitempty"`
	QueryName_ *string                      `json:"_name,omitempty"`
	Relation   *rangerelation.RangeRelation `json:"relation,omitempty"`
	To         float64                      `json:"to,omitempty"`
}

NumberRangeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L83-L90

func NewNumberRangeQuery ¶ added in v8.5.0 

func NewNumberRangeQuery() *NumberRangeQuery

NewNumberRangeQuery returns a NumberRangeQuery.

type NumericDecayFunction ¶ 

type NumericDecayFunction struct {
	MultiValueMode       *multivaluemode.MultiValueMode        `json:"multi_value_mode,omitempty"`
	NumericDecayFunction map[string]DecayPlacementdoubledouble `json:"-"`
}

NumericDecayFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L88-L90

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

ObjectProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/complex.ts#L46-L49

func NewObjectProperty ¶ added in v8.5.0 

func NewObjectProperty() *ObjectProperty

NewObjectProperty returns a ObjectProperty.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L44-L47

func NewOneHotEncodingPreprocessor ¶ added in v8.5.0 

func NewOneHotEncodingPreprocessor() *OneHotEncodingPreprocessor

NewOneHotEncodingPreprocessor returns a OneHotEncodingPreprocessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L367-L373

func NewOperatingSystem ¶ added in v8.5.0 

func NewOperatingSystem() *OperatingSystem

NewOperatingSystem returns a OperatingSystem.

type OperatingSystemMemoryInfo ¶ 

type OperatingSystemMemoryInfo struct {
	AdjustedTotalInBytes *int64 `json:"adjusted_total_in_bytes,omitempty"`
	FreeInBytes          int64  `json:"free_in_bytes"`
	FreePercent          int    `json:"free_percent"`
	TotalInBytes         int64  `json:"total_in_bytes"`
	UsedInBytes          int64  `json:"used_in_bytes"`
	UsedPercent          int    `json:"used_percent"`
}

OperatingSystemMemoryInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/stats/types.ts#L282-L290

func NewOperatingSystemMemoryInfo ¶ added in v8.5.0 

func NewOperatingSystemMemoryInfo() *OperatingSystemMemoryInfo

NewOperatingSystemMemoryInfo returns a OperatingSystemMemoryInfo.

type OutlierDetectionParameters ¶ 

type OutlierDetectionParameters struct {
	ComputeFeatureInfluence   *bool    `json:"compute_feature_influence,omitempty"`
	FeatureInfluenceThreshold *float64 `json:"feature_influence_threshold,omitempty"`
	Method                    *string  `json:"method,omitempty"`
	NNeighbors                *int     `json:"n_neighbors,omitempty"`
	OutlierFraction           *float64 `json:"outlier_fraction,omitempty"`
	StandardizationEnabled    *bool    `json:"standardization_enabled,omitempty"`
}

OutlierDetectionParameters type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L412-L419

func NewOutlierDetectionParameters ¶ added in v8.5.0 

func NewOutlierDetectionParameters() *OutlierDetectionParameters

NewOutlierDetectionParameters returns a OutlierDetectionParameters.

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"`
}

OverallBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Bucket.ts#L130-L145

func NewOverallBucket ¶ added in v8.5.0 

func NewOverallBucket() *OverallBucket

NewOverallBucket returns a OverallBucket.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Bucket.ts#L146-L149

func NewOverallBucketJob ¶ added in v8.5.0 

func NewOverallBucketJob() *OverallBucketJob

NewOverallBucketJob returns a OverallBucketJob.

type Overlapping ¶ 

type Overlapping struct {
	IndexPatterns []string `json:"index_patterns"`
	Name          string   `json:"name"`
}

Overlapping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts#L39-L42

func NewOverlapping ¶ added in v8.5.0 

func NewOverlapping() *Overlapping

NewOverlapping returns a Overlapping.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Page.ts#L22-L33

func NewPage ¶ added in v8.5.0 

func NewPage() *Page

NewPage returns a Page.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L54-L54

func NewPagerDutyAction ¶ added in v8.5.0 

func NewPagerDutyAction() *PagerDutyAction

NewPagerDutyAction returns a PagerDutyAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L61-L65

func NewPagerDutyContext ¶ added in v8.5.0 

func NewPagerDutyContext() *PagerDutyContext

NewPagerDutyContext returns a PagerDutyContext.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L40-L52

func NewPagerDutyEvent ¶ added in v8.5.0 

func NewPagerDutyEvent() *PagerDutyEvent

NewPagerDutyEvent returns a PagerDutyEvent.

type PagerDutyEventProxy ¶ 

type PagerDutyEventProxy struct {
	Host *string `json:"host,omitempty"`
	Port *int    `json:"port,omitempty"`
}

PagerDutyEventProxy type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L56-L59

func NewPagerDutyEventProxy ¶ added in v8.5.0 

func NewPagerDutyEventProxy() *PagerDutyEventProxy

NewPagerDutyEventProxy returns a PagerDutyEventProxy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L78-L83

func NewPagerDutyResult ¶ added in v8.5.0 

func NewPagerDutyResult() *PagerDutyResult

NewPagerDutyResult returns a PagerDutyResult.

type PainlessContextSetup ¶ 

type PainlessContextSetup struct {
	Document interface{} `json:"document,omitempty"`
	Index    string      `json:"index"`
	Query    Query       `json:"query"`
}

PainlessContextSetup type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/scripts_painless_execute/types.ts#L25-L29

func NewPainlessContextSetup ¶ added in v8.5.0 

func NewPainlessContextSetup() *PainlessContextSetup

NewPainlessContextSetup returns a PainlessContextSetup.

type ParentAggregate ¶ 

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

ParentAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L770-L771

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

type ParentAggregation ¶ 

type ParentAggregation struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
	Type *string                `json:"type,omitempty"`
}

ParentAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L285-L287

func NewParentAggregation ¶ added in v8.5.0 

func NewParentAggregation() *ParentAggregation

NewParentAggregation returns a ParentAggregation.

type ParentIdQuery ¶ 

type ParentIdQuery struct {
	Boost          *float32 `json:"boost,omitempty"`
	Id             *string  `json:"id,omitempty"`
	IgnoreUnmapped *bool    `json:"ignore_unmapped,omitempty"`
	QueryName_     *string  `json:"_name,omitempty"`
	Type           *string  `json:"type,omitempty"`
}

ParentIdQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/joining.ts#L73-L78

func NewParentIdQuery ¶ added in v8.5.0 

func NewParentIdQuery() *ParentIdQuery

NewParentIdQuery returns a ParentIdQuery.

type ParentTaskInfo ¶ 

type ParentTaskInfo struct {
	Action             string            `json:"action"`
	Cancellable        bool              `json:"cancellable"`
	Cancelled          *bool             `json:"cancelled,omitempty"`
	Children           []TaskInfo        `json:"children,omitempty"`
	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             *TaskStatus       `json:"status,omitempty"`
	Type               string            `json:"type"`
}

ParentTaskInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/tasks/_types/TaskListResponseBase.ts#L45-L47

func NewParentTaskInfo ¶ added in v8.5.0 

func NewParentTaskInfo() *ParentTaskInfo

NewParentTaskInfo returns a ParentTaskInfo.

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"`
}

PassThroughInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L209-L215

func NewPassThroughInferenceOptions ¶ added in v8.5.0 

func NewPassThroughInferenceOptions() *PassThroughInferenceOptions

NewPassThroughInferenceOptions returns a PassThroughInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L344-L349

func NewPassThroughInferenceUpdateOptions ¶ added in v8.5.0 

func NewPassThroughInferenceUpdateOptions() *PassThroughInferenceUpdateOptions

NewPassThroughInferenceUpdateOptions returns a PassThroughInferenceUpdateOptions.

type PathHierarchyTokenizer ¶ 

type PathHierarchyTokenizer struct {
	BufferSize  int     `json:"buffer_size"`
	Delimiter   string  `json:"delimiter"`
	Replacement string  `json:"replacement"`
	Reverse     bool    `json:"reverse"`
	Skip        int     `json:"skip"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
}

PathHierarchyTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L88-L95

func NewPathHierarchyTokenizer ¶ added in v8.5.0 

func NewPathHierarchyTokenizer() *PathHierarchyTokenizer

NewPathHierarchyTokenizer returns a PathHierarchyTokenizer.

type PatternAnalyzer ¶ 

type PatternAnalyzer struct {
	Flags     *string  `json:"flags,omitempty"`
	Lowercase *bool    `json:"lowercase,omitempty"`
	Pattern   string   `json:"pattern"`
	Stopwords []string `json:"stopwords,omitempty"`
	Type      string   `json:"type,omitempty"`
	Version   *string  `json:"version,omitempty"`
}

PatternAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L74-L81

func NewPatternAnalyzer ¶ added in v8.5.0 

func NewPatternAnalyzer() *PatternAnalyzer

NewPatternAnalyzer returns a PatternAnalyzer.

type PatternCaptureTokenFilter ¶ 

type PatternCaptureTokenFilter struct {
	Patterns         []string `json:"patterns"`
	PreserveOriginal *bool    `json:"preserve_original,omitempty"`
	Type             string   `json:"type,omitempty"`
	Version          *string  `json:"version,omitempty"`
}

PatternCaptureTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L277-L281

func NewPatternCaptureTokenFilter ¶ added in v8.5.0 

func NewPatternCaptureTokenFilter() *PatternCaptureTokenFilter

NewPatternCaptureTokenFilter returns a PatternCaptureTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/char_filters.ts#L53-L58

func NewPatternReplaceCharFilter ¶ added in v8.5.0 

func NewPatternReplaceCharFilter() *PatternReplaceCharFilter

NewPatternReplaceCharFilter returns a PatternReplaceCharFilter.

type PatternReplaceTokenFilter ¶ 

type PatternReplaceTokenFilter struct {
	All         *bool   `json:"all,omitempty"`
	Flags       *string `json:"flags,omitempty"`
	Pattern     string  `json:"pattern"`
	Replacement *string `json:"replacement,omitempty"`
	Type        string  `json:"type,omitempty"`
	Version     *string `json:"version,omitempty"`
}

PatternReplaceTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L283-L289

func NewPatternReplaceTokenFilter ¶ added in v8.5.0 

func NewPatternReplaceTokenFilter() *PatternReplaceTokenFilter

NewPatternReplaceTokenFilter returns a PatternReplaceTokenFilter.

type PatternTokenizer ¶ 

type PatternTokenizer struct {
	Flags   string  `json:"flags"`
	Group   int     `json:"group"`
	Pattern string  `json:"pattern"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PatternTokenizer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L97-L102

func NewPatternTokenizer ¶ added in v8.5.0 

func NewPatternTokenizer() *PatternTokenizer

NewPatternTokenizer returns a PatternTokenizer.

type PendingTask ¶ 

type PendingTask struct {
	Executing         bool      `json:"executing"`
	InsertOrder       int       `json:"insert_order"`
	Priority          string    `json:"priority"`
	Source            string    `json:"source"`
	TimeInQueue       *Duration `json:"time_in_queue,omitempty"`
	TimeInQueueMillis int64     `json:"time_in_queue_millis"`
}

PendingTask type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/pending_tasks/types.ts#L23-L30

func NewPendingTask ¶ added in v8.5.0 

func NewPendingTask() *PendingTask

NewPendingTask returns a PendingTask.

type PendingTasksRecord ¶ 

type PendingTasksRecord struct {
	// InsertOrder task insertion order
	InsertOrder *string `json:"insertOrder,omitempty"`
	// Priority task priority
	Priority *string `json:"priority,omitempty"`
	// Source task source
	Source *string `json:"source,omitempty"`
	// TimeInQueue how long task has been in queue
	TimeInQueue *string `json:"timeInQueue,omitempty"`
}

PendingTasksRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/pending_tasks/types.ts#L20-L41

func NewPendingTasksRecord ¶ added in v8.5.0 

func NewPendingTasksRecord() *PendingTasksRecord

NewPendingTasksRecord returns a PendingTasksRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Analysis.ts#L93-L102

func NewPerPartitionCategorization ¶ added in v8.5.0 

func NewPerPartitionCategorization() *PerPartitionCategorization

NewPerPartitionCategorization returns a PerPartitionCategorization.

type Percentage ¶ 

type Percentage interface{}

Percentage holds the union for the following types: 

string
float32

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Numeric.ts#L28-L28

type PercentageScoreHeuristic ¶ 

type PercentageScoreHeuristic struct {
}

PercentageScoreHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L336-L336

func NewPercentageScoreHeuristic ¶ added in v8.5.0 

func NewPercentageScoreHeuristic() *PercentageScoreHeuristic

NewPercentageScoreHeuristic returns a PercentageScoreHeuristic.

type PercentileRanksAggregation ¶ 

type PercentileRanksAggregation struct {
	Field   *string    `json:"field,omitempty"`
	Format  *string    `json:"format,omitempty"`
	Hdr     *HdrMethod `json:"hdr,omitempty"`
	Keyed   *bool      `json:"keyed,omitempty"`
	Missing *Missing   `json:"missing,omitempty"`
	Script  *Script    `json:"script,omitempty"`
	Tdigest *TDigest   `json:"tdigest,omitempty"`
	Values  []float64  `json:"values,omitempty"`
}

PercentileRanksAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L105-L110

func NewPercentileRanksAggregation ¶ added in v8.5.0 

func NewPercentileRanksAggregation() *PercentileRanksAggregation

NewPercentileRanksAggregation returns a PercentileRanksAggregation.

type Percentiles ¶ 

type Percentiles interface{}

Percentiles holds the union for the following types: 

map[string]string
[]ArrayPercentilesItem

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L149-L150

type PercentilesAggregation ¶ 

type PercentilesAggregation struct {
	Field    *string    `json:"field,omitempty"`
	Format   *string    `json:"format,omitempty"`
	Hdr      *HdrMethod `json:"hdr,omitempty"`
	Keyed    *bool      `json:"keyed,omitempty"`
	Missing  *Missing   `json:"missing,omitempty"`
	Percents []float64  `json:"percents,omitempty"`
	Script   *Script    `json:"script,omitempty"`
	Tdigest  *TDigest   `json:"tdigest,omitempty"`
}

PercentilesAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L112-L117

func NewPercentilesAggregation ¶ added in v8.5.0 

func NewPercentilesAggregation() *PercentilesAggregation

NewPercentilesAggregation returns a PercentilesAggregation.

type PercentilesBucketAggregate ¶ 

type PercentilesBucketAggregate struct {
	Meta   map[string]interface{} `json:"meta,omitempty"`
	Values Percentiles            `json:"values"`
}

PercentilesBucketAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L177-L178

func NewPercentilesBucketAggregate ¶ added in v8.5.0 

func NewPercentilesBucketAggregate() *PercentilesBucketAggregate

NewPercentilesBucketAggregate returns a PercentilesBucketAggregate.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Percents    []float64              `json:"percents,omitempty"`
}

PercentilesBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L276-L278

func NewPercentilesBucketAggregation ¶ added in v8.5.0 

func NewPercentilesBucketAggregation() *PercentilesBucketAggregation

NewPercentilesBucketAggregation returns a PercentilesBucketAggregation.

type PercolateQuery ¶ 

type PercolateQuery struct {
	Boost      *float32      `json:"boost,omitempty"`
	Document   interface{}   `json:"document,omitempty"`
	Documents  []interface{} `json:"documents,omitempty"`
	Field      string        `json:"field"`
	Id         *string       `json:"id,omitempty"`
	Index      *string       `json:"index,omitempty"`
	Name       *string       `json:"name,omitempty"`
	Preference *string       `json:"preference,omitempty"`
	QueryName_ *string       `json:"_name,omitempty"`
	Routing    *string       `json:"routing,omitempty"`
	Version    *int64        `json:"version,omitempty"`
}

PercolateQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L110-L120

func NewPercolateQuery ¶ added in v8.5.0 

func NewPercolateQuery() *PercolateQuery

NewPercolateQuery returns a PercolateQuery.

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"`
	Type       string              `json:"type,omitempty"`
}

PercolatorProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L177-L179

func NewPercolatorProperty ¶ added in v8.5.0 

func NewPercolatorProperty() *PercolatorProperty

NewPercolatorProperty returns a PercolatorProperty.

type PersistentTaskStatus ¶ 

type PersistentTaskStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

PersistentTaskStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
	Configurations *Configurations `json:"configurations,omitempty"`
	MinAge         Duration        `json:"min_age,omitempty"`
}

Phase type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L25-L33

func NewPhase ¶ added in v8.5.0 

func NewPhase() *Phase

NewPhase returns a Phase.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L35-L41

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"`
	MaxCodeLen  *int                                `json:"max_code_len,omitempty"`
	NameType    phoneticnametype.PhoneticNameType   `json:"name_type"`
	Replace     *bool                               `json:"replace,omitempty"`
	RuleType    phoneticruletype.PhoneticRuleType   `json:"rule_type"`
	Type        string                              `json:"type,omitempty"`
	Version     *string                             `json:"version,omitempty"`
}

PhoneticTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/phonetic-plugin.ts#L64-L72

func NewPhoneticTokenFilter ¶ added in v8.5.0 

func NewPhoneticTokenFilter() *PhoneticTokenFilter

NewPhoneticTokenFilter returns a PhoneticTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L57-L62

func NewPhraseSuggest ¶ added in v8.5.0 

func NewPhraseSuggest() *PhraseSuggest

NewPhraseSuggest returns a PhraseSuggest.

type PhraseSuggestCollate ¶ 

type PhraseSuggestCollate struct {
	Params map[string]interface{}    `json:"params,omitempty"`
	Prune  *bool                     `json:"prune,omitempty"`
	Query  PhraseSuggestCollateQuery `json:"query"`
}

PhraseSuggestCollate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L180-L184

func NewPhraseSuggestCollate ¶ added in v8.5.0 

func NewPhraseSuggestCollate() *PhraseSuggestCollate

NewPhraseSuggestCollate returns a PhraseSuggestCollate.

type PhraseSuggestCollateQuery ¶ 

type PhraseSuggestCollateQuery struct {
	Id     *string `json:"id,omitempty"`
	Source *string `json:"source,omitempty"`
}

PhraseSuggestCollateQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L186-L189

func NewPhraseSuggestCollateQuery ¶ added in v8.5.0 

func NewPhraseSuggestCollateQuery() *PhraseSuggestCollateQuery

NewPhraseSuggestCollateQuery returns a PhraseSuggestCollateQuery.

type PhraseSuggestHighlight ¶ 

type PhraseSuggestHighlight struct {
	PostTag string `json:"post_tag"`
	PreTag  string `json:"pre_tag"`
}

PhraseSuggestHighlight type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L207-L210

func NewPhraseSuggestHighlight ¶ added in v8.5.0 

func NewPhraseSuggestHighlight() *PhraseSuggestHighlight

NewPhraseSuggestHighlight returns a PhraseSuggestHighlight.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L86-L91

func NewPhraseSuggestOption ¶ added in v8.5.0 

func NewPhraseSuggestOption() *PhraseSuggestOption

NewPhraseSuggestOption returns a PhraseSuggestOption.

type PhraseSuggester ¶ 

type PhraseSuggester struct {
	Analyzer                *string                  `json:"analyzer,omitempty"`
	Collate                 *PhraseSuggestCollate    `json:"collate,omitempty"`
	Confidence              *float64                 `json:"confidence,omitempty"`
	DirectGenerator         []DirectGenerator        `json:"direct_generator,omitempty"`
	Field                   string                   `json:"field"`
	ForceUnigrams           *bool                    `json:"force_unigrams,omitempty"`
	GramSize                *int                     `json:"gram_size,omitempty"`
	Highlight               *PhraseSuggestHighlight  `json:"highlight,omitempty"`
	MaxErrors               *float64                 `json:"max_errors,omitempty"`
	RealWordErrorLikelihood *float64                 `json:"real_word_error_likelihood,omitempty"`
	Separator               *string                  `json:"separator,omitempty"`
	ShardSize               *int                     `json:"shard_size,omitempty"`
	Size                    *int                     `json:"size,omitempty"`
	Smoothing               *SmoothingModelContainer `json:"smoothing,omitempty"`
	Text                    *string                  `json:"text,omitempty"`
	TokenLimit              *int                     `json:"token_limit,omitempty"`
}

PhraseSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L191-L205

func NewPhraseSuggester ¶ added in v8.5.0 

func NewPhraseSuggester() *PhraseSuggester

NewPhraseSuggester returns a PhraseSuggester.

type PinnedDoc ¶ 

type PinnedDoc struct {
	Id_    string `json:"_id"`
	Index_ string `json:"_index"`
}

PinnedDoc type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L132-L135

func NewPinnedDoc ¶ added in v8.5.0 

func NewPinnedDoc() *PinnedDoc

NewPinnedDoc returns a PinnedDoc.

type PinnedQuery ¶ 

type PinnedQuery struct {
	Boost      *float32    `json:"boost,omitempty"`
	Docs       []PinnedDoc `json:"docs,omitempty"`
	Ids        []string    `json:"ids,omitempty"`
	Organic    *Query      `json:"organic,omitempty"`
	QueryName_ *string     `json:"_name,omitempty"`
}

PinnedQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L122-L130

func NewPinnedQuery ¶ added in v8.5.0 

func NewPinnedQuery() *PinnedQuery

NewPinnedQuery returns a PinnedQuery.

type PipelineConfig ¶ 

type PipelineConfig struct {
	Description *string              `json:"description,omitempty"`
	Processors  []ProcessorContainer `json:"processors"`
	Version     *int64               `json:"version,omitempty"`
}

PipelineConfig type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Pipeline.ts#L44-L48

func NewPipelineConfig ¶ added in v8.5.0 

func NewPipelineConfig() *PipelineConfig

NewPipelineConfig returns a PipelineConfig.

type PipelineMetadata ¶ 

type PipelineMetadata struct {
	Type    string `json:"type"`
	Version string `json:"version"`
}

PipelineMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/logstash/_types/Pipeline.ts#L23-L26

func NewPipelineMetadata ¶ added in v8.5.0 

func NewPipelineMetadata() *PipelineMetadata

NewPipelineMetadata returns a PipelineMetadata.

type PipelineProcessor ¶ 

type PipelineProcessor struct {
	Description           *string              `json:"description,omitempty"`
	If                    *string              `json:"if,omitempty"`
	IgnoreFailure         *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissingPipeline *bool                `json:"ignore_missing_pipeline,omitempty"`
	Name                  string               `json:"name"`
	OnFailure             []ProcessorContainer `json:"on_failure,omitempty"`
	Tag                   *string              `json:"tag,omitempty"`
}

PipelineProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L306-L309

func NewPipelineProcessor ¶ added in v8.5.0 

func NewPipelineProcessor() *PipelineProcessor

NewPipelineProcessor returns a PipelineProcessor.

type PipelineSettings ¶ 

type PipelineSettings struct {
	PipelineBatchDelay    int    `json:"pipeline.batch.delay"`
	PipelineBatchSize     int    `json:"pipeline.batch.size"`
	PipelineWorkers       int    `json:"pipeline.workers"`
	QueueCheckpointWrites int    `json:"queue.checkpoint.writes"`
	QueueMaxBytesNumber   int    `json:"queue.max_bytes.number"`
	QueueMaxBytesUnits    string `json:"queue.max_bytes.units"`
	QueueType             string `json:"queue.type"`
}

PipelineSettings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/logstash/_types/Pipeline.ts#L28-L36

func NewPipelineSettings ¶ added in v8.5.0 

func NewPipelineSettings() *PipelineSettings

NewPipelineSettings returns a PipelineSettings.

type PipelineSimulation ¶ 

type PipelineSimulation struct {
	Doc              *DocumentSimulation                      `json:"doc,omitempty"`
	ProcessorResults []PipelineSimulation                     `json:"processor_results,omitempty"`
	ProcessorType    *string                                  `json:"processor_type,omitempty"`
	Status           *actionstatusoptions.ActionStatusOptions `json:"status,omitempty"`
	Tag              *string                                  `json:"tag,omitempty"`
}

PipelineSimulation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/simulate/types.ts#L33-L39

func NewPipelineSimulation ¶ added in v8.5.0 

func NewPipelineSimulation() *PipelineSimulation

NewPipelineSimulation returns a PipelineSimulation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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"`
	Type                 string   `json:"type"`
	Version              string   `json:"version"`
}

PluginStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L137-L148

func NewPluginStats ¶ added in v8.5.0 

func NewPluginStats() *PluginStats

NewPluginStats returns a PluginStats.

type PluginsRecord ¶ 

type PluginsRecord struct {
	// Component component
	Component *string `json:"component,omitempty"`
	// Description plugin details
	Description *string `json:"description,omitempty"`
	// Id unique node id
	Id *string `json:"id,omitempty"`
	// Name node name
	Name *string `json:"name,omitempty"`
	// Type plugin type
	Type *string `json:"type,omitempty"`
	// Version component version
	Version *string `json:"version,omitempty"`
}

PluginsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/plugins/types.ts#L22-L52

func NewPluginsRecord ¶ added in v8.5.0 

func NewPluginsRecord() *PluginsRecord

NewPluginsRecord returns a PluginsRecord.

type PluginsStatus ¶ 

type PluginsStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

PluginsStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/PointInTimeReference.ts#L23-L26

func NewPointInTimeReference ¶ added in v8.5.0 

func NewPointInTimeReference() *PointInTimeReference

NewPointInTimeReference returns a PointInTimeReference.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

PointProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/geo.ts#L62-L67

func NewPointProperty ¶ added in v8.5.0 

func NewPointProperty() *PointProperty

NewPointProperty returns a PointProperty.

type Pool ¶ 

type Pool struct {
	MaxInBytes      *int64 `json:"max_in_bytes,omitempty"`
	PeakMaxInBytes  *int64 `json:"peak_max_in_bytes,omitempty"`
	PeakUsedInBytes *int64 `json:"peak_used_in_bytes,omitempty"`
	UsedInBytes     *int64 `json:"used_in_bytes,omitempty"`
}

Pool type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L339-L344

func NewPool ¶ added in v8.5.0 

func NewPool() *Pool

NewPool returns a Pool.

type PorterStemTokenFilter ¶ 

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

PorterStemTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L291-L293

func NewPorterStemTokenFilter ¶ added in v8.5.0 

func NewPorterStemTokenFilter() *PorterStemTokenFilter

NewPorterStemTokenFilter returns a PorterStemTokenFilter.

type PostMigrationFeature ¶ added in v8.5.0 

type PostMigrationFeature struct {
	FeatureName string `json:"feature_name"`
}

PostMigrationFeature type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponse.ts#L27-L29

func NewPostMigrationFeature ¶ added in v8.5.0 

func NewPostMigrationFeature() *PostMigrationFeature

NewPostMigrationFeature returns a PostMigrationFeature.

type PredicateTokenFilter ¶ 

type PredicateTokenFilter struct {
	Script  Script  `json:"script"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

PredicateTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L295-L298

func NewPredicateTokenFilter ¶ added in v8.5.0 

func NewPredicateTokenFilter() *PredicateTokenFilter

NewPredicateTokenFilter returns a PredicateTokenFilter.

type PredictedValue ¶ 

type PredictedValue interface{}

PredictedValue holds the union for the following types: 

string
float64
bool
int

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L410-L410

type PrefixQuery ¶ 

type PrefixQuery struct {
	Boost           *float32 `json:"boost,omitempty"`
	CaseInsensitive *bool    `json:"case_insensitive,omitempty"`
	QueryName_      *string  `json:"_name,omitempty"`
	Rewrite         *string  `json:"rewrite,omitempty"`
	Value           string   `json:"value"`
}

PrefixQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L57-L66

func NewPrefixQuery ¶ added in v8.5.0 

func NewPrefixQuery() *PrefixQuery

NewPrefixQuery returns a PrefixQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 {
	AllInBytes                            *int64 `json:"all_in_bytes,omitempty"`
	CombinedCoordinatingAndPrimaryInBytes *int64 `json:"combined_coordinating_and_primary_in_bytes,omitempty"`
	CoordinatingInBytes                   *int64 `json:"coordinating_in_bytes,omitempty"`
	CoordinatingRejections                *int64 `json:"coordinating_rejections,omitempty"`
	PrimaryInBytes                        *int64 `json:"primary_in_bytes,omitempty"`
	PrimaryRejections                     *int64 `json:"primary_rejections,omitempty"`
	ReplicaInBytes                        *int64 `json:"replica_in_bytes,omitempty"`
	ReplicaRejections                     *int64 `json:"replica_rejections,omitempty"`
}

PressureMemory type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L65-L74

func NewPressureMemory ¶ added in v8.5.0 

func NewPressureMemory() *PressureMemory

NewPressureMemory returns a PressureMemory.

type Privileges ¶ 

type Privileges map[string]bool

Privileges type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/has_privileges/types.ts#L48-L48

type PrivilegesActions ¶ added in v8.5.0 

type PrivilegesActions struct {
	Actions     []string               `json:"actions"`
	Application *string                `json:"application,omitempty"`
	Metadata    map[string]interface{} `json:"metadata,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

PrivilegesActions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/put_privileges/types.ts#L22-L27

func NewPrivilegesActions ¶ added in v8.5.0 

func NewPrivilegesActions() *PrivilegesActions

NewPrivilegesActions returns a PrivilegesActions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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                 *Cpu         `json:"cpu,omitempty"`
	MaxFileDescriptors  *int         `json:"max_file_descriptors,omitempty"`
	Mem                 *MemoryStats `json:"mem,omitempty"`
	OpenFileDescriptors *int         `json:"open_file_descriptors,omitempty"`
	Timestamp           *int64       `json:"timestamp,omitempty"`
}

Process type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L375-L381

func NewProcess ¶ added in v8.5.0 

func NewProcess() *Process

NewProcess returns a Process.

type Processor ¶ 

type Processor struct {
	Count        *int64 `json:"count,omitempty"`
	Current      *int64 `json:"current,omitempty"`
	Failed       *int64 `json:"failed,omitempty"`
	TimeInMillis *int64 `json:"time_in_millis,omitempty"`
}

Processor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L156-L161

func NewProcessor ¶ added in v8.5.0 

func NewProcessor() *Processor

NewProcessor returns a Processor.

type ProcessorContainer ¶ 

type ProcessorContainer struct {
	Append          *AppendProcessor          `json:"append,omitempty"`
	Attachment      *AttachmentProcessor      `json:"attachment,omitempty"`
	Bytes           *BytesProcessor           `json:"bytes,omitempty"`
	Circle          *CircleProcessor          `json:"circle,omitempty"`
	Convert         *ConvertProcessor         `json:"convert,omitempty"`
	Csv             *CsvProcessor             `json:"csv,omitempty"`
	Date            *DateProcessor            `json:"date,omitempty"`
	DateIndexName   *DateIndexNameProcessor   `json:"date_index_name,omitempty"`
	Dissect         *DissectProcessor         `json:"dissect,omitempty"`
	DotExpander     *DotExpanderProcessor     `json:"dot_expander,omitempty"`
	Drop            *DropProcessor            `json:"drop,omitempty"`
	Enrich          *EnrichProcessor          `json:"enrich,omitempty"`
	Fail            *FailProcessor            `json:"fail,omitempty"`
	Foreach         *ForeachProcessor         `json:"foreach,omitempty"`
	Geoip           *GeoIpProcessor           `json:"geoip,omitempty"`
	Grok            *GrokProcessor            `json:"grok,omitempty"`
	Gsub            *GsubProcessor            `json:"gsub,omitempty"`
	Inference       *InferenceProcessor       `json:"inference,omitempty"`
	Join            *JoinProcessor            `json:"join,omitempty"`
	Json            *JsonProcessor            `json:"json,omitempty"`
	Kv              *KeyValueProcessor        `json:"kv,omitempty"`
	Lowercase       *LowercaseProcessor       `json:"lowercase,omitempty"`
	Pipeline        *PipelineProcessor        `json:"pipeline,omitempty"`
	Remove          *RemoveProcessor          `json:"remove,omitempty"`
	Rename          *RenameProcessor          `json:"rename,omitempty"`
	Script          *Script                   `json:"script,omitempty"`
	Set             *SetProcessor             `json:"set,omitempty"`
	SetSecurityUser *SetSecurityUserProcessor `json:"set_security_user,omitempty"`
	Sort            *SortProcessor            `json:"sort,omitempty"`
	Split           *SplitProcessor           `json:"split,omitempty"`
	Trim            *TrimProcessor            `json:"trim,omitempty"`
	Uppercase       *UppercaseProcessor       `json:"uppercase,omitempty"`
	Urldecode       *UrlDecodeProcessor       `json:"urldecode,omitempty"`
	UserAgent       *UserAgentProcessor       `json:"user_agent,omitempty"`
}

ProcessorContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L28-L67

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L93-L95

func NewProfile ¶ added in v8.5.0 

func NewProfile() *Profile

NewProfile returns a Profile.

type Property ¶ 

type Property interface {
	// contains filtered or unexported methods
}

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
CompletionProperty
ConstantKeywordProperty
FieldAliasProperty
HistogramProperty
IpProperty
Murmur3HashProperty
TokenCountProperty
GeoPointProperty
GeoShapeProperty
PointProperty
ShapeProperty
ByteNumberProperty
DoubleNumberProperty
FloatNumberProperty
HalfFloatNumberProperty
IntegerNumberProperty
LongNumberProperty
ScaledFloatNumberProperty
ShortNumberProperty
UnsignedLongNumberProperty
DateRangeProperty
DoubleRangeProperty
FloatRangeProperty
IntegerRangeProperty
IpRangeProperty
LongRangeProperty

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/Property.ts#L93-L156

type PublishedClusterStates ¶ 

type PublishedClusterStates struct {
	CompatibleDiffs   *int64 `json:"compatible_diffs,omitempty"`
	FullStates        *int64 `json:"full_states,omitempty"`
	IncompatibleDiffs *int64 `json:"incompatible_diffs,omitempty"`
}

PublishedClusterStates type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L114-L118

func NewPublishedClusterStates ¶ added in v8.5.0 

func NewPublishedClusterStates() *PublishedClusterStates

NewPublishedClusterStates returns a PublishedClusterStates.

type Queries ¶ 

type Queries struct {
	Cache *CacheQueries `json:"cache,omitempty"`
}

Queries type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L394-L396

func NewQueries ¶ added in v8.5.0 

func NewQueries() *Queries

NewQueries returns a Queries.

type Query ¶ 

type Query struct {
	Bool              *BoolQuery                        `json:"bool,omitempty"`
	Boosting          *BoostingQuery                    `json:"boosting,omitempty"`
	CombinedFields    *CombinedFieldsQuery              `json:"combined_fields,omitempty"`
	Common            map[string]CommonTermsQuery       `json:"common,omitempty"`
	ConstantScore     *ConstantScoreQuery               `json:"constant_score,omitempty"`
	DisMax            *DisMaxQuery                      `json:"dis_max,omitempty"`
	DistanceFeature   *DistanceFeatureQuery             `json:"distance_feature,omitempty"`
	Exists            *ExistsQuery                      `json:"exists,omitempty"`
	FieldMaskingSpan  *SpanFieldMaskingQuery            `json:"field_masking_span,omitempty"`
	FunctionScore     *FunctionScoreQuery               `json:"function_score,omitempty"`
	Fuzzy             map[string]FuzzyQuery             `json:"fuzzy,omitempty"`
	GeoBoundingBox    *GeoBoundingBoxQuery              `json:"geo_bounding_box,omitempty"`
	GeoDistance       *GeoDistanceQuery                 `json:"geo_distance,omitempty"`
	GeoPolygon        *GeoPolygonQuery                  `json:"geo_polygon,omitempty"`
	GeoShape          *GeoShapeQuery                    `json:"geo_shape,omitempty"`
	HasChild          *HasChildQuery                    `json:"has_child,omitempty"`
	HasParent         *HasParentQuery                   `json:"has_parent,omitempty"`
	Ids               *IdsQuery                         `json:"ids,omitempty"`
	Intervals         map[string]IntervalsQuery         `json:"intervals,omitempty"`
	Match             map[string]MatchQuery             `json:"match,omitempty"`
	MatchAll          *MatchAllQuery                    `json:"match_all,omitempty"`
	MatchBoolPrefix   map[string]MatchBoolPrefixQuery   `json:"match_bool_prefix,omitempty"`
	MatchNone         *MatchNoneQuery                   `json:"match_none,omitempty"`
	MatchPhrase       map[string]MatchPhraseQuery       `json:"match_phrase,omitempty"`
	MatchPhrasePrefix map[string]MatchPhrasePrefixQuery `json:"match_phrase_prefix,omitempty"`
	MoreLikeThis      *MoreLikeThisQuery                `json:"more_like_this,omitempty"`
	MultiMatch        *MultiMatchQuery                  `json:"multi_match,omitempty"`
	Nested            *NestedQuery                      `json:"nested,omitempty"`
	ParentId          *ParentIdQuery                    `json:"parent_id,omitempty"`
	Percolate         *PercolateQuery                   `json:"percolate,omitempty"`
	Pinned            *PinnedQuery                      `json:"pinned,omitempty"`
	Prefix            map[string]PrefixQuery            `json:"prefix,omitempty"`
	QueryString       *QueryStringQuery                 `json:"query_string,omitempty"`
	Range             map[string]RangeQuery             `json:"range,omitempty"`
	RankFeature       *RankFeatureQuery                 `json:"rank_feature,omitempty"`
	Regexp            map[string]RegexpQuery            `json:"regexp,omitempty"`
	Script            *ScriptQuery                      `json:"script,omitempty"`
	ScriptScore       *ScriptScoreQuery                 `json:"script_score,omitempty"`
	Shape             *ShapeQuery                       `json:"shape,omitempty"`
	SimpleQueryString *SimpleQueryStringQuery           `json:"simple_query_string,omitempty"`
	SpanContaining    *SpanContainingQuery              `json:"span_containing,omitempty"`
	SpanFirst         *SpanFirstQuery                   `json:"span_first,omitempty"`
	SpanMulti         *SpanMultiTermQuery               `json:"span_multi,omitempty"`
	SpanNear          *SpanNearQuery                    `json:"span_near,omitempty"`
	SpanNot           *SpanNotQuery                     `json:"span_not,omitempty"`
	SpanOr            *SpanOrQuery                      `json:"span_or,omitempty"`
	SpanTerm          map[string]SpanTermQuery          `json:"span_term,omitempty"`
	SpanWithin        *SpanWithinQuery                  `json:"span_within,omitempty"`
	Term              map[string]TermQuery              `json:"term,omitempty"`
	Terms             *TermsQuery                       `json:"terms,omitempty"`
	TermsSet          map[string]TermsSetQuery          `json:"terms_set,omitempty"`
	Type              *TypeQuery                        `json:"type,omitempty"`
	Wildcard          map[string]WildcardQuery          `json:"wildcard,omitempty"`
	Wrapper           *WrapperQuery                     `json:"wrapper,omitempty"`
}

Query type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/abstractions.ts#L96-L162

func NewQuery ¶ added in v8.5.0 

func NewQuery() *Query

NewQuery returns a Query.

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"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L97-L116

func NewQueryBreakdown ¶ added in v8.5.0 

func NewQueryBreakdown() *QueryBreakdown

NewQueryBreakdown returns a QueryBreakdown.

type QueryCacheStats ¶ 

type QueryCacheStats struct {
	CacheCount        int       `json:"cache_count"`
	CacheSize         int       `json:"cache_size"`
	Evictions         int       `json:"evictions"`
	HitCount          int       `json:"hit_count"`
	MemorySize        *ByteSize `json:"memory_size,omitempty"`
	MemorySizeInBytes int       `json:"memory_size_in_bytes"`
	MissCount         int       `json:"miss_count"`
	TotalCount        int       `json:"total_count"`
}

QueryCacheStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L150-L159

func NewQueryCacheStats ¶ added in v8.5.0 

func NewQueryCacheStats() *QueryCacheStats

NewQueryCacheStats returns a QueryCacheStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L118-L124

func NewQueryProfile ¶ added in v8.5.0 

func NewQueryProfile() *QueryProfile

NewQueryProfile returns a QueryProfile.

type QueryStringQuery ¶ 

type QueryStringQuery struct {
	AllowLeadingWildcard            *bool                        `json:"allow_leading_wildcard,omitempty"`
	AnalyzeWildcard                 *bool                        `json:"analyze_wildcard,omitempty"`
	Analyzer                        *string                      `json:"analyzer,omitempty"`
	AutoGenerateSynonymsPhraseQuery *bool                        `json:"auto_generate_synonyms_phrase_query,omitempty"`
	Boost                           *float32                     `json:"boost,omitempty"`
	DefaultField                    *string                      `json:"default_field,omitempty"`
	DefaultOperator                 *operator.Operator           `json:"default_operator,omitempty"`
	EnablePositionIncrements        *bool                        `json:"enable_position_increments,omitempty"`
	Escape                          *bool                        `json:"escape,omitempty"`
	Fields                          []string                     `json:"fields,omitempty"`
	Fuzziness                       *Fuzziness                   `json:"fuzziness,omitempty"`
	FuzzyMaxExpansions              *int                         `json:"fuzzy_max_expansions,omitempty"`
	FuzzyPrefixLength               *int                         `json:"fuzzy_prefix_length,omitempty"`
	FuzzyRewrite                    *string                      `json:"fuzzy_rewrite,omitempty"`
	FuzzyTranspositions             *bool                        `json:"fuzzy_transpositions,omitempty"`
	Lenient                         *bool                        `json:"lenient,omitempty"`
	MaxDeterminizedStates           *int                         `json:"max_determinized_states,omitempty"`
	MinimumShouldMatch              *MinimumShouldMatch          `json:"minimum_should_match,omitempty"`
	PhraseSlop                      *float64                     `json:"phrase_slop,omitempty"`
	Query                           string                       `json:"query"`
	QueryName_                      *string                      `json:"_name,omitempty"`
	QuoteAnalyzer                   *string                      `json:"quote_analyzer,omitempty"`
	QuoteFieldSuffix                *string                      `json:"quote_field_suffix,omitempty"`
	Rewrite                         *string                      `json:"rewrite,omitempty"`
	TieBreaker                      *float64                     `json:"tie_breaker,omitempty"`
	TimeZone                        *string                      `json:"time_zone,omitempty"`
	Type                            *textquerytype.TextQueryType `json:"type,omitempty"`
}

QueryStringQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L233-L269

func NewQueryStringQuery ¶ added in v8.5.0 

func NewQueryStringQuery() *QueryStringQuery

NewQueryStringQuery returns a QueryStringQuery.

type QueryVector ¶ 

type QueryVector []float64

QueryVector type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/knn_search/_types/Knn.ts#L23-L23

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Watch.ts#L58-L64

func NewQueryWatch ¶ added in v8.5.0 

func NewQueryWatch() *QueryWatch

NewQueryWatch returns a QueryWatch.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L245-L255

func NewQuestionAnsweringInferenceOptions ¶ added in v8.5.0 

func NewQuestionAnsweringInferenceOptions() *QuestionAnsweringInferenceOptions

NewQuestionAnsweringInferenceOptions returns a QuestionAnsweringInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L373-L384

func NewQuestionAnsweringInferenceUpdateOptions ¶ added in v8.5.0 

func NewQuestionAnsweringInferenceUpdateOptions() *QuestionAnsweringInferenceUpdateOptions

NewQuestionAnsweringInferenceUpdateOptions returns a QuestionAnsweringInferenceUpdateOptions.

type RandomScoreFunction ¶ 

type RandomScoreFunction struct {
	Field *string `json:"field,omitempty"`
	Seed  string  `json:"seed,omitempty"`
}

RandomScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L65-L68

func NewRandomScoreFunction ¶ added in v8.5.0 

func NewRandomScoreFunction() *RandomScoreFunction

NewRandomScoreFunction returns a RandomScoreFunction.

type RangeAggregate ¶ 

type RangeAggregate struct {
	Buckets BucketsRangeBucket     `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

RangeAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L530-L531

func NewRangeAggregate ¶ added in v8.5.0 

func NewRangeAggregate() *RangeAggregate

NewRangeAggregate returns a RangeAggregate.

type RangeAggregation ¶ 

type RangeAggregation struct {
	Field   *string                `json:"field,omitempty"`
	Format  *string                `json:"format,omitempty"`
	Keyed   *bool                  `json:"keyed,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
	Missing *int                   `json:"missing,omitempty"`
	Name    *string                `json:"name,omitempty"`
	Ranges  []AggregationRange     `json:"ranges,omitempty"`
	Script  *Script                `json:"script,omitempty"`
}

RangeAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L289-L296

func NewRangeAggregation ¶ added in v8.5.0 

func NewRangeAggregation() *RangeAggregation

NewRangeAggregation returns a RangeAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L533-L540

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

type RangeQuery ¶ 

type RangeQuery interface {
	// contains filtered or unexported methods
}

RangeQuery holds the union for the following types: 

DateRangeQuery
NumberRangeQuery

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L92-L94

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L141-L145

func NewRankEvalHit ¶ added in v8.5.0 

func NewRankEvalHit() *RankEvalHit

NewRankEvalHit returns a RankEvalHit.

type RankEvalHitItem ¶ 

type RankEvalHitItem struct {
	Hit    RankEvalHit `json:"hit"`
	Rating float64     `json:"rating,omitempty"`
}

RankEvalHitItem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L136-L139

func NewRankEvalHitItem ¶ added in v8.5.0 

func NewRankEvalHitItem() *RankEvalHitItem

NewRankEvalHitItem returns a RankEvalHitItem.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L125-L134

func NewRankEvalMetricDetail ¶ added in v8.5.0 

func NewRankEvalMetricDetail() *RankEvalMetricDetail

NewRankEvalMetricDetail returns a RankEvalMetricDetail.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L66-L77

func NewRankEvalMetricDiscountedCumulativeGain ¶ added in v8.5.0 

func NewRankEvalMetricDiscountedCumulativeGain() *RankEvalMetricDiscountedCumulativeGain

NewRankEvalMetricDiscountedCumulativeGain returns a RankEvalMetricDiscountedCumulativeGain.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L79-L88

func NewRankEvalMetricExpectedReciprocalRank ¶ added in v8.5.0 

func NewRankEvalMetricExpectedReciprocalRank() *RankEvalMetricExpectedReciprocalRank

NewRankEvalMetricExpectedReciprocalRank returns a RankEvalMetricExpectedReciprocalRank.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L60-L64

func NewRankEvalMetricMeanReciprocalRank ¶ added in v8.5.0 

func NewRankEvalMetricMeanReciprocalRank() *RankEvalMetricMeanReciprocalRank

NewRankEvalMetricMeanReciprocalRank returns a RankEvalMetricMeanReciprocalRank.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L42-L52

func NewRankEvalMetricPrecision ¶ added in v8.5.0 

func NewRankEvalMetricPrecision() *RankEvalMetricPrecision

NewRankEvalMetricPrecision returns a RankEvalMetricPrecision.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L34-L40

func NewRankEvalMetricRatingTreshold ¶ added in v8.5.0 

func NewRankEvalMetricRatingTreshold() *RankEvalMetricRatingTreshold

NewRankEvalMetricRatingTreshold returns a RankEvalMetricRatingTreshold.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L54-L58

func NewRankEvalMetricRecall ¶ added in v8.5.0 

func NewRankEvalMetricRecall() *RankEvalMetricRecall

NewRankEvalMetricRecall returns a RankEvalMetricRecall.

type RankEvalQuery ¶ 

type RankEvalQuery struct {
	Query Query `json:"query"`
	Size  *int  `json:"size,omitempty"`
}

RankEvalQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L111-L114

func NewRankEvalQuery ¶ added in v8.5.0 

func NewRankEvalQuery() *RankEvalQuery

NewRankEvalQuery returns a RankEvalQuery.

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]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L98-L109

func NewRankEvalRequestItem ¶ added in v8.5.0 

func NewRankEvalRequestItem() *RankEvalRequestItem

NewRankEvalRequestItem returns a RankEvalRequestItem.

type RankFeatureFunction ¶ 

type RankFeatureFunction struct {
}

RankFeatureFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L137-L137

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L139-L139

func NewRankFeatureFunctionLinear ¶ added in v8.5.0 

func NewRankFeatureFunctionLinear() *RankFeatureFunctionLinear

NewRankFeatureFunctionLinear returns a RankFeatureFunctionLinear.

type RankFeatureFunctionLogarithm ¶ 

type RankFeatureFunctionLogarithm struct {
	ScalingFactor float32 `json:"scaling_factor"`
}

RankFeatureFunctionLogarithm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L141-L143

func NewRankFeatureFunctionLogarithm ¶ added in v8.5.0 

func NewRankFeatureFunctionLogarithm() *RankFeatureFunctionLogarithm

NewRankFeatureFunctionLogarithm returns a RankFeatureFunctionLogarithm.

type RankFeatureFunctionSaturation ¶ 

type RankFeatureFunctionSaturation struct {
	Pivot *float32 `json:"pivot,omitempty"`
}

RankFeatureFunctionSaturation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L145-L147

func NewRankFeatureFunctionSaturation ¶ added in v8.5.0 

func NewRankFeatureFunctionSaturation() *RankFeatureFunctionSaturation

NewRankFeatureFunctionSaturation returns a RankFeatureFunctionSaturation.

type RankFeatureFunctionSigmoid ¶ 

type RankFeatureFunctionSigmoid struct {
	Exponent float32 `json:"exponent"`
	Pivot    float32 `json:"pivot"`
}

RankFeatureFunctionSigmoid type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L149-L152

func NewRankFeatureFunctionSigmoid ¶ added in v8.5.0 

func NewRankFeatureFunctionSigmoid() *RankFeatureFunctionSigmoid

NewRankFeatureFunctionSigmoid returns a RankFeatureFunctionSigmoid.

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"`
	Type                string              `json:"type,omitempty"`
}

RankFeatureProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L181-L184

func NewRankFeatureProperty ¶ added in v8.5.0 

func NewRankFeatureProperty() *RankFeatureProperty

NewRankFeatureProperty returns a RankFeatureProperty.

type RankFeatureQuery ¶ 

type RankFeatureQuery struct {
	Boost      *float32                       `json:"boost,omitempty"`
	Field      string                         `json:"field"`
	Linear     *RankFeatureFunctionLinear     `json:"linear,omitempty"`
	Log        *RankFeatureFunctionLogarithm  `json:"log,omitempty"`
	QueryName_ *string                        `json:"_name,omitempty"`
	Saturation *RankFeatureFunctionSaturation `json:"saturation,omitempty"`
	Sigmoid    *RankFeatureFunctionSigmoid    `json:"sigmoid,omitempty"`
}

RankFeatureQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L154-L162

func NewRankFeatureQuery ¶ added in v8.5.0 

func NewRankFeatureQuery() *RankFeatureQuery

NewRankFeatureQuery returns a RankFeatureQuery.

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"`
	Properties map[string]Property `json:"properties,omitempty"`
	Type       string              `json:"type,omitempty"`
}

RankFeaturesProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L186-L188

func NewRankFeaturesProperty ¶ added in v8.5.0 

func NewRankFeaturesProperty() *RankFeaturesProperty

NewRankFeaturesProperty returns a RankFeaturesProperty.

type RareTermsAggregation ¶ 

type RareTermsAggregation struct {
	Exclude     []string               `json:"exclude,omitempty"`
	Field       *string                `json:"field,omitempty"`
	Include     *TermsInclude          `json:"include,omitempty"`
	MaxDocCount *int64                 `json:"max_doc_count,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Missing     *Missing               `json:"missing,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Precision   *float64               `json:"precision,omitempty"`
	ValueType   *string                `json:"value_type,omitempty"`
}

RareTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L304-L312

func NewRareTermsAggregation ¶ added in v8.5.0 

func NewRareTermsAggregation() *RareTermsAggregation

NewRareTermsAggregation returns a RareTermsAggregation.

type RateAggregate ¶ 

type RateAggregate struct {
	Meta          map[string]interface{} `json:"meta,omitempty"`
	Value         float64                `json:"value"`
	ValueAsString *string                `json:"value_as_string,omitempty"`
}

RateAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L732-L736

func NewRateAggregate ¶ added in v8.5.0 

func NewRateAggregate() *RateAggregate

NewRateAggregate returns a RateAggregate.

type RateAggregation ¶ 

type RateAggregation struct {
	Field   *string                            `json:"field,omitempty"`
	Format  *string                            `json:"format,omitempty"`
	Missing *Missing                           `json:"missing,omitempty"`
	Mode    *ratemode.RateMode                 `json:"mode,omitempty"`
	Script  *Script                            `json:"script,omitempty"`
	Unit    *calendarinterval.CalendarInterval `json:"unit,omitempty"`
}

RateAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L127-L130

func NewRateAggregation ¶ added in v8.5.0 

func NewRateAggregation() *RateAggregation

NewRateAggregation returns a RateAggregation.

type ReadException ¶ 

type ReadException struct {
	Exception ErrorCause `json:"exception"`
	FromSeqNo int64      `json:"from_seq_no"`
	Retries   int        `json:"retries"`
}

ReadException type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ccr/_types/FollowIndexStats.ts#L71-L75

func NewReadException ¶ added in v8.5.0 

func NewReadException() *ReadException

NewReadException returns a ReadException.

type RealmCache ¶ 

type RealmCache struct {
	Size int64 `json:"size"`
}

RealmCache type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L251-L253

func NewRealmCache ¶ added in v8.5.0 

func NewRealmCache() *RealmCache

NewRealmCache returns a RealmCache.

type RealmInfo ¶ 

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

RealmInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RealmInfo.ts#L22-L25

func NewRealmInfo ¶ added in v8.5.0 

func NewRealmInfo() *RealmInfo

NewRealmInfo returns a RealmInfo.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L88-L93

func NewRecording ¶ added in v8.5.0 

func NewRecording() *Recording

NewRecording returns a Recording.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L38-L48

func NewRecoveryBytes ¶ added in v8.5.0 

func NewRecoveryBytes() *RecoveryBytes

NewRecoveryBytes returns a RecoveryBytes.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L56-L62

func NewRecoveryFiles ¶ added in v8.5.0 

func NewRecoveryFiles() *RecoveryFiles

NewRecoveryFiles returns a RecoveryFiles.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L64-L74

func NewRecoveryIndexStatus ¶ added in v8.5.0 

func NewRecoveryIndexStatus() *RecoveryIndexStatus

NewRecoveryIndexStatus returns a RecoveryIndexStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L76-L89

func NewRecoveryOrigin ¶ added in v8.5.0 

func NewRecoveryOrigin() *RecoveryOrigin

NewRecoveryOrigin returns a RecoveryOrigin.

type RecoveryRecord ¶ 

type RecoveryRecord struct {
	// Bytes number of bytes to recover
	Bytes *string `json:"bytes,omitempty"`
	// BytesPercent percent of bytes recovered
	BytesPercent *Percentage `json:"bytes_percent,omitempty"`
	// BytesRecovered bytes recovered
	BytesRecovered *string `json:"bytes_recovered,omitempty"`
	// BytesTotal total number of bytes
	BytesTotal *string `json:"bytes_total,omitempty"`
	// Files number of files to recover
	Files *string `json:"files,omitempty"`
	// FilesPercent percent of files recovered
	FilesPercent *Percentage `json:"files_percent,omitempty"`
	// FilesRecovered files recovered
	FilesRecovered *string `json:"files_recovered,omitempty"`
	// FilesTotal total number of files
	FilesTotal *string `json:"files_total,omitempty"`
	// Index index name
	Index *string `json:"index,omitempty"`
	// Repository repository
	Repository *string `json:"repository,omitempty"`
	// Shard shard name
	Shard *string `json:"shard,omitempty"`
	// Snapshot snapshot
	Snapshot *string `json:"snapshot,omitempty"`
	// SourceHost source host
	SourceHost *string `json:"source_host,omitempty"`
	// SourceNode source node name
	SourceNode *string `json:"source_node,omitempty"`
	// Stage recovery stage
	Stage *string `json:"stage,omitempty"`
	// StartTime recovery start time
	StartTime *DateTime `json:"start_time,omitempty"`
	// StartTimeMillis recovery start time in epoch milliseconds
	StartTimeMillis *int64 `json:"start_time_millis,omitempty"`
	// StopTime recovery stop time
	StopTime *DateTime `json:"stop_time,omitempty"`
	// StopTimeMillis recovery stop time in epoch milliseconds
	StopTimeMillis *int64 `json:"stop_time_millis,omitempty"`
	// TargetHost target host
	TargetHost *string `json:"target_host,omitempty"`
	// TargetNode target node name
	TargetNode *string `json:"target_node,omitempty"`
	// Time recovery time
	Time *Duration `json:"time,omitempty"`
	// TranslogOps number of translog ops to recover
	TranslogOps *string `json:"translog_ops,omitempty"`
	// TranslogOpsPercent percent of translog ops recovered
	TranslogOpsPercent *Percentage `json:"translog_ops_percent,omitempty"`
	// TranslogOpsRecovered translog ops recovered
	TranslogOpsRecovered *string `json:"translog_ops_recovered,omitempty"`
	// Type recovery type
	Type *string `json:"type,omitempty"`
}

RecoveryRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/recovery/types.ts#L24-L155

func NewRecoveryRecord ¶ added in v8.5.0 

func NewRecoveryRecord() *RecoveryRecord

NewRecoveryRecord returns a RecoveryRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L91-L96

func NewRecoveryStartStatus ¶ added in v8.5.0 

func NewRecoveryStartStatus() *RecoveryStartStatus

NewRecoveryStartStatus returns a RecoveryStartStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L161-L166

func NewRecoveryStats ¶ added in v8.5.0 

func NewRecoveryStats() *RecoveryStats

NewRecoveryStats returns a RecoveryStats.

type RecoveryStatus ¶ 

type RecoveryStatus struct {
	Shards []ShardRecovery `json:"shards"`
}

RecoveryStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L98-L100

func NewRecoveryStatus ¶ added in v8.5.0 

func NewRecoveryStatus() *RecoveryStatus

NewRecoveryStatus returns a RecoveryStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L168-L175

func NewRefreshStats ¶ added in v8.5.0 

func NewRefreshStats() *RefreshStats

NewRefreshStats returns a RefreshStats.

type RegexpQuery ¶ 

type RegexpQuery struct {
	Boost                 *float32 `json:"boost,omitempty"`
	CaseInsensitive       *bool    `json:"case_insensitive,omitempty"`
	Flags                 *string  `json:"flags,omitempty"`
	MaxDeterminizedStates *int     `json:"max_determinized_states,omitempty"`
	QueryName_            *string  `json:"_name,omitempty"`
	Rewrite               *string  `json:"rewrite,omitempty"`
	Value                 string   `json:"value"`
}

RegexpQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L102-L114

func NewRegexpQuery ¶ added in v8.5.0 

func NewRegexpQuery() *RegexpQuery

NewRegexpQuery returns a RegexpQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L69-L78

func NewRegressionInferenceOptions ¶ added in v8.5.0 

func NewRegressionInferenceOptions() *RegressionInferenceOptions

NewRegressionInferenceOptions returns a RegressionInferenceOptions.

type ReindexDestination ¶ added in v8.5.0 

type ReindexDestination struct {
	Index       string                   `json:"index"`
	OpType      *optype.OpType           `json:"op_type,omitempty"`
	Pipeline    *string                  `json:"pipeline,omitempty"`
	Routing     *string                  `json:"routing,omitempty"`
	VersionType *versiontype.VersionType `json:"version_type,omitempty"`
}

ReindexDestination type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex/types.ts#L39-L45

func NewReindexDestination ¶ added in v8.5.0 

func NewReindexDestination() *ReindexDestination

NewReindexDestination returns a ReindexDestination.

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[TaskId]ReindexTask `json:"tasks"`
	TransportAddress string                 `json:"transport_address"`
}

ReindexNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex_rethrottle/types.ts#L33-L35

func NewReindexNode ¶ added in v8.5.0 

func NewReindexNode() *ReindexNode

NewReindexNode returns a ReindexNode.

type ReindexSource ¶ added in v8.5.0 

type ReindexSource struct {
	Index           []string                `json:"index"`
	Query           *Query                  `json:"query,omitempty"`
	Remote          *RemoteSource           `json:"remote,omitempty"`
	RuntimeMappings map[string]RuntimeField `json:"runtime_mappings,omitempty"`
	Size            *int                    `json:"size,omitempty"`
	Slice           *SlicedScroll           `json:"slice,omitempty"`
	Sort            []SortCombinations      `json:"sort,omitempty"`
	SourceFields_   []string                `json:"_source,omitempty"`
}

ReindexSource type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex/types.ts#L47-L57

func NewReindexSource ¶ added in v8.5.0 

func NewReindexSource() *ReindexSource

NewReindexSource returns a ReindexSource.

type ReindexStatus ¶ 

type ReindexStatus struct {
	Batches              int64     `json:"batches"`
	Created              int64     `json:"created"`
	Deleted              int64     `json:"deleted"`
	Noops                int64     `json:"noops"`
	RequestsPerSecond    float32   `json:"requests_per_second"`
	Retries              Retries   `json:"retries"`
	Throttled            *Duration `json:"throttled,omitempty"`
	ThrottledMillis      int64     `json:"throttled_millis"`
	ThrottledUntil       *Duration `json:"throttled_until,omitempty"`
	ThrottledUntilMillis int64     `json:"throttled_until_millis"`
	Total                int64     `json:"total"`
	Updated              int64     `json:"updated"`
	VersionConflicts     int64     `json:"version_conflicts"`
}

ReindexStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex_rethrottle/types.ts#L37-L51

func NewReindexStatus ¶ added in v8.5.0 

func NewReindexStatus() *ReindexStatus

NewReindexStatus returns a ReindexStatus.

type ReindexTask ¶ 

type ReindexTask struct {
	Action             string              `json:"action"`
	Cancellable        bool                `json:"cancellable"`
	Description        string              `json:"description"`
	Headers            map[string][]string `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex_rethrottle/types.ts#L53-L64

func NewReindexTask ¶ added in v8.5.0 

func NewReindexTask() *ReindexTask

NewReindexTask returns a ReindexTask.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/reload_search_analyzers/types.ts#L20-L24

func NewReloadDetails ¶ added in v8.5.0 

func NewReloadDetails() *ReloadDetails

NewReloadDetails returns a ReloadDetails.

type RemoteSource ¶ 

type RemoteSource struct {
	ConnectTimeout *Duration         `json:"connect_timeout,omitempty"`
	Headers        map[string]string `json:"headers,omitempty"`
	Host           string            `json:"host"`
	Password       *string           `json:"password,omitempty"`
	SocketTimeout  *Duration         `json:"socket_timeout,omitempty"`
	Username       *string           `json:"username,omitempty"`
}

RemoteSource type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/reindex/types.ts#L59-L66

func NewRemoteSource ¶ added in v8.5.0 

func NewRemoteSource() *RemoteSource

NewRemoteSource returns a RemoteSource.

type RemoveAction ¶ 

type RemoveAction struct {
	Alias     *string  `json:"alias,omitempty"`
	Aliases   []string `json:"aliases,omitempty"`
	Index     *string  `json:"index,omitempty"`
	Indices   []string `json:"indices,omitempty"`
	MustExist *bool    `json:"must_exist,omitempty"`
}

RemoveAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/update_aliases/types.ts#L46-L53

func NewRemoveAction ¶ added in v8.5.0 

func NewRemoveAction() *RemoveAction

NewRemoveAction returns a RemoveAction.

type RemoveDuplicatesTokenFilter ¶ 

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

RemoveDuplicatesTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L300-L302

func NewRemoveDuplicatesTokenFilter ¶ added in v8.5.0 

func NewRemoveDuplicatesTokenFilter() *RemoveDuplicatesTokenFilter

NewRemoveDuplicatesTokenFilter returns a RemoveDuplicatesTokenFilter.

type RemoveIndexAction ¶ 

type RemoveIndexAction struct {
	Index     *string  `json:"index,omitempty"`
	Indices   []string `json:"indices,omitempty"`
	MustExist *bool    `json:"must_exist,omitempty"`
}

RemoveIndexAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/update_aliases/types.ts#L55-L60

func NewRemoveIndexAction ¶ added in v8.5.0 

func NewRemoveIndexAction() *RemoveIndexAction

NewRemoveIndexAction returns a RemoveIndexAction.

type RemoveProcessor ¶ 

type RemoveProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         []string             `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

RemoveProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L311-L314

func NewRemoveProcessor ¶ added in v8.5.0 

func NewRemoveProcessor() *RemoveProcessor

NewRemoveProcessor returns a RemoveProcessor.

type RenameProcessor ¶ 

type RenameProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   string               `json:"target_field"`
}

RenameProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L316-L320

func NewRenameProcessor ¶ added in v8.5.0 

func NewRenameProcessor() *RenameProcessor

NewRenameProcessor returns a RenameProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L224-L232

func NewReportingEmailAttachment ¶ added in v8.5.0 

func NewReportingEmailAttachment() *ReportingEmailAttachment

NewReportingEmailAttachment returns a ReportingEmailAttachment.

type RepositoriesRecord ¶ 

type RepositoriesRecord struct {
	// Id unique repository id
	Id *string `json:"id,omitempty"`
	// Type repository type
	Type *string `json:"type,omitempty"`
}

RepositoriesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/repositories/types.ts#L20-L31

func NewRepositoriesRecord ¶ added in v8.5.0 

func NewRepositoriesRecord() *RepositoriesRecord

NewRepositoriesRecord returns a RepositoriesRecord.

type Repository ¶ 

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

Repository type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotRepository.ts#L23-L27

func NewRepository ¶ added in v8.5.0 

func NewRepository() *Repository

NewRepository returns a Repository.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/RepositoryMeteringInformation.ts#L68-L74

func NewRepositoryLocation ¶ added in v8.5.0 

func NewRepositoryLocation() *RepositoryLocation

NewRepositoryLocation returns a RepositoryLocation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/RepositoryMeteringInformation.ts#L24-L66

func NewRepositoryMeteringInformation ¶ added in v8.5.0 

func NewRepositoryMeteringInformation() *RepositoryMeteringInformation

NewRepositoryMeteringInformation returns a RepositoryMeteringInformation.

type RepositorySettings ¶ 

type RepositorySettings struct {
	ChunkSize         *string `json:"chunk_size,omitempty"`
	Compress          string  `json:"compress,omitempty"`
	ConcurrentStreams string  `json:"concurrent_streams,omitempty"`
	Location          string  `json:"location"`
	ReadOnly          string  `json:"read_only,omitempty"`
}

RepositorySettings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotRepository.ts#L29-L38

func NewRepositorySettings ¶ added in v8.5.0 

func NewRepositorySettings() *RepositorySettings

NewRepositorySettings returns a RepositorySettings.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L177-L183

func NewRequestCacheStats ¶ added in v8.5.0 

func NewRequestCacheStats() *RequestCacheStats

NewRequestCacheStats returns a RequestCacheStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/RepositoryMeteringInformation.ts#L76-L103

func NewRequestCounts ¶ added in v8.5.0 

func NewRequestCounts() *RequestCounts

NewRequestCounts returns a RequestCounts.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L86-L90

func NewRerouteDecision ¶ added in v8.5.0 

func NewRerouteDecision() *RerouteDecision

NewRerouteDecision returns a RerouteDecision.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L92-L96

func NewRerouteExplanation ¶ added in v8.5.0 

func NewRerouteExplanation() *RerouteExplanation

NewRerouteExplanation returns a RerouteExplanation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/reroute/types.ts#L98-L105

func NewRerouteParameters ¶ added in v8.5.0 

func NewRerouteParameters() *RerouteParameters

NewRerouteParameters returns a RerouteParameters.

type Rescore ¶ 

type Rescore struct {
	Query      RescoreQuery `json:"query"`
	WindowSize *int         `json:"window_size,omitempty"`
}

Rescore type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/rescoring.ts#L23-L26

func NewRescore ¶ added in v8.5.0 

func NewRescore() *Rescore

NewRescore returns a Rescore.

type RescoreQuery ¶ 

type RescoreQuery struct {
	Query              Query                `json:"rescore_query"`
	QueryWeight        *float64             `json:"query_weight,omitempty"`
	RescoreQueryWeight *float64             `json:"rescore_query_weight,omitempty"`
	ScoreMode          *scoremode.ScoreMode `json:"score_mode,omitempty"`
}

RescoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/rescoring.ts#L28-L34

func NewRescoreQuery ¶ added in v8.5.0 

func NewRescoreQuery() *RescoreQuery

NewRescoreQuery returns a RescoreQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L71-L76

func NewReservedSize ¶ added in v8.5.0 

func NewReservedSize() *ReservedSize

NewReservedSize returns a ReservedSize.

type ResolveIndexAliasItem ¶ 

type ResolveIndexAliasItem struct {
	Indices []string `json:"indices"`
	Name    string   `json:"name"`
}

ResolveIndexAliasItem type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/resolve_index/ResolveIndexResponse.ts#L37-L40

func NewResolveIndexAliasItem ¶ added in v8.5.0 

func NewResolveIndexAliasItem() *ResolveIndexAliasItem

NewResolveIndexAliasItem returns a ResolveIndexAliasItem.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/resolve_index/ResolveIndexResponse.ts#L42-L46

func NewResolveIndexDataStreamsItem ¶ added in v8.5.0 

func NewResolveIndexDataStreamsItem() *ResolveIndexDataStreamsItem

NewResolveIndexDataStreamsItem returns a ResolveIndexDataStreamsItem.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/resolve_index/ResolveIndexResponse.ts#L30-L35

func NewResolveIndexItem ¶ added in v8.5.0 

func NewResolveIndexItem() *ResolveIndexItem

NewResolveIndexItem returns a ResolveIndexItem.

type ResourcePrivileges ¶ 

type ResourcePrivileges map[string]map[string]bool

ResourcePrivileges type alias.

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

type ResponseBody ¶ 

type ResponseBody struct {
	Aggregations    map[string]Aggregate   `json:"aggregations,omitempty"`
	Clusters_       *ClusterStatistics     `json:"_clusters,omitempty"`
	Fields          map[string]interface{} `json:"fields,omitempty"`
	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_       *string                `json:"_scroll_id,omitempty"`
	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"`
}

ResponseBody type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/SearchResponse.ts#L38-L54

func NewResponseBody ¶ added in v8.5.0 

func NewResponseBody() *ResponseBody

NewResponseBody returns a ResponseBody.

type ResponseItem ¶ 

type ResponseItem interface {
	// contains filtered or unexported methods
}

ResponseItem holds the union for the following types: 

GetResult
MultiGetError

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/mget/types.ts#L57-L60

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L84-L97

func NewRetention ¶ added in v8.5.0 

func NewRetention() *Retention

NewRetention returns a Retention.

type RetentionLease ¶ 

type RetentionLease struct {
	Period Duration `json:"period"`
}

RetentionLease type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L65-L67

func NewRetentionLease ¶ added in v8.5.0 

func NewRetentionLease() *RetentionLease

NewRetentionLease returns a RetentionLease.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L88-L96

func NewRetentionPolicy ¶ added in v8.5.0 

func NewRetentionPolicy() *RetentionPolicy

NewRetentionPolicy returns a RetentionPolicy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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   int64 `json:"bulk"`
	Search int64 `json:"search"`
}

Retries type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Retries.ts#L22-L25

func NewRetries ¶ added in v8.5.0 

func NewRetries() *Retries

NewRetries returns a Retries.

type ReverseNestedAggregate ¶ 

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

ReverseNestedAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L488-L489

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

type ReverseNestedAggregation ¶ 

type ReverseNestedAggregation struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
	Path *string                `json:"path,omitempty"`
}

ReverseNestedAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L314-L316

func NewReverseNestedAggregation ¶ added in v8.5.0 

func NewReverseNestedAggregation() *ReverseNestedAggregation

NewReverseNestedAggregation returns a ReverseNestedAggregation.

type ReverseTokenFilter ¶ 

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

ReverseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L304-L306

func NewReverseTokenFilter ¶ added in v8.5.0 

func NewReverseTokenFilter() *ReverseTokenFilter

NewReverseTokenFilter returns a ReverseTokenFilter.

type Role ¶ 

type Role struct {
	Applications      []ApplicationPrivileges                   `json:"applications"`
	Cluster           []string                                  `json:"cluster"`
	Global            map[string]map[string]map[string][]string `json:"global,omitempty"`
	Indices           []IndicesPrivileges                       `json:"indices"`
	Metadata          map[string]interface{}                    `json:"metadata"`
	RoleTemplates     []RoleTemplate                            `json:"role_templates,omitempty"`
	RunAs             []string                                  `json:"run_as"`
	TransientMetadata TransientMetadataConfig                   `json:"transient_metadata"`
}

Role type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_role/types.ts#L29-L39

func NewRole ¶ added in v8.5.0 

func NewRole() *Role

NewRole returns a Role.

type RoleDescriptor ¶ 

type RoleDescriptor struct {
	Applications      []ApplicationPrivileges  `json:"applications,omitempty"`
	Cluster           []string                 `json:"cluster,omitempty"`
	Global            []GlobalPrivilege        `json:"global,omitempty"`
	Indices           []IndicesPrivileges      `json:"indices,omitempty"`
	Metadata          map[string]interface{}   `json:"metadata,omitempty"`
	RunAs             []string                 `json:"run_as,omitempty"`
	TransientMetadata *TransientMetadataConfig `json:"transient_metadata,omitempty"`
}

RoleDescriptor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleDescriptor.ts#L27-L36

func NewRoleDescriptor ¶ added in v8.5.0 

func NewRoleDescriptor() *RoleDescriptor

NewRoleDescriptor returns a RoleDescriptor.

type RoleDescriptorRead ¶ 

type RoleDescriptorRead struct {
	Applications      []ApplicationPrivileges  `json:"applications,omitempty"`
	Cluster           []string                 `json:"cluster"`
	Global            []GlobalPrivilege        `json:"global,omitempty"`
	Indices           []IndicesPrivileges      `json:"indices"`
	Metadata          map[string]interface{}   `json:"metadata,omitempty"`
	RunAs             []string                 `json:"run_as,omitempty"`
	TransientMetadata *TransientMetadataConfig `json:"transient_metadata,omitempty"`
}

RoleDescriptorRead type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleDescriptor.ts#L38-L47

func NewRoleDescriptorRead ¶ added in v8.5.0 

func NewRoleDescriptorRead() *RoleDescriptorRead

NewRoleDescriptorRead returns a RoleDescriptorRead.

type RoleDescriptorWrapper ¶ 

type RoleDescriptorWrapper struct {
	RoleDescriptor RoleDescriptorRead `json:"role_descriptor"`
}

RoleDescriptorWrapper type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleMappingRule.ts#L23-L31

func NewRoleMappingRule ¶ added in v8.5.0 

func NewRoleMappingRule() *RoleMappingRule

NewRoleMappingRule returns a RoleMappingRule.

type RoleTemplate ¶ 

type RoleTemplate struct {
	Format   *templateformat.TemplateFormat `json:"format,omitempty"`
	Template Script                         `json:"template"`
}

RoleTemplate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_role/types.ts#L47-L50

func NewRoleTemplate ¶ added in v8.5.0 

func NewRoleTemplate() *RoleTemplate

NewRoleTemplate returns a RoleTemplate.

type RoleTemplateInlineQuery ¶ added in v8.5.0 

type RoleTemplateInlineQuery interface{}

RoleTemplateInlineQuery holds the union for the following types: 

string
Query

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L159-L160

type RoleTemplateInlineScript ¶ 

type RoleTemplateInlineScript struct {
	Lang    *scriptlanguage.ScriptLanguage `json:"lang,omitempty"`
	Options map[string]string              `json:"options,omitempty"`
	Params  map[string]interface{}         `json:"params,omitempty"`
	Source  RoleTemplateInlineQuery        `json:"source"`
}

RoleTemplateInlineScript type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L152-L157

func NewRoleTemplateInlineScript ¶ added in v8.5.0 

func NewRoleTemplateInlineScript() *RoleTemplateInlineScript

NewRoleTemplateInlineScript returns a RoleTemplateInlineScript.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L140-L150

func NewRoleTemplateQuery ¶ added in v8.5.0 

func NewRoleTemplateQuery() *RoleTemplateQuery

NewRoleTemplateQuery returns a RoleTemplateQuery.

type RoleTemplateScript ¶ 

type RoleTemplateScript interface {
	// contains filtered or unexported methods
}

RoleTemplateScript holds the union for the following types: 

RoleTemplateInlineScript
StoredScriptId

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L162-L163

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"`
	MaxSize             *ByteSize `json:"max_size,omitempty"`
	MaxSizeBytes        *ByteSize `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"`
	MinSize             *ByteSize `json:"min_size,omitempty"`
}

RolloverConditions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/rollover/types.ts#L24-L37

func NewRolloverConditions ¶ added in v8.5.0 

func NewRolloverConditions() *RolloverConditions

NewRolloverConditions returns a RolloverConditions.

type RollupCapabilities ¶ 

type RollupCapabilities struct {
	RollupJobs []RollupCapabilitySummary `json:"rollup_jobs"`
}

RollupCapabilities type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_rollup_caps/types.ts#L24-L26

func NewRollupCapabilities ¶ added in v8.5.0 

func NewRollupCapabilities() *RollupCapabilities

NewRollupCapabilities returns a RollupCapabilities.

type RollupCapabilitySummary ¶ 

type RollupCapabilitySummary struct {
	Fields       map[string]map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_rollup_caps/types.ts#L28-L33

func NewRollupCapabilitySummary ¶ added in v8.5.0 

func NewRollupCapabilitySummary() *RollupCapabilitySummary

NewRollupCapabilitySummary returns a RollupCapabilitySummary.

type RollupJob ¶ 

type RollupJob struct {
	Config RollupJobConfiguration `json:"config"`
	Stats  RollupJobStats         `json:"stats"`
	Status RollupJobStatus        `json:"status"`
}

RollupJob type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_jobs/types.ts#L28-L32

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_jobs/types.ts#L34-L43

func NewRollupJobConfiguration ¶ added in v8.5.0 

func NewRollupJobConfiguration() *RollupJobConfiguration

NewRollupJobConfiguration returns a RollupJobConfiguration.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_jobs/types.ts#L45-L58

func NewRollupJobStats ¶ added in v8.5.0 

func NewRollupJobStats() *RollupJobStats

NewRollupJobStats returns a RollupJobStats.

type RollupJobStatus ¶ 

type RollupJobStatus struct {
	CurrentPosition map[string]interface{}            `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_jobs/types.ts#L60-L64

func NewRollupJobStatus ¶ added in v8.5.0 

func NewRollupJobStatus() *RollupJobStatus

NewRollupJobStatus returns a RollupJobStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_rollup_index_caps/types.ts#L28-L33

func NewRollupJobSummary ¶ added in v8.5.0 

func NewRollupJobSummary() *RollupJobSummary

NewRollupJobSummary returns a RollupJobSummary.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/get_rollup_index_caps/types.ts#L35-L39

func NewRollupJobSummaryField ¶ added in v8.5.0 

func NewRollupJobSummaryField() *RollupJobSummaryField

NewRollupJobSummaryField returns a RollupJobSummaryField.

type RoutingField ¶ 

type RoutingField struct {
	Required bool `json:"required"`
}

RoutingField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L50-L52

func NewRoutingField ¶ added in v8.5.0 

func NewRoutingField() *RoutingField

NewRoutingField returns a RoutingField.

type Row ¶ 

type Row []interface{}

Row type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/sql/types.ts#L28-L28

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Rule.ts#L52-L65

func NewRuleCondition ¶ added in v8.5.0 

func NewRuleCondition() *RuleCondition

NewRuleCondition returns a RuleCondition.

type RunningStateSearchInterval ¶ 

type RunningStateSearchInterval struct {
	End     *Duration `json:"end,omitempty"`
	EndMs   int64     `json:"end_ms"`
	Start   *Duration `json:"start,omitempty"`
	StartMs int64     `json:"start_ms"`
}

RunningStateSearchInterval type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Datafeed.ts#L164-L169

func NewRunningStateSearchInterval ¶ added in v8.5.0 

func NewRunningStateSearchInterval() *RunningStateSearchInterval

NewRunningStateSearchInterval returns a RunningStateSearchInterval.

type RuntimeField ¶ 

type RuntimeField struct {
	Format *string                           `json:"format,omitempty"`
	Script *Script                           `json:"script,omitempty"`
	Type   runtimefieldtype.RuntimeFieldType `json:"type"`
}

RuntimeField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/RuntimeFields.ts#L26-L30

func NewRuntimeField ¶ added in v8.5.0 

func NewRuntimeField() *RuntimeField

NewRuntimeField returns a RuntimeField.

type RuntimeFields ¶ 

type RuntimeFields map[string]RuntimeField

RuntimeFields type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L264-L279

func NewRuntimeFieldsType ¶ added in v8.5.0 

func NewRuntimeFieldsType() *RuntimeFieldsType

NewRuntimeFieldsType returns a RuntimeFieldsType.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L76-L82

func NewSLMPolicy ¶ added in v8.5.0 

func NewSLMPolicy() *SLMPolicy

NewSLMPolicy returns a SLMPolicy.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/ExploreControls.ts#L31-L34

func NewSampleDiversity ¶ added in v8.5.0 

func NewSampleDiversity() *SampleDiversity

NewSampleDiversity returns a SampleDiversity.

type SamplerAggregate ¶ 

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

SamplerAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L497-L498

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

type SamplerAggregation ¶ 

type SamplerAggregation struct {
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,omitempty"`
	ShardSize *int                   `json:"shard_size,omitempty"`
}

SamplerAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L318-L320

func NewSamplerAggregation ¶ added in v8.5.0 

func NewSamplerAggregation() *SamplerAggregation

NewSamplerAggregation returns a SamplerAggregation.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L171-L175

func NewScaledFloatNumberProperty ¶ added in v8.5.0 

func NewScaledFloatNumberProperty() *ScaledFloatNumberProperty

NewScaledFloatNumberProperty returns a ScaledFloatNumberProperty.

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"`
	Weekly   []TimeOfWeek    `json:"weekly,omitempty"`
	Yearly   []TimeOfYear    `json:"yearly,omitempty"`
}

ScheduleContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L85-L96

func NewScheduleContainer ¶ added in v8.5.0 

func NewScheduleContainer() *ScheduleContainer

NewScheduleContainer returns a ScheduleContainer.

type ScheduleTimeOfDay ¶ 

type ScheduleTimeOfDay interface{}

ScheduleTimeOfDay holds the union for the following types: 

string
HourAndMinute

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L103-L108

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L98-L101

func NewScheduleTriggerEvent ¶ added in v8.5.0 

func NewScheduleTriggerEvent() *ScheduleTriggerEvent

NewScheduleTriggerEvent returns a ScheduleTriggerEvent.

type ScoreSort ¶ 

type ScoreSort struct {
	Order *sortorder.SortOrder `json:"order,omitempty"`
}

ScoreSort type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L55-L57

func NewScoreSort ¶ added in v8.5.0 

func NewScoreSort() *ScoreSort

NewScoreSort returns a ScoreSort.

type Script ¶ 

type Script interface {
	// contains filtered or unexported methods
}

Script holds the union for the following types: 

InlineScript
StoredScriptId

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Scripting.ts#L56-L57

type ScriptCache ¶ 

type ScriptCache struct {
	CacheEvictions            *int64  `json:"cache_evictions,omitempty"`
	CompilationLimitTriggered *int64  `json:"compilation_limit_triggered,omitempty"`
	Compilations              *int64  `json:"compilations,omitempty"`
	Context                   *string `json:"context,omitempty"`
}

ScriptCache type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L406-L411

func NewScriptCache ¶ added in v8.5.0 

func NewScriptCache() *ScriptCache

NewScriptCache returns a ScriptCache.

type ScriptCondition ¶ 

type ScriptCondition struct {
	Id     *string                `json:"id,omitempty"`
	Lang   *string                `json:"lang,omitempty"`
	Params map[string]interface{} `json:"params,omitempty"`
	Source *string                `json:"source,omitempty"`
}

ScriptCondition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Conditions.ts#L76-L84

func NewScriptCondition ¶ added in v8.5.0 

func NewScriptCondition() *ScriptCondition

NewScriptCondition returns a ScriptCondition.

type ScriptField ¶ 

type ScriptField struct {
	IgnoreFailure *bool  `json:"ignore_failure,omitempty"`
	Script        Script `json:"script"`
}

ScriptField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Scripting.ts#L59-L62

func NewScriptField ¶ added in v8.5.0 

func NewScriptField() *ScriptField

NewScriptField returns a ScriptField.

type ScriptQuery ¶ 

type ScriptQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Script     Script   `json:"script"`
}

ScriptQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L164-L166

func NewScriptQuery ¶ added in v8.5.0 

func NewScriptQuery() *ScriptQuery

NewScriptQuery returns a ScriptQuery.

type ScriptScoreFunction ¶ 

type ScriptScoreFunction struct {
	Script Script `json:"script"`
}

ScriptScoreFunction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/compound.ts#L61-L63

func NewScriptScoreFunction ¶ added in v8.5.0 

func NewScriptScoreFunction() *ScriptScoreFunction

NewScriptScoreFunction returns a ScriptScoreFunction.

type ScriptScoreQuery ¶ 

type ScriptScoreQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	MinScore   *float32 `json:"min_score,omitempty"`
	Query      *Query   `json:"query,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Script     Script   `json:"script"`
}

ScriptScoreQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L168-L172

func NewScriptScoreQuery ¶ added in v8.5.0 

func NewScriptScoreQuery() *ScriptScoreQuery

NewScriptScoreQuery returns a ScriptScoreQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L68-L74

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]interface{} `json:"params,omitempty"`
	Source *string                `json:"source,omitempty"`
}

ScriptTransform type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Transform.ts#L36-L44

func NewScriptTransform ¶ added in v8.5.0 

func NewScriptTransform() *ScriptTransform

NewScriptTransform returns a ScriptTransform.

type ScriptedHeuristic ¶ 

type ScriptedHeuristic struct {
	Script Script `json:"script"`
}

ScriptedHeuristic type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L338-L340

func NewScriptedHeuristic ¶ added in v8.5.0 

func NewScriptedHeuristic() *ScriptedHeuristic

NewScriptedHeuristic returns a ScriptedHeuristic.

type ScriptedMetricAggregate ¶ 

type ScriptedMetricAggregate struct {
	Meta  map[string]interface{} `json:"meta,omitempty"`
	Value interface{}            `json:"value,omitempty"`
}

ScriptedMetricAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L640-L643

func NewScriptedMetricAggregate ¶ added in v8.5.0 

func NewScriptedMetricAggregate() *ScriptedMetricAggregate

NewScriptedMetricAggregate returns a ScriptedMetricAggregate.

type ScriptedMetricAggregation ¶ 

type ScriptedMetricAggregation struct {
	CombineScript *Script                `json:"combine_script,omitempty"`
	Field         *string                `json:"field,omitempty"`
	InitScript    *Script                `json:"init_script,omitempty"`
	MapScript     *Script                `json:"map_script,omitempty"`
	Missing       *Missing               `json:"missing,omitempty"`
	Params        map[string]interface{} `json:"params,omitempty"`
	ReduceScript  *Script                `json:"reduce_script,omitempty"`
	Script        *Script                `json:"script,omitempty"`
}

ScriptedMetricAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L137-L143

func NewScriptedMetricAggregation ¶ added in v8.5.0 

func NewScriptedMetricAggregation() *ScriptedMetricAggregation

NewScriptedMetricAggregation returns a ScriptedMetricAggregation.

type Scripting ¶ 

type Scripting struct {
	CacheEvictions            *int64         `json:"cache_evictions,omitempty"`
	CompilationLimitTriggered *int64         `json:"compilation_limit_triggered,omitempty"`
	Compilations              *int64         `json:"compilations,omitempty"`
	Contexts                  []NodesContext `json:"contexts,omitempty"`
}

Scripting type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L383-L388

func NewScripting ¶ added in v8.5.0 

func NewScripting() *Scripting

NewScripting returns a Scripting.

type ScrollIds ¶ 

type ScrollIds []string

ScrollIds type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L50-L50

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"`
	TermVector          *termvectoroption.TermVectorOption `json:"term_vector,omitempty"`
	Type                string                             `json:"type,omitempty"`
}

SearchAsYouTypeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L190-L200

func NewSearchAsYouTypeProperty ¶ added in v8.5.0 

func NewSearchAsYouTypeProperty() *SearchAsYouTypeProperty

NewSearchAsYouTypeProperty returns a SearchAsYouTypeProperty.

type SearchIdle ¶ 

type SearchIdle struct {
	After *Duration `json:"after,omitempty"`
}

SearchIdle type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L236-L239

func NewSearchIdle ¶ added in v8.5.0 

func NewSearchIdle() *SearchIdle

NewSearchIdle returns a SearchIdle.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L112-L116

func NewSearchInput ¶ added in v8.5.0 

func NewSearchInput() *SearchInput

NewSearchInput returns a SearchInput.

type SearchInputRequestBody ¶ 

type SearchInputRequestBody struct {
	Query Query `json:"query"`
}

SearchInputRequestBody type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L147-L149

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L118-L125

func NewSearchInputRequestDefinition ¶ added in v8.5.0 

func NewSearchInputRequestDefinition() *SearchInputRequestDefinition

NewSearchInputRequestDefinition returns a SearchInputRequestDefinition.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L126-L130

func NewSearchProfile ¶ added in v8.5.0 

func NewSearchProfile() *SearchProfile

NewSearchProfile returns a SearchProfile.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L185-L204

func NewSearchStats ¶ added in v8.5.0 

func NewSearchStats() *SearchStats

NewSearchStats returns a SearchStats.

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]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L128-L145

func NewSearchTemplateRequestBody ¶ added in v8.5.0 

func NewSearchTemplateRequestBody() *SearchTemplateRequestBody

NewSearchTemplateRequestBody returns a SearchTemplateRequestBody.

type SearchTransform ¶ 

type SearchTransform struct {
	Request SearchInputRequestDefinition `json:"request"`
	Timeout Duration                     `json:"timeout"`
}

SearchTransform type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Transform.ts#L46-L49

func NewSearchTransform ¶ added in v8.5.0 

func NewSearchTransform() *SearchTransform

NewSearchTransform returns a SearchTransform.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L410-L414

func NewSearchableSnapshots ¶ added in v8.5.0 

func NewSearchableSnapshots() *SearchableSnapshots

NewSearchableSnapshots returns a SearchableSnapshots.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L416-L429

func NewSecurity ¶ added in v8.5.0 

func NewSecurity() *Security

NewSecurity returns a Security.

type SecurityRealm ¶ added in v8.5.0 

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

SecurityRealm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleMappingRule.ts#L44-L46

func NewSecurityRealm ¶ added in v8.5.0 

func NewSecurityRealm() *SecurityRealm

NewSecurityRealm returns a SecurityRealm.

type SecurityRoleMapping ¶ added in v8.5.0 

type SecurityRoleMapping struct {
	Enabled       bool                   `json:"enabled"`
	Metadata      map[string]interface{} `json:"metadata"`
	RoleTemplates []RoleTemplate         `json:"role_templates,omitempty"`
	Roles         []string               `json:"roles"`
	Rules         RoleMappingRule        `json:"rules"`
}

SecurityRoleMapping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/RoleMapping.ts#L25-L31

func NewSecurityRoleMapping ¶ added in v8.5.0 

func NewSecurityRoleMapping() *SecurityRoleMapping

NewSecurityRoleMapping returns a SecurityRoleMapping.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L281-L285

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L293-L295

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L297-L301

func NewSecurityRolesDlsBitSetCache ¶ added in v8.5.0 

func NewSecurityRolesDlsBitSetCache() *SecurityRolesDlsBitSetCache

NewSecurityRolesDlsBitSetCache returns a SecurityRolesDlsBitSetCache.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L303-L307

func NewSecurityRolesFile ¶ added in v8.5.0 

func NewSecurityRolesFile() *SecurityRolesFile

NewSecurityRolesFile returns a SecurityRolesFile.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L287-L291

func NewSecurityRolesNative ¶ added in v8.5.0 

func NewSecurityRolesNative() *SecurityRolesNative

NewSecurityRolesNative returns a SecurityRolesNative.

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"`
	MemoryInBytes float64           `json:"memory_in_bytes"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/segments/types.ts#L28-L39

func NewSegment ¶ added in v8.5.0 

func NewSegment() *Segment

NewSegment returns a Segment.

type SegmentsRecord ¶ 

type SegmentsRecord struct {
	// Committed is segment committed
	Committed *string `json:"committed,omitempty"`
	// Compound is segment compound
	Compound *string `json:"compound,omitempty"`
	// DocsCount number of docs in segment
	DocsCount *string `json:"docs.count,omitempty"`
	// DocsDeleted number of deleted docs in segment
	DocsDeleted *string `json:"docs.deleted,omitempty"`
	// Generation segment generation
	Generation *string `json:"generation,omitempty"`
	// Id unique id of node where it lives
	Id *string `json:"id,omitempty"`
	// Index index name
	Index *string `json:"index,omitempty"`
	// Ip ip of node where it lives
	Ip *string `json:"ip,omitempty"`
	// Prirep primary or replica
	Prirep *string `json:"prirep,omitempty"`
	// Searchable is segment searched
	Searchable *string `json:"searchable,omitempty"`
	// Segment segment name
	Segment *string `json:"segment,omitempty"`
	// Shard shard name
	Shard *string `json:"shard,omitempty"`
	// Size segment size in bytes
	Size *ByteSize `json:"size,omitempty"`
	// SizeMemory segment memory in bytes
	SizeMemory *ByteSize `json:"size.memory,omitempty"`
	// Version version
	Version *string `json:"version,omitempty"`
}

SegmentsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/segments/types.ts#L22-L96

func NewSegmentsRecord ¶ added in v8.5.0 

func NewSegmentsRecord() *SegmentsRecord

NewSegmentsRecord returns a SegmentsRecord.

type SegmentsStats ¶ 

type SegmentsStats struct {
	Count                       int                          `json:"count"`
	DocValuesMemory             *ByteSize                    `json:"doc_values_memory,omitempty"`
	DocValuesMemoryInBytes      int                          `json:"doc_values_memory_in_bytes"`
	FileSizes                   map[string]ShardFileSizeInfo `json:"file_sizes"`
	FixedBitSet                 *ByteSize                    `json:"fixed_bit_set,omitempty"`
	FixedBitSetMemoryInBytes    int                          `json:"fixed_bit_set_memory_in_bytes"`
	IndexWriterMaxMemoryInBytes *int                         `json:"index_writer_max_memory_in_bytes,omitempty"`
	IndexWriterMemory           *ByteSize                    `json:"index_writer_memory,omitempty"`
	IndexWriterMemoryInBytes    int                          `json:"index_writer_memory_in_bytes"`
	MaxUnsafeAutoIdTimestamp    int64                        `json:"max_unsafe_auto_id_timestamp"`
	Memory                      *ByteSize                    `json:"memory,omitempty"`
	MemoryInBytes               int                          `json:"memory_in_bytes"`
	NormsMemory                 *ByteSize                    `json:"norms_memory,omitempty"`
	NormsMemoryInBytes          int                          `json:"norms_memory_in_bytes"`
	PointsMemory                *ByteSize                    `json:"points_memory,omitempty"`
	PointsMemoryInBytes         int                          `json:"points_memory_in_bytes"`
	StoredFieldsMemoryInBytes   int                          `json:"stored_fields_memory_in_bytes"`
	StoredMemory                *ByteSize                    `json:"stored_memory,omitempty"`
	TermVectorsMemoryInBytes    int                          `json:"term_vectors_memory_in_bytes"`
	TermVectoryMemory           *ByteSize                    `json:"term_vectory_memory,omitempty"`
	TermsMemory                 *ByteSize                    `json:"terms_memory,omitempty"`
	TermsMemoryInBytes          int                          `json:"terms_memory_in_bytes"`
	VersionMapMemory            *ByteSize                    `json:"version_map_memory,omitempty"`
	VersionMapMemoryInBytes     int                          `json:"version_map_memory_in_bytes"`
}

SegmentsStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L206-L231

func NewSegmentsStats ¶ added in v8.5.0 

func NewSegmentsStats() *SegmentsStats

NewSegmentsStats returns a SegmentsStats.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Lag         *int                   `json:"lag,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

SerialDifferencingAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L280-L282

func NewSerialDifferencingAggregation ¶ added in v8.5.0 

func NewSerialDifferencingAggregation() *SerialDifferencingAggregation

NewSerialDifferencingAggregation returns a SerialDifferencingAggregation.

type SerializedClusterState ¶ 

type SerializedClusterState struct {
	Diffs      *SerializedClusterStateDetail `json:"diffs,omitempty"`
	FullStates *SerializedClusterStateDetail `json:"full_states,omitempty"`
}

SerializedClusterState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L95-L98

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L100-L106

func NewSerializedClusterStateDetail ¶ added in v8.5.0 

func NewSerializedClusterStateDetail() *SerializedClusterStateDetail

NewSerializedClusterStateDetail returns a SerializedClusterStateDetail.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/create_service_token/types.ts#L22-L25

func NewServiceToken ¶ added in v8.5.0 

func NewServiceToken() *ServiceToken

NewServiceToken returns a ServiceToken.

type SetProcessor ¶ 

type SetProcessor struct {
	CopyFrom         *string              `json:"copy_from,omitempty"`
	Description      *string              `json:"description,omitempty"`
	Field            string               `json:"field"`
	If               *string              `json:"if,omitempty"`
	IgnoreEmptyValue *bool                `json:"ignore_empty_value,omitempty"`
	IgnoreFailure    *bool                `json:"ignore_failure,omitempty"`
	MediaType        *string              `json:"media_type,omitempty"`
	OnFailure        []ProcessorContainer `json:"on_failure,omitempty"`
	Override         *bool                `json:"override,omitempty"`
	Tag              *string              `json:"tag,omitempty"`
	Value            interface{}          `json:"value,omitempty"`
}

SetProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L329-L336

func NewSetProcessor ¶ added in v8.5.0 

func NewSetProcessor() *SetProcessor

NewSetProcessor returns a SetProcessor.

type SetSecurityUserProcessor ¶ 

type SetSecurityUserProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Properties    []string             `json:"properties,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
}

SetSecurityUserProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L338-L341

func NewSetSecurityUserProcessor ¶ added in v8.5.0 

func NewSetSecurityUserProcessor() *SetSecurityUserProcessor

NewSetSecurityUserProcessor returns a SetSecurityUserProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L98-L143

func NewSettings ¶ added in v8.5.0 

func NewSettings() *Settings

NewSettings returns a Settings.

type SettingsAnalyze ¶ 

type SettingsAnalyze struct {
	MaxTokenCount *int `json:"max_token_count,omitempty"`
}

SettingsAnalyze type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L226-L229

func NewSettingsAnalyze ¶ added in v8.5.0 

func NewSettingsAnalyze() *SettingsAnalyze

NewSettingsAnalyze returns a SettingsAnalyze.

type SettingsHighlight ¶ 

type SettingsHighlight struct {
	MaxAnalyzedOffset *int `json:"max_analyzed_offset,omitempty"`
}

SettingsHighlight type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L221-L224

func NewSettingsHighlight ¶ added in v8.5.0 

func NewSettingsHighlight() *SettingsHighlight

NewSettingsHighlight returns a SettingsHighlight.

type SettingsQueryString ¶ 

type SettingsQueryString struct {
	Lenient bool `json:"lenient"`
}

SettingsQueryString type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L241-L243

func NewSettingsQueryString ¶ added in v8.5.0 

func NewSettingsQueryString() *SettingsQueryString

NewSettingsQueryString returns a SettingsQueryString.

type SettingsSearch ¶ 

type SettingsSearch struct {
	Idle    *SearchIdle      `json:"idle,omitempty"`
	Slowlog *SlowlogSettings `json:"slowlog,omitempty"`
}

SettingsSearch type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L231-L234

func NewSettingsSearch ¶ added in v8.5.0 

func NewSettingsSearch() *SettingsSearch

NewSettingsSearch returns a SettingsSearch.

type SettingsSimilarity ¶ 

type SettingsSimilarity struct {
	Bm25          *SettingsSimilarityBm25          `json:"bm25,omitempty"`
	Dfi           *SettingsSimilarityDfi           `json:"dfi,omitempty"`
	Dfr           *SettingsSimilarityDfr           `json:"dfr,omitempty"`
	Ib            *SettingsSimilarityIb            `json:"ib,omitempty"`
	Lmd           *SettingsSimilarityLmd           `json:"lmd,omitempty"`
	Lmj           *SettingsSimilarityLmj           `json:"lmj,omitempty"`
	ScriptedTfidf *SettingsSimilarityScriptedTfidf `json:"scripted_tfidf,omitempty"`
}

SettingsSimilarity type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L170-L178

func NewSettingsSimilarity ¶ added in v8.5.0 

func NewSettingsSimilarity() *SettingsSimilarity

NewSettingsSimilarity returns a SettingsSimilarity.

type SettingsSimilarityBm25 ¶ 

type SettingsSimilarityBm25 struct {
	B                float64 `json:"b"`
	DiscountOverlaps bool    `json:"discount_overlaps"`
	K1               float64 `json:"k1"`
	Type             string  `json:"type,omitempty"`
}

SettingsSimilarityBm25 type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L180-L185

func NewSettingsSimilarityBm25 ¶ added in v8.5.0 

func NewSettingsSimilarityBm25() *SettingsSimilarityBm25

NewSettingsSimilarityBm25 returns a SettingsSimilarityBm25.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L187-L190

func NewSettingsSimilarityDfi ¶ added in v8.5.0 

func NewSettingsSimilarityDfi() *SettingsSimilarityDfi

NewSettingsSimilarityDfi returns a SettingsSimilarityDfi.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L192-L197

func NewSettingsSimilarityDfr ¶ added in v8.5.0 

func NewSettingsSimilarityDfr() *SettingsSimilarityDfr

NewSettingsSimilarityDfr returns a SettingsSimilarityDfr.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L199-L204

func NewSettingsSimilarityIb ¶ added in v8.5.0 

func NewSettingsSimilarityIb() *SettingsSimilarityIb

NewSettingsSimilarityIb returns a SettingsSimilarityIb.

type SettingsSimilarityLmd ¶ 

type SettingsSimilarityLmd struct {
	Mu   int    `json:"mu"`
	Type string `json:"type,omitempty"`
}

SettingsSimilarityLmd type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L206-L209

func NewSettingsSimilarityLmd ¶ added in v8.5.0 

func NewSettingsSimilarityLmd() *SettingsSimilarityLmd

NewSettingsSimilarityLmd returns a SettingsSimilarityLmd.

type SettingsSimilarityLmj ¶ 

type SettingsSimilarityLmj struct {
	Lambda float64 `json:"lambda"`
	Type   string  `json:"type,omitempty"`
}

SettingsSimilarityLmj type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L211-L214

func NewSettingsSimilarityLmj ¶ added in v8.5.0 

func NewSettingsSimilarityLmj() *SettingsSimilarityLmj

NewSettingsSimilarityLmj returns a SettingsSimilarityLmj.

type SettingsSimilarityScriptedTfidf ¶ 

type SettingsSimilarityScriptedTfidf struct {
	Script Script `json:"script"`
	Type   string `json:"type,omitempty"`
}

SettingsSimilarityScriptedTfidf type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L216-L219

func NewSettingsSimilarityScriptedTfidf ¶ added in v8.5.0 

func NewSettingsSimilarityScriptedTfidf() *SettingsSimilarityScriptedTfidf

NewSettingsSimilarityScriptedTfidf returns a SettingsSimilarityScriptedTfidf.

type ShapeFieldQuery ¶ 

type ShapeFieldQuery struct {
	IndexedShape *FieldLookup                       `json:"indexed_shape,omitempty"`
	Relation     *geoshaperelation.GeoShapeRelation `json:"relation,omitempty"`
	Shape        interface{}                        `json:"shape,omitempty"`
}

ShapeFieldQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L183-L187

func NewShapeFieldQuery ¶ added in v8.5.0 

func NewShapeFieldQuery() *ShapeFieldQuery

NewShapeFieldQuery returns a ShapeFieldQuery.

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"`
	Similarity  *string                        `json:"similarity,omitempty"`
	Store       *bool                          `json:"store,omitempty"`
	Type        string                         `json:"type,omitempty"`
}

ShapeProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/geo.ts#L69-L81

func NewShapeProperty ¶ added in v8.5.0 

func NewShapeProperty() *ShapeProperty

NewShapeProperty returns a ShapeProperty.

type ShapeQuery ¶ 

type ShapeQuery struct {
	Boost          *float32                   `json:"boost,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/specialized.ts#L176-L181

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L100-L105

func NewShardCommit ¶ added in v8.5.0 

func NewShardCommit() *ShardCommit

NewShardCommit returns a ShardCommit.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Errors.ts#L50-L56

func NewShardFailure ¶ added in v8.5.0 

func NewShardFailure() *ShardFailure

NewShardFailure returns a ShardFailure.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L112-L119

func NewShardFileSizeInfo ¶ added in v8.5.0 

func NewShardFileSizeInfo() *ShardFileSizeInfo

NewShardFileSizeInfo returns a ShardFileSizeInfo.

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"`
	UnassignedShards   int                       `json:"unassigned_shards"`
}

ShardHealthStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/health/types.ts#L36-L43

func NewShardHealthStats ¶ added in v8.5.0 

func NewShardHealthStats() *ShardHealthStats

NewShardHealthStats returns a ShardHealthStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L121-L126

func NewShardLease ¶ added in v8.5.0 

func NewShardLease() *ShardLease

NewShardLease returns a ShardLease.

type ShardMigrationStatus ¶ 

type ShardMigrationStatus struct {
	Status shutdownstatus.ShutdownStatus `json:"status"`
}

ShardMigrationStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L128-L132

func NewShardPath ¶ added in v8.5.0 

func NewShardPath() *ShardPath

NewShardPath returns a ShardPath.

type ShardProfile ¶ 

type ShardProfile struct {
	Aggregations []AggregationProfile `json:"aggregations"`
	Fetch        *FetchProfile        `json:"fetch,omitempty"`
	Id           string               `json:"id"`
	Searches     []SearchProfile      `json:"searches"`
}

ShardProfile type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/profile.ts#L132-L137

func NewShardProfile ¶ added in v8.5.0 

func NewShardProfile() *ShardProfile

NewShardProfile returns a ShardProfile.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L134-L142

func NewShardQueryCache ¶ added in v8.5.0 

func NewShardQueryCache() *ShardQueryCache

NewShardQueryCache returns a ShardQueryCache.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L118-L135

func NewShardRecovery ¶ added in v8.5.0 

func NewShardRecovery() *ShardRecovery

NewShardRecovery returns a ShardRecovery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L144-L148

func NewShardRetentionLeases ¶ added in v8.5.0 

func NewShardRetentionLeases() *ShardRetentionLeases

NewShardRetentionLeases returns a ShardRetentionLeases.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L150-L155

func NewShardRouting ¶ added in v8.5.0 

func NewShardRouting() *ShardRouting

NewShardRouting returns a ShardRouting.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/segments/types.ts#L41-L45

func NewShardSegmentRouting ¶ added in v8.5.0 

func NewShardSegmentRouting() *ShardSegmentRouting

NewShardSegmentRouting returns a ShardSegmentRouting.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L164-L168

func NewShardSequenceNumber ¶ added in v8.5.0 

func NewShardSequenceNumber() *ShardSequenceNumber

NewShardSequenceNumber returns a ShardSequenceNumber.

type ShardStatistics ¶ 

type ShardStatistics struct {
	Failed     uint           `json:"failed"`
	Failures   []ShardFailure `json:"failures,omitempty"`
	Skipped    *uint          `json:"skipped,omitempty"`
	Successful uint           `json:"successful"`
	Total      uint           `json:"total"`
}

ShardStatistics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L33-L39

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"`
	Attributes       map[string]interface{}                    `json:"attributes"`
	Id               string                                    `json:"id"`
	LegacyVersion    int64                                     `json:"legacy_version"`
	Name             string                                    `json:"name"`
	StoreException   ShardStoreException                       `json:"store_exception"`
	TransportAddress string                                    `json:"transport_address"`
}

ShardStore type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/shard_stores/types.ts#L29-L38

func NewShardStore ¶ added in v8.5.0 

func NewShardStore() *ShardStore

NewShardStore returns a ShardStore.

type ShardStoreException ¶ 

type ShardStoreException struct {
	Reason string `json:"reason"`
	Type   string `json:"type"`
}

ShardStoreException type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/shard_stores/types.ts#L46-L49

func NewShardStoreException ¶ added in v8.5.0 

func NewShardStoreException() *ShardStoreException

NewShardStoreException returns a ShardStoreException.

type ShardStoreIndex ¶ 

type ShardStoreIndex struct {
	Aliases []string `json:"aliases,omitempty"`
	Filter  *Query   `json:"filter,omitempty"`
}

ShardStoreIndex type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search_shards/SearchShardsResponse.ts#L33-L36

func NewShardStoreIndex ¶ added in v8.5.0 

func NewShardStoreIndex() *ShardStoreIndex

NewShardStoreIndex returns a ShardStoreIndex.

type ShardStoreWrapper ¶ 

type ShardStoreWrapper struct {
	Stores []ShardStore `json:"stores"`
}

ShardStoreWrapper type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/shard_stores/types.ts#L51-L53

func NewShardStoreWrapper ¶ added in v8.5.0 

func NewShardStoreWrapper() *ShardStoreWrapper

NewShardStoreWrapper returns a ShardStoreWrapper.

type ShardsRecord ¶ 

type ShardsRecord struct {
	// BulkAvgSizeInBytes avg 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"`
	// Docs number of docs in shard
	Docs string `json:"docs,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"`
	// Id unique id of node where it lives
	Id *string `json:"id,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"`
	// Ip ip of node where it lives
	Ip string `json:"ip,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"`
	// Node name of node where it lives
	Node string `json:"node,omitempty"`
	// PathData shard data path
	PathData *string `json:"path.data,omitempty"`
	// PathState shard state path
	PathState *string `json:"path.state,omitempty"`
	// Prirep primary or replica
	Prirep *string `json:"prirep,omitempty"`
	// QueryCacheEvictions query cache evictions
	QueryCacheEvictions *string `json:"query_cache.evictions,omitempty"`
	// QueryCacheMemorySize used query cache
	QueryCacheMemorySize *string `json:"query_cache.memory_size,omitempty"`
	// RecoverysourceType recovery source type
	RecoverysourceType *string `json:"recoverysource.type,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"`
	// 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"`
	// 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"`
	// SeqNoGlobalCheckpoint global checkpoint
	SeqNoGlobalCheckpoint *string `json:"seq_no.global_checkpoint,omitempty"`
	// SeqNoLocalCheckpoint local checkpoint
	SeqNoLocalCheckpoint *string `json:"seq_no.local_checkpoint,omitempty"`
	// SeqNoMax max sequence number
	SeqNoMax *string `json:"seq_no.max,omitempty"`
	// Shard shard name
	Shard *string `json:"shard,omitempty"`
	// State shard state
	State *string `json:"state,omitempty"`
	// Store store size of shard (how much disk it uses)
	Store string `json:"store,omitempty"`
	// SyncId sync id
	SyncId *string `json:"sync_id,omitempty"`
	// UnassignedAt time shard became unassigned (UTC)
	UnassignedAt *string `json:"unassigned.at,omitempty"`
	// UnassignedDetails additional details as to why the shard became unassigned
	UnassignedDetails *string `json:"unassigned.details,omitempty"`
	// UnassignedFor time has been unassigned
	UnassignedFor *string `json:"unassigned.for,omitempty"`
	// UnassignedReason reason shard is unassigned
	UnassignedReason *string `json:"unassigned.reason,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"`
}

ShardsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/shards/types.ts#L20-L396

func NewShardsRecord ¶ added in v8.5.0 

func NewShardsRecord() *ShardsRecord

NewShardsRecord returns a ShardsRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/segments/types.ts#L47-L52

func NewShardsSegment ¶ added in v8.5.0 

func NewShardsSegment() *ShardsSegment

NewShardsSegment returns a ShardsSegment.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotShardsStatus.ts#L29-L35

func NewShardsStatsSummary ¶ added in v8.5.0 

func NewShardsStatsSummary() *ShardsStatsSummary

NewShardsStatsSummary returns a ShardsStatsSummary.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotShardsStatus.ts#L37-L40

func NewShardsStatsSummaryItem ¶ added in v8.5.0 

func NewShardsStatsSummaryItem() *ShardsStatsSummaryItem

NewShardsStatsSummaryItem returns a ShardsStatsSummaryItem.

type ShardsTotalStats ¶ 

type ShardsTotalStats struct {
	TotalCount int64 `json:"total_count"`
}

ShardsTotalStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/stats/types.ts#L170-L172

func NewShardsTotalStats ¶ added in v8.5.0 

func NewShardsTotalStats() *ShardsTotalStats

NewShardsTotalStats returns a ShardsTotalStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/searchable_snapshots/cache_stats/Response.ts#L34-L43

func NewShared ¶ added in v8.5.0 

func NewShared() *Shared

NewShared returns a Shared.

type ShingleTokenFilter ¶ 

type ShingleTokenFilter struct {
	FillerToken                *string `json:"filler_token,omitempty"`
	MaxShingleSize             string  `json:"max_shingle_size,omitempty"`
	MinShingleSize             string  `json:"min_shingle_size,omitempty"`
	OutputUnigrams             *bool   `json:"output_unigrams,omitempty"`
	OutputUnigramsIfNoShingles *bool   `json:"output_unigrams_if_no_shingles,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L86-L94

func NewShingleTokenFilter ¶ added in v8.5.0 

func NewShingleTokenFilter() *ShingleTokenFilter

NewShingleTokenFilter returns a ShingleTokenFilter.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L156-L159

func NewShortNumberProperty ¶ added in v8.5.0 

func NewShortNumberProperty() *ShortNumberProperty

NewShortNumberProperty returns a ShortNumberProperty.

type ShrinkConfiguration ¶ 

type ShrinkConfiguration struct {
	NumberOfShards int `json:"number_of_shards"`
}

ShrinkConfiguration type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/_types/Phase.ts#L57-L59

func NewShrinkConfiguration ¶ added in v8.5.0 

func NewShrinkConfiguration() *ShrinkConfiguration

NewShrinkConfiguration returns a ShrinkConfiguration.

type SignificantLongTermsAggregate ¶ 

type SignificantLongTermsAggregate struct {
	BgCount  *int64                            `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantLongTermsBucket `json:"buckets"`
	DocCount *int64                            `json:"doc_count,omitempty"`
	Meta     map[string]interface{}            `json:"meta,omitempty"`
}

SignificantLongTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L587-L589

func NewSignificantLongTermsAggregate ¶ added in v8.5.0 

func NewSignificantLongTermsAggregate() *SignificantLongTermsAggregate

NewSignificantLongTermsAggregate returns a SignificantLongTermsAggregate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L596-L599

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

type SignificantStringTermsAggregate ¶ 

type SignificantStringTermsAggregate struct {
	BgCount  *int64                              `json:"bg_count,omitempty"`
	Buckets  BucketsSignificantStringTermsBucket `json:"buckets"`
	DocCount *int64                              `json:"doc_count,omitempty"`
	Meta     map[string]interface{}              `json:"meta,omitempty"`
}

SignificantStringTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L601-L603

func NewSignificantStringTermsAggregate ¶ added in v8.5.0 

func NewSignificantStringTermsAggregate() *SignificantStringTermsAggregate

NewSignificantStringTermsAggregate returns a SignificantStringTermsAggregate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L605-L607

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

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     map[string]interface{}            `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseSignificantLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L580-L585

func NewSignificantTermsAggregateBaseSignificantLongTermsBucket ¶ added in v8.5.0 

func NewSignificantTermsAggregateBaseSignificantLongTermsBucket() *SignificantTermsAggregateBaseSignificantLongTermsBucket

NewSignificantTermsAggregateBaseSignificantLongTermsBucket returns a SignificantTermsAggregateBaseSignificantLongTermsBucket.

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     map[string]interface{}              `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseSignificantStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L580-L585

func NewSignificantTermsAggregateBaseSignificantStringTermsBucket ¶ added in v8.5.0 

func NewSignificantTermsAggregateBaseSignificantStringTermsBucket() *SignificantTermsAggregateBaseSignificantStringTermsBucket

NewSignificantTermsAggregateBaseSignificantStringTermsBucket returns a SignificantTermsAggregateBaseSignificantStringTermsBucket.

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     map[string]interface{} `json:"meta,omitempty"`
}

SignificantTermsAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L580-L585

func NewSignificantTermsAggregateBaseVoid ¶ added in v8.5.0 

func NewSignificantTermsAggregateBaseVoid() *SignificantTermsAggregateBaseVoid

NewSignificantTermsAggregateBaseVoid returns a SignificantTermsAggregateBaseVoid.

type SignificantTermsAggregation ¶ 

type SignificantTermsAggregation struct {
	BackgroundFilter  *Query                                                       `json:"background_filter,omitempty"`
	ChiSquare         *ChiSquareHeuristic                                          `json:"chi_square,omitempty"`
	Exclude           []string                                                     `json:"exclude,omitempty"`
	ExecutionHint     *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	Field             *string                                                      `json:"field,omitempty"`
	Gnd               *GoogleNormalizedDistanceHeuristic                           `json:"gnd,omitempty"`
	Include           *TermsInclude                                                `json:"include,omitempty"`
	Jlh               *EmptyObject                                                 `json:"jlh,omitempty"`
	Meta              map[string]interface{}                                       `json:"meta,omitempty"`
	MinDocCount       *int64                                                       `json:"min_doc_count,omitempty"`
	MutualInformation *MutualInformationHeuristic                                  `json:"mutual_information,omitempty"`
	Name              *string                                                      `json:"name,omitempty"`
	Percentage        *PercentageScoreHeuristic                                    `json:"percentage,omitempty"`
	ScriptHeuristic   *ScriptedHeuristic                                           `json:"script_heuristic,omitempty"`
	ShardMinDocCount  *int64                                                       `json:"shard_min_doc_count,omitempty"`
	ShardSize         *int                                                         `json:"shard_size,omitempty"`
	Size              *int                                                         `json:"size,omitempty"`
}

SignificantTermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L342-L358

func NewSignificantTermsAggregation ¶ added in v8.5.0 

func NewSignificantTermsAggregation() *SignificantTermsAggregation

NewSignificantTermsAggregation returns a SignificantTermsAggregation.

type SignificantTextAggregation ¶ 

type SignificantTextAggregation struct {
	BackgroundFilter    *Query                                                       `json:"background_filter,omitempty"`
	ChiSquare           *ChiSquareHeuristic                                          `json:"chi_square,omitempty"`
	Exclude             []string                                                     `json:"exclude,omitempty"`
	ExecutionHint       *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	Field               *string                                                      `json:"field,omitempty"`
	FilterDuplicateText *bool                                                        `json:"filter_duplicate_text,omitempty"`
	Gnd                 *GoogleNormalizedDistanceHeuristic                           `json:"gnd,omitempty"`
	Include             []string                                                     `json:"include,omitempty"`
	Jlh                 *EmptyObject                                                 `json:"jlh,omitempty"`
	Meta                map[string]interface{}                                       `json:"meta,omitempty"`
	MinDocCount         *int64                                                       `json:"min_doc_count,omitempty"`
	MutualInformation   *MutualInformationHeuristic                                  `json:"mutual_information,omitempty"`
	Name                *string                                                      `json:"name,omitempty"`
	Percentage          *PercentageScoreHeuristic                                    `json:"percentage,omitempty"`
	ScriptHeuristic     *ScriptedHeuristic                                           `json:"script_heuristic,omitempty"`
	ShardMinDocCount    *int64                                                       `json:"shard_min_doc_count,omitempty"`
	ShardSize           *int                                                         `json:"shard_size,omitempty"`
	Size                *int                                                         `json:"size,omitempty"`
	SourceFields        []string                                                     `json:"source_fields,omitempty"`
}

SignificantTextAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L360-L378

func NewSignificantTextAggregation ¶ added in v8.5.0 

func NewSignificantTextAggregation() *SignificantTextAggregation

NewSignificantTextAggregation returns a SignificantTextAggregation.

type SimpleAnalyzer ¶ 

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

SimpleAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L83-L86

func NewSimpleAnalyzer ¶ added in v8.5.0 

func NewSimpleAnalyzer() *SimpleAnalyzer

NewSimpleAnalyzer returns a SimpleAnalyzer.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Minimize    *bool                  `json:"minimize,omitempty"`
	Model       string                 `json:"model,omitempty"`
	Name        *string                `json:"name,omitempty"`
	Predict     *int                   `json:"predict,omitempty"`
	Settings    EmptyObject            `json:"settings"`
	Window      *int                   `json:"window,omitempty"`
}

SimpleMovingAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L207-L210

func NewSimpleMovingAverageAggregation ¶ added in v8.5.0 

func NewSimpleMovingAverageAggregation() *SimpleMovingAverageAggregation

NewSimpleMovingAverageAggregation returns a SimpleMovingAverageAggregation.

type SimpleQueryStringFlags ¶ 

type SimpleQueryStringFlags interface{}

SimpleQueryStringFlags holds the union for the following types: 

simplequerystringflag.SimpleQueryStringFlag
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L271-L276

type SimpleQueryStringQuery ¶ 

type SimpleQueryStringQuery struct {
	AnalyzeWildcard                 *bool                   `json:"analyze_wildcard,omitempty"`
	Analyzer                        *string                 `json:"analyzer,omitempty"`
	AutoGenerateSynonymsPhraseQuery *bool                   `json:"auto_generate_synonyms_phrase_query,omitempty"`
	Boost                           *float32                `json:"boost,omitempty"`
	DefaultOperator                 *operator.Operator      `json:"default_operator,omitempty"`
	Fields                          []string                `json:"fields,omitempty"`
	Flags                           *SimpleQueryStringFlags `json:"flags,omitempty"`
	FuzzyMaxExpansions              *int                    `json:"fuzzy_max_expansions,omitempty"`
	FuzzyPrefixLength               *int                    `json:"fuzzy_prefix_length,omitempty"`
	FuzzyTranspositions             *bool                   `json:"fuzzy_transpositions,omitempty"`
	Lenient                         *bool                   `json:"lenient,omitempty"`
	MinimumShouldMatch              *MinimumShouldMatch     `json:"minimum_should_match,omitempty"`
	Query                           string                  `json:"query"`
	QueryName_                      *string                 `json:"_name,omitempty"`
	QuoteFieldSuffix                *string                 `json:"quote_field_suffix,omitempty"`
}

SimpleQueryStringQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/fulltext.ts#L294-L312

func NewSimpleQueryStringQuery ¶ added in v8.5.0 

func NewSimpleQueryStringQuery() *SimpleQueryStringQuery

NewSimpleQueryStringQuery returns a SimpleQueryStringQuery.

type SimpleValueAggregate ¶ 

type SimpleValueAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L223-L224

func NewSimpleValueAggregate ¶ added in v8.5.0 

func NewSimpleValueAggregate() *SimpleValueAggregate

NewSimpleValueAggregate returns a SimpleValueAggregate.

type SimulateIngest ¶ added in v8.5.0 

type SimulateIngest struct {
	Pipeline  *string  `json:"pipeline,omitempty"`
	Timestamp DateTime `json:"timestamp"`
}

SimulateIngest type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/simulate/types.ts#L28-L31

func NewSimulateIngest ¶ added in v8.5.0 

func NewSimulateIngest() *SimulateIngest

NewSimulateIngest returns a SimulateIngest.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L93-L97

func NewSimulatedActions ¶ added in v8.5.0 

func NewSimulatedActions() *SimulatedActions

NewSimulatedActions returns a SimulatedActions.

type SizeField ¶ 

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

SizeField type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L54-L56

func NewSizeField ¶ added in v8.5.0 

func NewSizeField() *SizeField

NewSizeField returns a SizeField.

type SlackAction ¶ 

type SlackAction struct {
	Account *string      `json:"account,omitempty"`
	Message SlackMessage `json:"message"`
}

SlackAction type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L91-L94

func NewSlackAction ¶ added in v8.5.0 

func NewSlackAction() *SlackAction

NewSlackAction returns a SlackAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L101-L117

func NewSlackAttachment ¶ added in v8.5.0 

func NewSlackAttachment() *SlackAttachment

NewSlackAttachment returns a SlackAttachment.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L119-L123

func NewSlackAttachmentField ¶ added in v8.5.0 

func NewSlackAttachmentField() *SlackAttachmentField

NewSlackAttachmentField returns a SlackAttachmentField.

type SlackDynamicAttachment ¶ 

type SlackDynamicAttachment struct {
	AttachmentTemplate SlackAttachment `json:"attachment_template"`
	ListPath           string          `json:"list_path"`
}

SlackDynamicAttachment type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L125-L128

func NewSlackDynamicAttachment ¶ added in v8.5.0 

func NewSlackDynamicAttachment() *SlackDynamicAttachment

NewSlackDynamicAttachment returns a SlackDynamicAttachment.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L130-L137

func NewSlackMessage ¶ added in v8.5.0 

func NewSlackMessage() *SlackMessage

NewSlackMessage returns a SlackMessage.

type SlackResult ¶ 

type SlackResult struct {
	Account *string      `json:"account,omitempty"`
	Message SlackMessage `json:"message"`
}

SlackResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L96-L99

func NewSlackResult ¶ added in v8.5.0 

func NewSlackResult() *SlackResult

NewSlackResult returns a SlackResult.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/SlicedScroll.ts#L23-L27

func NewSlicedScroll ¶ added in v8.5.0 

func NewSlicedScroll() *SlicedScroll

NewSlicedScroll returns a SlicedScroll.

type Slices ¶ 

type Slices interface{}

Slices holds the union for the following types: 

int
slicescalculation.SlicesCalculation

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L326-L331

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L431-L434

func NewSlm ¶ added in v8.5.0 

func NewSlm() *Slm

NewSlm returns a Slm.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L472-L477

func NewSlowlogSettings ¶ added in v8.5.0 

func NewSlowlogSettings() *SlowlogSettings

NewSlowlogSettings returns a SlowlogSettings.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L490-L495

func NewSlowlogTresholdLevels ¶ added in v8.5.0 

func NewSlowlogTresholdLevels() *SlowlogTresholdLevels

NewSlowlogTresholdLevels returns a SlowlogTresholdLevels.

type SlowlogTresholds ¶ 

type SlowlogTresholds struct {
	Fetch *SlowlogTresholdLevels `json:"fetch,omitempty"`
	// 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"`
	Query *SlowlogTresholdLevels `json:"query,omitempty"`
}

SlowlogTresholds type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L479-L488

func NewSlowlogTresholds ¶ added in v8.5.0 

func NewSlowlogTresholds() *SlowlogTresholds

NewSlowlogTresholds returns a SlowlogTresholds.

type SmoothingModelContainer ¶ 

type SmoothingModelContainer struct {
	Laplace             *LaplaceSmoothingModel             `json:"laplace,omitempty"`
	LinearInterpolation *LinearInterpolationSmoothingModel `json:"linear_interpolation,omitempty"`
	StupidBackoff       *StupidBackoffSmoothingModel       `json:"stupid_backoff,omitempty"`
}

SmoothingModelContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L224-L231

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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           map[string]interface{}  `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotInfo.ts#L41-L65

func NewSnapshotInfo ¶ added in v8.5.0 

func NewSnapshotInfo() *SnapshotInfo

NewSnapshotInfo returns a SnapshotInfo.

type SnapshotLifecycle ¶ 

type SnapshotLifecycle struct {
	InProgress          *InProgress `json:"in_progress,omitempty"`
	LastFailure         *Invocation `json:"last_failure,omitempty"`
	LastSuccess         *Invocation `json:"last_success,omitempty"`
	ModifiedDate        *DateTime   `json:"modified_date,omitempty"`
	ModifiedDateMillis  int64       `json:"modified_date_millis"`
	NextExecution       *DateTime   `json:"next_execution,omitempty"`
	NextExecutionMillis int64       `json:"next_execution_millis"`
	Policy              SLMPolicy   `json:"policy"`
	Stats               Statistics  `json:"stats"`
	Version             int64       `json:"version"`
}

SnapshotLifecycle type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L38-L49

func NewSnapshotLifecycle ¶ added in v8.5.0 

func NewSnapshotLifecycle() *SnapshotLifecycle

NewSnapshotLifecycle returns a SnapshotLifecycle.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/get/SnapshotGetResponse.ts#L42-L46

func NewSnapshotResponseItem ¶ added in v8.5.0 

func NewSnapshotResponseItem() *SnapshotResponseItem

NewSnapshotResponseItem returns a SnapshotResponseItem.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/restore/SnapshotRestoreResponse.ts#L27-L31

func NewSnapshotRestore ¶ added in v8.5.0 

func NewSnapshotRestore() *SnapshotRestore

NewSnapshotRestore returns a SnapshotRestore.

type SnapshotShardFailure ¶ 

type SnapshotShardFailure struct {
	Index   string `json:"index"`
	NodeId  string `json:"node_id"`
	Reason  string `json:"reason"`
	ShardId string `json:"shard_id"`
	Status  string `json:"status"`
}

SnapshotShardFailure type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotShardFailure.ts#L22-L28

func NewSnapshotShardFailure ¶ added in v8.5.0 

func NewSnapshotShardFailure() *SnapshotShardFailure

NewSnapshotShardFailure returns a SnapshotShardFailure.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotShardsStats.ts#L22-L29

func NewSnapshotShardsStats ¶ added in v8.5.0 

func NewSnapshotShardsStats() *SnapshotShardsStats

NewSnapshotShardsStats returns a SnapshotShardsStats.

type SnapshotShardsStatus ¶ 

type SnapshotShardsStatus struct {
	Stage shardsstatsstage.ShardsStatsStage `json:"stage"`
	Stats ShardsStatsSummary                `json:"stats"`
}

SnapshotShardsStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotStats.ts#L23-L29

func NewSnapshotStats ¶ added in v8.5.0 

func NewSnapshotStats() *SnapshotStats

NewSnapshotStats returns a SnapshotStats.

type SnapshotsRecord ¶ 

type SnapshotsRecord struct {
	// Duration duration
	Duration *Duration `json:"duration,omitempty"`
	// EndEpoch end time in seconds since 1970-01-01 00:00:00
	EndEpoch *StringifiedEpochTimeUnitSeconds `json:"end_epoch,omitempty"`
	// EndTime end time in HH:MM:SS
	EndTime *string `json:"end_time,omitempty"`
	// FailedShards number of failed shards
	FailedShards *string `json:"failed_shards,omitempty"`
	// Id unique snapshot
	Id *string `json:"id,omitempty"`
	// Indices number of indices
	Indices *string `json:"indices,omitempty"`
	// Reason reason for failures
	Reason *string `json:"reason,omitempty"`
	// Repository repository name
	Repository *string `json:"repository,omitempty"`
	// StartEpoch start time in seconds since 1970-01-01 00:00:00
	StartEpoch *StringifiedEpochTimeUnitSeconds `json:"start_epoch,omitempty"`
	// StartTime start time in HH:MM:SS
	StartTime *ScheduleTimeOfDay `json:"start_time,omitempty"`
	// Status snapshot name
	Status *string `json:"status,omitempty"`
	// SuccessfulShards number of successful shards
	SuccessfulShards *string `json:"successful_shards,omitempty"`
	// TotalShards number of total shards
	TotalShards *string `json:"total_shards,omitempty"`
}

SnapshotsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/snapshots/types.ts#L24-L90

func NewSnapshotsRecord ¶ added in v8.5.0 

func NewSnapshotsRecord() *SnapshotsRecord

NewSnapshotsRecord returns a SnapshotsRecord.

type SnowballAnalyzer ¶ 

type SnowballAnalyzer struct {
	Language  snowballlanguage.SnowballLanguage `json:"language"`
	Stopwords []string                          `json:"stopwords,omitempty"`
	Type      string                            `json:"type,omitempty"`
	Version   *string                           `json:"version,omitempty"`
}

SnowballAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L88-L93

func NewSnowballAnalyzer ¶ added in v8.5.0 

func NewSnowballAnalyzer() *SnowballAnalyzer

NewSnowballAnalyzer returns a SnowballAnalyzer.

type SnowballTokenFilter ¶ 

type SnowballTokenFilter struct {
	Language snowballlanguage.SnowballLanguage `json:"language"`
	Type     string                            `json:"type,omitempty"`
	Version  *string                           `json:"version,omitempty"`
}

SnowballTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L308-L311

func NewSnowballTokenFilter ¶ added in v8.5.0 

func NewSnowballTokenFilter() *SnowballTokenFilter

NewSnowballTokenFilter returns a SnowballTokenFilter.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L50-L63

func NewSoftDeletes ¶ added in v8.5.0 

func NewSoftDeletes() *SoftDeletes

NewSoftDeletes returns a SoftDeletes.

type Sort ¶ 

type Sort []SortCombinations

Sort type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L99-L99

type SortCombinations ¶ 

type SortCombinations interface{}

SortCombinations holds the union for the following types: 

string
SortOptions

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L93-L97

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L82-L91

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   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Order         *sortorder.SortOrder `json:"order,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

SortProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L348-L352

func NewSortProcessor ¶ added in v8.5.0 

func NewSortProcessor() *SortProcessor

NewSortProcessor returns a SortProcessor.

type SortResults ¶ 

type SortResults []FieldValue

SortResults type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/sort.ts#L101-L101

type SourceConfig ¶ 

type SourceConfig interface{}

SourceConfig holds the union for the following types: 

bool
SourceFilter

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/SourceFilter.ts#L33-L37

type SourceConfigParam ¶ 

type SourceConfigParam interface{}

SourceConfigParam holds the union for the following types: 

bool
[]string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/meta-fields.ts#L58-L65

func NewSourceField ¶ added in v8.5.0 

func NewSourceField() *SourceField

NewSourceField returns a SourceField.

type SourceFilter ¶ 

type SourceFilter struct {
	Excludes []string `json:"excludes,omitempty"`
	Includes []string `json:"includes,omitempty"`
}

SourceFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/SourceFilter.ts#L23-L31

func NewSourceFilter ¶ added in v8.5.0 

func NewSourceFilter() *SourceFilter

NewSourceFilter returns a SourceFilter.

type SpanContainingQuery ¶ 

type SpanContainingQuery struct {
	Big        *SpanQuery `json:"big,omitempty"`
	Boost      *float32   `json:"boost,omitempty"`
	Little     *SpanQuery `json:"little,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanContainingQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L25-L28

func NewSpanContainingQuery ¶ added in v8.5.0 

func NewSpanContainingQuery() *SpanContainingQuery

NewSpanContainingQuery returns a SpanContainingQuery.

type SpanFieldMaskingQuery ¶ 

type SpanFieldMaskingQuery struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L30-L33

func NewSpanFieldMaskingQuery ¶ added in v8.5.0 

func NewSpanFieldMaskingQuery() *SpanFieldMaskingQuery

NewSpanFieldMaskingQuery returns a SpanFieldMaskingQuery.

type SpanFirstQuery ¶ 

type SpanFirstQuery struct {
	Boost      *float32   `json:"boost,omitempty"`
	End        int        `json:"end"`
	Match      *SpanQuery `json:"match,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanFirstQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L35-L38

func NewSpanFirstQuery ¶ added in v8.5.0 

func NewSpanFirstQuery() *SpanFirstQuery

NewSpanFirstQuery returns a SpanFirstQuery.

type SpanGapQuery ¶ 

type SpanGapQuery map[string]int

SpanGapQuery type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L40-L42

type SpanMultiTermQuery ¶ 

type SpanMultiTermQuery struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L44-L47

func NewSpanMultiTermQuery ¶ added in v8.5.0 

func NewSpanMultiTermQuery() *SpanMultiTermQuery

NewSpanMultiTermQuery returns a SpanMultiTermQuery.

type SpanNearQuery ¶ 

type SpanNearQuery struct {
	Boost      *float32    `json:"boost,omitempty"`
	Clauses    []SpanQuery `json:"clauses"`
	InOrder    *bool       `json:"in_order,omitempty"`
	QueryName_ *string     `json:"_name,omitempty"`
	Slop       *int        `json:"slop,omitempty"`
}

SpanNearQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L49-L53

func NewSpanNearQuery ¶ added in v8.5.0 

func NewSpanNearQuery() *SpanNearQuery

NewSpanNearQuery returns a SpanNearQuery.

type SpanNotQuery ¶ 

type SpanNotQuery struct {
	Boost      *float32   `json:"boost,omitempty"`
	Dist       *int       `json:"dist,omitempty"`
	Exclude    *SpanQuery `json:"exclude,omitempty"`
	Include    *SpanQuery `json:"include,omitempty"`
	Post       *int       `json:"post,omitempty"`
	Pre        *int       `json:"pre,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanNotQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L55-L63

func NewSpanNotQuery ¶ added in v8.5.0 

func NewSpanNotQuery() *SpanNotQuery

NewSpanNotQuery returns a SpanNotQuery.

type SpanOrQuery ¶ 

type SpanOrQuery struct {
	Boost      *float32    `json:"boost,omitempty"`
	Clauses    []SpanQuery `json:"clauses"`
	QueryName_ *string     `json:"_name,omitempty"`
}

SpanOrQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L65-L67

func NewSpanOrQuery ¶ added in v8.5.0 

func NewSpanOrQuery() *SpanOrQuery

NewSpanOrQuery returns a SpanOrQuery.

type SpanQuery ¶ 

type SpanQuery struct {
	FieldMaskingSpan *SpanFieldMaskingQuery   `json:"field_masking_span,omitempty"`
	SpanContaining   *SpanContainingQuery     `json:"span_containing,omitempty"`
	SpanFirst        *SpanFirstQuery          `json:"span_first,omitempty"`
	SpanGap          map[string]int           `json:"span_gap,omitempty"`
	SpanMulti        *SpanMultiTermQuery      `json:"span_multi,omitempty"`
	SpanNear         *SpanNearQuery           `json:"span_near,omitempty"`
	SpanNot          *SpanNotQuery            `json:"span_not,omitempty"`
	SpanOr           *SpanOrQuery             `json:"span_or,omitempty"`
	SpanTerm         map[string]SpanTermQuery `json:"span_term,omitempty"`
	SpanWithin       *SpanWithinQuery         `json:"span_within,omitempty"`
}

SpanQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L79-L91

func NewSpanQuery ¶ added in v8.5.0 

func NewSpanQuery() *SpanQuery

NewSpanQuery returns a SpanQuery.

type SpanTermQuery ¶ 

type SpanTermQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Value      string   `json:"value"`
}

SpanTermQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L69-L72

func NewSpanTermQuery ¶ added in v8.5.0 

func NewSpanTermQuery() *SpanTermQuery

NewSpanTermQuery returns a SpanTermQuery.

type SpanWithinQuery ¶ 

type SpanWithinQuery struct {
	Big        *SpanQuery `json:"big,omitempty"`
	Boost      *float32   `json:"boost,omitempty"`
	Little     *SpanQuery `json:"little,omitempty"`
	QueryName_ *string    `json:"_name,omitempty"`
}

SpanWithinQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/span.ts#L74-L77

func NewSpanWithinQuery ¶ added in v8.5.0 

func NewSpanWithinQuery() *SpanWithinQuery

NewSpanWithinQuery returns a SpanWithinQuery.

type SplitProcessor ¶ 

type SplitProcessor struct {
	Description      *string              `json:"description,omitempty"`
	Field            string               `json:"field"`
	If               *string              `json:"if,omitempty"`
	IgnoreFailure    *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing    *bool                `json:"ignore_missing,omitempty"`
	OnFailure        []ProcessorContainer `json:"on_failure,omitempty"`
	PreserveTrailing *bool                `json:"preserve_trailing,omitempty"`
	Separator        string               `json:"separator"`
	Tag              *string              `json:"tag,omitempty"`
	TargetField      *string              `json:"target_field,omitempty"`
}

SplitProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L354-L360

func NewSplitProcessor ¶ added in v8.5.0 

func NewSplitProcessor() *SplitProcessor

NewSplitProcessor returns a SplitProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L368-L371

func NewSql ¶ added in v8.5.0 

func NewSql() *Sql

NewSql returns a Sql.

type Ssl ¶ 

type Ssl struct {
	Http      FeatureToggle `json:"http"`
	Transport FeatureToggle `json:"transport"`
}

Ssl type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L373-L376

func NewSsl ¶ added in v8.5.0 

func NewSsl() *Ssl

NewSsl returns a Ssl.

type StandardAnalyzer ¶ 

type StandardAnalyzer struct {
	MaxTokenLength *int     `json:"max_token_length,omitempty"`
	Stopwords      []string `json:"stopwords,omitempty"`
	Type           string   `json:"type,omitempty"`
}

StandardAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L95-L99

func NewStandardAnalyzer ¶ added in v8.5.0 

func NewStandardAnalyzer() *StandardAnalyzer

NewStandardAnalyzer returns a StandardAnalyzer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L259-L266

func NewStandardDeviationBounds ¶ added in v8.5.0 

func NewStandardDeviationBounds() *StandardDeviationBounds

NewStandardDeviationBounds returns a StandardDeviationBounds.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L268-L275

func NewStandardDeviationBoundsAsString ¶ added in v8.5.0 

func NewStandardDeviationBoundsAsString() *StandardDeviationBoundsAsString

NewStandardDeviationBoundsAsString returns a StandardDeviationBoundsAsString.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L104-L107

func NewStandardTokenizer ¶ added in v8.5.0 

func NewStandardTokenizer() *StandardTokenizer

NewStandardTokenizer returns a StandardTokenizer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/slm/_types/SnapshotLifecycle.ts#L51-L74

func NewStatistics ¶ added in v8.5.0 

func NewStatistics() *Statistics

NewStatistics returns a Statistics.

type Stats ¶ 

type Stats struct {
	AdaptiveSelection map[string]AdaptiveSelection `json:"adaptive_selection,omitempty"`
	Attributes        map[string]string            `json:"attributes,omitempty"`
	Breakers          map[string]Breaker           `json:"breakers,omitempty"`
	Discovery         *Discovery                   `json:"discovery,omitempty"`
	Fs                *FileSystem                  `json:"fs,omitempty"`
	Host              *string                      `json:"host,omitempty"`
	Http              *Http                        `json:"http,omitempty"`
	IndexingPressure  *NodesIndexingPressure       `json:"indexing_pressure,omitempty"`
	Indices           *IndicesShardStats           `json:"indices,omitempty"`
	Ingest            *NodesIngest                 `json:"ingest,omitempty"`
	Ip                []string                     `json:"ip,omitempty"`
	Jvm               *Jvm                         `json:"jvm,omitempty"`
	Name              *string                      `json:"name,omitempty"`
	Os                *OperatingSystem             `json:"os,omitempty"`
	Process           *Process                     `json:"process,omitempty"`
	Roles             []noderole.NodeRole          `json:"roles,omitempty"`
	Script            *Scripting                   `json:"script,omitempty"`
	ScriptCache       map[string][]ScriptCache     `json:"script_cache,omitempty"`
	ThreadPool        map[string]ThreadCount       `json:"thread_pool,omitempty"`
	Timestamp         *int64                       `json:"timestamp,omitempty"`
	Transport         *Transport                   `json:"transport,omitempty"`
	TransportAddress  *string                      `json:"transport_address,omitempty"`
}

Stats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L30-L53

func NewStats ¶ added in v8.5.0 

func NewStats() *Stats

NewStats returns a Stats.

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        map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L239-L254

func NewStatsAggregate ¶ added in v8.5.0 

func NewStatsAggregate() *StatsAggregate

NewStatsAggregate returns a StatsAggregate.

type StatsAggregation ¶ 

type StatsAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

StatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L145-L145

func NewStatsAggregation ¶ added in v8.5.0 

func NewStatsAggregation() *StatsAggregation

NewStatsAggregation returns a StatsAggregation.

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        map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L256-L257

func NewStatsBucketAggregate ¶ added in v8.5.0 

func NewStatsBucketAggregate() *StatsBucketAggregate

NewStatsBucketAggregate returns a StatsBucketAggregate.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

StatsBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L284-L284

func NewStatsBucketAggregation ¶ added in v8.5.0 

func NewStatsBucketAggregation() *StatsBucketAggregation

NewStatsBucketAggregation returns a StatsBucketAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/snapshot/_types/SnapshotStatus.ts#L26-L35

func NewStatus ¶ added in v8.5.0 

func NewStatus() *Status

NewStatus returns a Status.

type StemmerOverrideTokenFilter ¶ 

type StemmerOverrideTokenFilter struct {
	Rules     []string `json:"rules,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L313-L317

func NewStemmerOverrideTokenFilter ¶ added in v8.5.0 

func NewStemmerOverrideTokenFilter() *StemmerOverrideTokenFilter

NewStemmerOverrideTokenFilter returns a StemmerOverrideTokenFilter.

type StemmerTokenFilter ¶ 

type StemmerTokenFilter struct {
	Language string  `json:"language"`
	Type     string  `json:"type,omitempty"`
	Version  *string `json:"version,omitempty"`
}

StemmerTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L319-L322

func NewStemmerTokenFilter ¶ added in v8.5.0 

func NewStemmerTokenFilter() *StemmerTokenFilter

NewStemmerTokenFilter returns a StemmerTokenFilter.

type StepKey ¶ 

type StepKey struct {
	Action string `json:"action"`
	Name   string `json:"name"`
	Phase  string `json:"phase"`
}

StepKey type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/move_to_step/types.ts#L20-L24

func NewStepKey ¶ added in v8.5.0 

func NewStepKey() *StepKey

NewStepKey returns a StepKey.

type StopAnalyzer ¶ 

type StopAnalyzer struct {
	Stopwords     []string `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L101-L106

func NewStopAnalyzer ¶ added in v8.5.0 

func NewStopAnalyzer() *StopAnalyzer

NewStopAnalyzer returns a StopAnalyzer.

type StopTokenFilter ¶ 

type StopTokenFilter struct {
	IgnoreCase     *bool    `json:"ignore_case,omitempty"`
	RemoveTrailing *bool    `json:"remove_trailing,omitempty"`
	Stopwords      []string `json:"stopwords,omitempty"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L96-L102

func NewStopTokenFilter ¶ added in v8.5.0 

func NewStopTokenFilter() *StopTokenFilter

NewStopTokenFilter returns a StopTokenFilter.

type StopWords ¶ 

type StopWords []string

StopWords type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/StopWords.ts#L20-L26

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L497-L506

func NewStorage ¶ added in v8.5.0 

func NewStorage() *Storage

NewStorage returns a Storage.

type StoreStats ¶ 

type StoreStats struct {
	Reserved                *ByteSize `json:"reserved,omitempty"`
	ReservedInBytes         int       `json:"reserved_in_bytes"`
	Size                    *ByteSize `json:"size,omitempty"`
	SizeInBytes             int       `json:"size_in_bytes"`
	TotalDataSetSize        *ByteSize `json:"total_data_set_size,omitempty"`
	TotalDataSetSizeInBytes *int      `json:"total_data_set_size_in_bytes,omitempty"`
}

StoreStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L233-L240

func NewStoreStats ¶ added in v8.5.0 

func NewStoreStats() *StoreStats

NewStoreStats returns a StoreStats.

type StoredScript ¶ 

type StoredScript struct {
	Lang    scriptlanguage.ScriptLanguage `json:"lang"`
	Options map[string]string             `json:"options,omitempty"`
	Source  string                        `json:"source"`
}

StoredScript type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Scripting.ts#L35-L39

func NewStoredScript ¶ added in v8.5.0 

func NewStoredScript() *StoredScript

NewStoredScript returns a StoredScript.

type StoredScriptId ¶ 

type StoredScriptId struct {
	Id     string                 `json:"id"`
	Params map[string]interface{} `json:"params,omitempty"`
}

StoredScriptId type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Scripting.ts#L52-L54

func NewStoredScriptId ¶ added in v8.5.0 

func NewStoredScriptId() *StoredScriptId

NewStoredScriptId returns a StoredScriptId.

type StringRareTermsAggregate ¶ 

type StringRareTermsAggregate struct {
	Buckets BucketsStringRareTermsBucket `json:"buckets"`
	Meta    map[string]interface{}       `json:"meta,omitempty"`
}

StringRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L442-L446

func NewStringRareTermsAggregate ¶ added in v8.5.0 

func NewStringRareTermsAggregate() *StringRareTermsAggregate

NewStringRareTermsAggregate returns a StringRareTermsAggregate.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L448-L450

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

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              map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L684-L695

func NewStringStatsAggregate ¶ added in v8.5.0 

func NewStringStatsAggregate() *StringStatsAggregate

NewStringStatsAggregate returns a StringStatsAggregate.

type StringStatsAggregation ¶ 

type StringStatsAggregation struct {
	Field            *string  `json:"field,omitempty"`
	Missing          *Missing `json:"missing,omitempty"`
	Script           *Script  `json:"script,omitempty"`
	ShowDistribution *bool    `json:"show_distribution,omitempty"`
}

StringStatsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L147-L149

func NewStringStatsAggregation ¶ added in v8.5.0 

func NewStringStatsAggregation() *StringStatsAggregation

NewStringStatsAggregation returns a StringStatsAggregation.

type StringTermsAggregate ¶ 

type StringTermsAggregate struct {
	Buckets                 BucketsStringTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}   `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

StringTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L383-L388

func NewStringTermsAggregate ¶ added in v8.5.0 

func NewStringTermsAggregate() *StringTermsAggregate

NewStringTermsAggregate returns a StringTermsAggregate.

type StringTermsBucket ¶ 

type StringTermsBucket struct {
	Aggregations  map[string]Aggregate `json:"-"`
	DocCount      int64                `json:"doc_count"`
	DocCountError *int64               `json:"doc_count_error,omitempty"`
	Key           FieldValue           `json:"key"`
}

StringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L394-L396

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

type StringifiedEpochTimeUnitMillis ¶ 

type StringifiedEpochTimeUnitMillis interface{}

StringifiedEpochTimeUnitMillis holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_spec_utils/Stringified.ts#L20-L27

type StringifiedEpochTimeUnitSeconds ¶ 

type StringifiedEpochTimeUnitSeconds interface{}

StringifiedEpochTimeUnitSeconds holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_spec_utils/Stringified.ts#L20-L27

type StringifiedVersionNumber ¶ added in v8.5.0 

type StringifiedVersionNumber interface{}

StringifiedVersionNumber holds the union for the following types: 

int64
string

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_spec_utils/Stringified.ts#L20-L27

type StupidBackoffSmoothingModel ¶ 

type StupidBackoffSmoothingModel struct {
	Discount float64 `json:"discount"`
}

StupidBackoffSmoothingModel type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L233-L235

func NewStupidBackoffSmoothingModel ¶ added in v8.5.0 

func NewStupidBackoffSmoothingModel() *StupidBackoffSmoothingModel

NewStupidBackoffSmoothingModel returns a StupidBackoffSmoothingModel.

type Suggest ¶ 

type Suggest interface {
	// contains filtered or unexported methods
}

Suggest holds the union for the following types: 

CompletionSuggest
PhraseSuggest
TermSuggest

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L37-L42

func NewSuggestContext ¶ added in v8.5.0 

func NewSuggestContext() *SuggestContext

NewSuggestContext returns a SuggestContext.

type SuggestFuzziness ¶ 

type SuggestFuzziness struct {
	Fuzziness      *Fuzziness `json:"fuzziness,omitempty"`
	MinLength      *int       `json:"min_length,omitempty"`
	PrefixLength   *int       `json:"prefix_length,omitempty"`
	Transpositions *bool      `json:"transpositions,omitempty"`
	UnicodeAware   *bool      `json:"unicode_aware,omitempty"`
}

SuggestFuzziness type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L138-L144

func NewSuggestFuzziness ¶ added in v8.5.0 

func NewSuggestFuzziness() *SuggestFuzziness

NewSuggestFuzziness returns a SuggestFuzziness.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L101-L104

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

type SumAggregate ¶ 

type SumAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L202-L206

func NewSumAggregate ¶ added in v8.5.0 

func NewSumAggregate() *SumAggregate

NewSumAggregate returns a SumAggregate.

type SumAggregation ¶ 

type SumAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

SumAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L151-L151

func NewSumAggregation ¶ added in v8.5.0 

func NewSumAggregation() *SumAggregation

NewSumAggregation returns a SumAggregation.

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      *string                `json:"format,omitempty"`
	GapPolicy   *gappolicy.GapPolicy   `json:"gap_policy,omitempty"`
	Meta        map[string]interface{} `json:"meta,omitempty"`
	Name        *string                `json:"name,omitempty"`
}

SumBucketAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/pipeline.ts#L286-L286

func NewSumBucketAggregation ¶ added in v8.5.0 

func NewSumBucketAggregation() *SumBucketAggregation

NewSumBucketAggregation returns a SumBucketAggregation.

type Summary ¶ 

type Summary struct {
	Config map[policytype.PolicyType]EnrichPolicy `json:"config"`
}

Summary type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/enrich/_types/Policy.ts#L23-L25

func NewSummary ¶ added in v8.5.0 

func NewSummary() *Summary

NewSummary returns a Summary.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L167-L173

func NewSyncContainer ¶ added in v8.5.0 

func NewSyncContainer() *SyncContainer

NewSyncContainer returns a SyncContainer.

type SynonymGraphTokenFilter ¶ 

type SynonymGraphTokenFilter struct {
	Expand       *bool                        `json:"expand,omitempty"`
	Format       *synonymformat.SynonymFormat `json:"format,omitempty"`
	Lenient      *bool                        `json:"lenient,omitempty"`
	Synonyms     []string                     `json:"synonyms,omitempty"`
	SynonymsPath *string                      `json:"synonyms_path,omitempty"`
	Tokenizer    *string                      `json:"tokenizer,omitempty"`
	Type         string                       `json:"type,omitempty"`
	Updateable   *bool                        `json:"updateable,omitempty"`
	Version      *string                      `json:"version,omitempty"`
}

SynonymGraphTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L109-L118

func NewSynonymGraphTokenFilter ¶ added in v8.5.0 

func NewSynonymGraphTokenFilter() *SynonymGraphTokenFilter

NewSynonymGraphTokenFilter returns a SynonymGraphTokenFilter.

type SynonymTokenFilter ¶ 

type SynonymTokenFilter struct {
	Expand       *bool                        `json:"expand,omitempty"`
	Format       *synonymformat.SynonymFormat `json:"format,omitempty"`
	Lenient      *bool                        `json:"lenient,omitempty"`
	Synonyms     []string                     `json:"synonyms,omitempty"`
	SynonymsPath *string                      `json:"synonyms_path,omitempty"`
	Tokenizer    *string                      `json:"tokenizer,omitempty"`
	Type         string                       `json:"type,omitempty"`
	Updateable   *bool                        `json:"updateable,omitempty"`
	Version      *string                      `json:"version,omitempty"`
}

SynonymTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L120-L129

func NewSynonymTokenFilter ¶ added in v8.5.0 

func NewSynonymTokenFilter() *SynonymTokenFilter

NewSynonymTokenFilter returns a SynonymTokenFilter.

type TDigest ¶ 

type TDigest struct {
	Compression *int `json:"compression,omitempty"`
}

TDigest type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L123-L125

func NewTDigest ¶ added in v8.5.0 

func NewTDigest() *TDigest

NewTDigest returns a TDigest.

type TDigestPercentileRanksAggregate ¶ 

type TDigestPercentileRanksAggregate struct {
	Meta   map[string]interface{} `json:"meta,omitempty"`
	Values Percentiles            `json:"values"`
}

TDigestPercentileRanksAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L174-L175

func NewTDigestPercentileRanksAggregate ¶ added in v8.5.0 

func NewTDigestPercentileRanksAggregate() *TDigestPercentileRanksAggregate

NewTDigestPercentileRanksAggregate returns a TDigestPercentileRanksAggregate.

type TDigestPercentilesAggregate ¶ 

type TDigestPercentilesAggregate struct {
	Meta   map[string]interface{} `json:"meta,omitempty"`
	Values Percentiles            `json:"values"`
}

TDigestPercentilesAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L171-L172

func NewTDigestPercentilesAggregate ¶ added in v8.5.0 

func NewTDigestPercentilesAggregate() *TDigestPercentilesAggregate

NewTDigestPercentilesAggregate returns a TDigestPercentilesAggregate.

type TTestAggregate ¶ 

type TTestAggregate struct {
	Meta          map[string]interface{} `json:"meta,omitempty"`
	Value         float64                `json:"value,omitempty"`
	ValueAsString *string                `json:"value_as_string,omitempty"`
}

TTestAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L726-L730

func NewTTestAggregate ¶ added in v8.5.0 

func NewTTestAggregate() *TTestAggregate

NewTTestAggregate returns a TTestAggregate.

type TTestAggregation ¶ 

type TTestAggregation struct {
	A    *TestPopulation        `json:"a,omitempty"`
	B    *TestPopulation        `json:"b,omitempty"`
	Meta map[string]interface{} `json:"meta,omitempty"`
	Name *string                `json:"name,omitempty"`
	Type *ttesttype.TTestType   `json:"type,omitempty"`
}

TTestAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L153-L157

func NewTTestAggregation ¶ added in v8.5.0 

func NewTTestAggregation() *TTestAggregation

NewTTestAggregation returns a TTestAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L49-L54

func NewTargetMeanEncodingPreprocessor ¶ added in v8.5.0 

func NewTargetMeanEncodingPreprocessor() *TargetMeanEncodingPreprocessor

NewTargetMeanEncodingPreprocessor returns a TargetMeanEncodingPreprocessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Errors.ts#L66-L71

func NewTaskFailure ¶ added in v8.5.0 

func NewTaskFailure() *TaskFailure

NewTaskFailure returns a TaskFailure.

type TaskId ¶ 

type TaskId interface{}

TaskId holds the union for the following types: 

string
int

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L113-L113

type TaskInfo ¶ 

type TaskInfo struct {
	Action             string            `json:"action"`
	Cancellable        bool              `json:"cancellable"`
	Cancelled          *bool             `json:"cancelled,omitempty"`
	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             *TaskStatus       `json:"status,omitempty"`
	Type               string            `json:"type"`
}

TaskInfo type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/tasks/_types/TaskInfo.ts#L32-L46

func NewTaskInfo ¶ added in v8.5.0 

func NewTaskInfo() *TaskInfo

NewTaskInfo returns a TaskInfo.

type TaskInfos ¶ 

type TaskInfos interface{}

TaskInfos holds the union for the following types: 

[]TaskInfo
map[string]ParentTaskInfo

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/tasks/_types/TaskListResponseBase.ts#L40-L43

type TaskStatus ¶ 

type TaskStatus struct {
	Batches              int64     `json:"batches"`
	Canceled             *string   `json:"canceled,omitempty"`
	Created              int64     `json:"created"`
	Deleted              int64     `json:"deleted"`
	Failures             []string  `json:"failures,omitempty"`
	Noops                int64     `json:"noops"`
	RequestsPerSecond    float32   `json:"requests_per_second"`
	Retries              Retries   `json:"retries"`
	Throttled            *Duration `json:"throttled,omitempty"`
	ThrottledMillis      int64     `json:"throttled_millis"`
	ThrottledUntil       *Duration `json:"throttled_until,omitempty"`
	ThrottledUntilMillis int64     `json:"throttled_until_millis"`
	TimedOut             *bool     `json:"timed_out,omitempty"`
	Took                 *int64    `json:"took,omitempty"`
	Total                int64     `json:"total"`
	Updated              int64     `json:"updated"`
	VersionConflicts     int64     `json:"version_conflicts"`
}

TaskStatus type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/tasks/_types/TaskStatus.ts#L24-L42

func NewTaskStatus ¶ added in v8.5.0 

func NewTaskStatus() *TaskStatus

NewTaskStatus returns a TaskStatus.

type TasksRecord ¶ 

type TasksRecord struct {
	// Action task action
	Action *string `json:"action,omitempty"`
	// Description task action
	Description *string `json:"description,omitempty"`
	// Id id of the task with the node
	Id *string `json:"id,omitempty"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// Node node name
	Node *string `json:"node,omitempty"`
	// NodeId unique node id
	NodeId *string `json:"node_id,omitempty"`
	// ParentTaskId parent task id
	ParentTaskId *string `json:"parent_task_id,omitempty"`
	// Port bound transport port
	Port *string `json:"port,omitempty"`
	// RunningTime running time
	RunningTime *string `json:"running_time,omitempty"`
	// RunningTimeNs running time ns
	RunningTimeNs *string `json:"running_time_ns,omitempty"`
	// StartTime start time in ms
	StartTime *string `json:"start_time,omitempty"`
	// TaskId unique task id
	TaskId *string `json:"task_id,omitempty"`
	// Timestamp start time in HH:MM:SS
	Timestamp *string `json:"timestamp,omitempty"`
	// Type task type
	Type *string `json:"type,omitempty"`
	// Version es version
	Version *string `json:"version,omitempty"`
	// XOpaqueId X-Opaque-ID header
	XOpaqueId *string `json:"x_opaque_id,omitempty"`
}

TasksRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/tasks/types.ts#L22-L101

func NewTasksRecord ¶ added in v8.5.0 

func NewTasksRecord() *TasksRecord

NewTasksRecord returns a TasksRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts#L33-L37

func NewTemplate ¶ added in v8.5.0 

func NewTemplate() *Template

NewTemplate returns a Template.

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]interface{} `json:"settings"`
	Version       *int64                 `json:"version,omitempty"`
}

TemplateMapping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/TemplateMapping.ts#L27-L34

func NewTemplateMapping ¶ added in v8.5.0 

func NewTemplateMapping() *TemplateMapping

NewTemplateMapping returns a TemplateMapping.

type TemplatesRecord ¶ 

type TemplatesRecord struct {
	// ComposedOf component templates comprising index template
	ComposedOf *string `json:"composed_of,omitempty"`
	// IndexPatterns template index patterns
	IndexPatterns *string `json:"index_patterns,omitempty"`
	// Name template name
	Name *string `json:"name,omitempty"`
	// Order template application order/priority number
	Order *string `json:"order,omitempty"`
	// Version version
	Version string `json:"version,omitempty"`
}

TemplatesRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/templates/types.ts#L22-L48

func NewTemplatesRecord ¶ added in v8.5.0 

func NewTemplatesRecord() *TemplatesRecord

NewTemplatesRecord returns a TemplatesRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/termvectors/types.ts#L34-L40

func NewTerm ¶ added in v8.5.0 

func NewTerm() *Term

NewTerm returns a Term.

type TermQuery ¶ 

type TermQuery struct {
	Boost           *float32   `json:"boost,omitempty"`
	CaseInsensitive *bool      `json:"case_insensitive,omitempty"`
	QueryName_      *string    `json:"_name,omitempty"`
	Value           FieldValue `json:"value"`
}

TermQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L116-L121

func NewTermQuery ¶ added in v8.5.0 

func NewTermQuery() *TermQuery

NewTermQuery returns a TermQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L64-L69

func NewTermSuggest ¶ added in v8.5.0 

func NewTermSuggest() *TermSuggest

NewTermSuggest returns a TermSuggest.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L93-L99

func NewTermSuggestOption ¶ added in v8.5.0 

func NewTermSuggestOption() *TermSuggestOption

NewTermSuggestOption returns a TermSuggestOption.

type TermSuggester ¶ 

type TermSuggester struct {
	Analyzer       *string                        `json:"analyzer,omitempty"`
	Field          string                         `json:"field"`
	LowercaseTerms *bool                          `json:"lowercase_terms,omitempty"`
	MaxEdits       *int                           `json:"max_edits,omitempty"`
	MaxInspections *int                           `json:"max_inspections,omitempty"`
	MaxTermFreq    *float32                       `json:"max_term_freq,omitempty"`
	MinDocFreq     *float32                       `json:"min_doc_freq,omitempty"`
	MinWordLength  *int                           `json:"min_word_length,omitempty"`
	PrefixLength   *int                           `json:"prefix_length,omitempty"`
	ShardSize      *int                           `json:"shard_size,omitempty"`
	Size           *int                           `json:"size,omitempty"`
	Sort           *suggestsort.SuggestSort       `json:"sort,omitempty"`
	StringDistance *stringdistance.StringDistance `json:"string_distance,omitempty"`
	SuggestMode    *suggestmode.SuggestMode       `json:"suggest_mode,omitempty"`
	Text           *string                        `json:"text,omitempty"`
}

TermSuggester type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/suggester.ts#L252-L265

func NewTermSuggester ¶ added in v8.5.0 

func NewTermSuggester() *TermSuggester

NewTermSuggester returns a TermSuggester.

type TermVector ¶ 

type TermVector struct {
	FieldStatistics FieldStatistics `json:"field_statistics"`
	Terms           map[string]Term `json:"terms"`
}

TermVector type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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    *int `json:"max_doc_freq,omitempty"`
	MaxNumTerms   *int `json:"max_num_terms,omitempty"`
	MaxTermFreq   *int `json:"max_term_freq,omitempty"`
	MaxWordLength *int `json:"max_word_length,omitempty"`
	MinDocFreq    *int `json:"min_doc_freq,omitempty"`
	MinTermFreq   *int `json:"min_term_freq,omitempty"`
	MinWordLength *int `json:"min_word_length,omitempty"`
}

TermVectorsFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/termvectors/types.ts#L49-L57

func NewTermVectorsFilter ¶ added in v8.5.0 

func NewTermVectorsFilter() *TermVectorsFilter

NewTermVectorsFilter returns a TermVectorsFilter.

type TermVectorsResult ¶ 

type TermVectorsResult struct {
	Error       *ErrorCause           `json:"error,omitempty"`
	Found       *bool                 `json:"found,omitempty"`
	Id_         string                `json:"_id"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/mtermvectors/types.ts#L51-L59

func NewTermVectorsResult ¶ added in v8.5.0 

func NewTermVectorsResult() *TermVectorsResult

NewTermVectorsResult returns a TermVectorsResult.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/termvectors/types.ts#L42-L47

func NewTermVectorsToken ¶ added in v8.5.0 

func NewTermVectorsToken() *TermVectorsToken

NewTermVectorsToken returns a TermVectorsToken.

type TermsAggregateBaseDoubleTermsBucket ¶ 

type TermsAggregateBaseDoubleTermsBucket struct {
	Buckets                 BucketsDoubleTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}   `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseDoubleTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L376-L381

func NewTermsAggregateBaseDoubleTermsBucket ¶ added in v8.5.0 

func NewTermsAggregateBaseDoubleTermsBucket() *TermsAggregateBaseDoubleTermsBucket

NewTermsAggregateBaseDoubleTermsBucket returns a TermsAggregateBaseDoubleTermsBucket.

type TermsAggregateBaseLongTermsBucket ¶ 

type TermsAggregateBaseLongTermsBucket struct {
	Buckets                 BucketsLongTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{} `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseLongTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L376-L381

func NewTermsAggregateBaseLongTermsBucket ¶ added in v8.5.0 

func NewTermsAggregateBaseLongTermsBucket() *TermsAggregateBaseLongTermsBucket

NewTermsAggregateBaseLongTermsBucket returns a TermsAggregateBaseLongTermsBucket.

type TermsAggregateBaseMultiTermsBucket ¶ 

type TermsAggregateBaseMultiTermsBucket struct {
	Buckets                 BucketsMultiTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                  `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}  `json:"meta,omitempty"`
	SumOtherDocCount        *int64                  `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseMultiTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L376-L381

func NewTermsAggregateBaseMultiTermsBucket ¶ added in v8.5.0 

func NewTermsAggregateBaseMultiTermsBucket() *TermsAggregateBaseMultiTermsBucket

NewTermsAggregateBaseMultiTermsBucket returns a TermsAggregateBaseMultiTermsBucket.

type TermsAggregateBaseStringTermsBucket ¶ 

type TermsAggregateBaseStringTermsBucket struct {
	Buckets                 BucketsStringTermsBucket `json:"buckets"`
	DocCountErrorUpperBound *int64                   `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{}   `json:"meta,omitempty"`
	SumOtherDocCount        *int64                   `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseStringTermsBucket type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L376-L381

func NewTermsAggregateBaseStringTermsBucket ¶ added in v8.5.0 

func NewTermsAggregateBaseStringTermsBucket() *TermsAggregateBaseStringTermsBucket

NewTermsAggregateBaseStringTermsBucket returns a TermsAggregateBaseStringTermsBucket.

type TermsAggregateBaseVoid ¶ 

type TermsAggregateBaseVoid struct {
	Buckets                 BucketsVoid            `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{} `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

TermsAggregateBaseVoid type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L376-L381

func NewTermsAggregateBaseVoid ¶ added in v8.5.0 

func NewTermsAggregateBaseVoid() *TermsAggregateBaseVoid

NewTermsAggregateBaseVoid returns a TermsAggregateBaseVoid.

type TermsAggregation ¶ 

type TermsAggregation struct {
	CollectMode           *termsaggregationcollectmode.TermsAggregationCollectMode     `json:"collect_mode,omitempty"`
	Exclude               []string                                                     `json:"exclude,omitempty"`
	ExecutionHint         *termsaggregationexecutionhint.TermsAggregationExecutionHint `json:"execution_hint,omitempty"`
	Field                 *string                                                      `json:"field,omitempty"`
	Format                *string                                                      `json:"format,omitempty"`
	Include               *TermsInclude                                                `json:"include,omitempty"`
	Meta                  map[string]interface{}                                       `json:"meta,omitempty"`
	MinDocCount           *int                                                         `json:"min_doc_count,omitempty"`
	Missing               *Missing                                                     `json:"missing,omitempty"`
	MissingBucket         *bool                                                        `json:"missing_bucket,omitempty"`
	MissingOrder          *missingorder.MissingOrder                                   `json:"missing_order,omitempty"`
	Name                  *string                                                      `json:"name,omitempty"`
	Order                 *AggregateOrder                                              `json:"order,omitempty"`
	Script                *Script                                                      `json:"script,omitempty"`
	ShardSize             *int                                                         `json:"shard_size,omitempty"`
	ShowTermDocCountError *bool                                                        `json:"show_term_doc_count_error,omitempty"`
	Size                  *int                                                         `json:"size,omitempty"`
	ValueType             *string                                                      `json:"value_type,omitempty"`
}

TermsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L380-L397

func NewTermsAggregation ¶ added in v8.5.0 

func NewTermsAggregation() *TermsAggregation

NewTermsAggregation returns a TermsAggregation.

type TermsExclude ¶ 

type TermsExclude []string

TermsExclude type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L422-L423

type TermsGrouping ¶ 

type TermsGrouping struct {
	Fields []string `json:"fields"`
}

TermsGrouping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/rollup/_types/Groupings.ts#L40-L42

func NewTermsGrouping ¶ added in v8.5.0 

func NewTermsGrouping() *TermsGrouping

NewTermsGrouping returns a TermsGrouping.

type TermsInclude ¶ 

type TermsInclude interface{}

TermsInclude holds the union for the following types: 

string
[]string
TermsPartition

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L419-L420

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L132-L137

func NewTermsLookup ¶ added in v8.5.0 

func NewTermsLookup() *TermsLookup

NewTermsLookup returns a TermsLookup.

type TermsPartition ¶ 

type TermsPartition struct {
	NumPartitions int64 `json:"num_partitions"`
	Partition     int64 `json:"partition"`
}

TermsPartition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L425-L428

func NewTermsPartition ¶ added in v8.5.0 

func NewTermsPartition() *TermsPartition

NewTermsPartition returns a TermsPartition.

type TermsQuery ¶ 

type TermsQuery struct {
	Boost      *float32                   `json:"boost,omitempty"`
	QueryName_ *string                    `json:"_name,omitempty"`
	TermsQuery map[string]TermsQueryField `json:"-"`
}

TermsQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L123-L125

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

type TermsQueryField ¶ 

type TermsQueryField interface{}

TermsQueryField holds the union for the following types: 

[]FieldValue
TermsLookup

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L127-L130

type TermsSetQuery ¶ 

type TermsSetQuery struct {
	Boost                    *float32 `json:"boost,omitempty"`
	MinimumShouldMatchField  *string  `json:"minimum_should_match_field,omitempty"`
	MinimumShouldMatchScript *Script  `json:"minimum_should_match_script,omitempty"`
	QueryName_               *string  `json:"_name,omitempty"`
	Terms                    []string `json:"terms"`
}

TermsSetQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L139-L143

func NewTermsSetQuery ¶ added in v8.5.0 

func NewTermsSetQuery() *TermsSetQuery

NewTermsSetQuery returns a TermsSetQuery.

type TestPopulation ¶ 

type TestPopulation struct {
	Field  string  `json:"field"`
	Filter *Query  `json:"filter,omitempty"`
	Script *Script `json:"script,omitempty"`
}

TestPopulation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L159-L163

func NewTestPopulation ¶ added in v8.5.0 

func NewTestPopulation() *TestPopulation

NewTestPopulation returns a TestPopulation.

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"`
}

TextClassificationInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L174-L184

func NewTextClassificationInferenceOptions ¶ added in v8.5.0 

func NewTextClassificationInferenceOptions() *TextClassificationInferenceOptions

NewTextClassificationInferenceOptions returns a TextClassificationInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L322-L331

func NewTextClassificationInferenceUpdateOptions ¶ added in v8.5.0 

func NewTextClassificationInferenceUpdateOptions() *TextClassificationInferenceUpdateOptions

NewTextClassificationInferenceUpdateOptions returns a TextClassificationInferenceUpdateOptions.

type TextEmbeddingInferenceOptions ¶ 

type TextEmbeddingInferenceOptions 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"`
}

TextEmbeddingInferenceOptions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L217-L223

func NewTextEmbeddingInferenceOptions ¶ added in v8.5.0 

func NewTextEmbeddingInferenceOptions() *TextEmbeddingInferenceOptions

NewTextEmbeddingInferenceOptions returns a TextEmbeddingInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L351-L355

func NewTextEmbeddingInferenceUpdateOptions ¶ added in v8.5.0 

func NewTextEmbeddingInferenceUpdateOptions() *TextEmbeddingInferenceUpdateOptions

NewTextEmbeddingInferenceUpdateOptions returns a TextEmbeddingInferenceUpdateOptions.

type TextIndexPrefixes ¶ 

type TextIndexPrefixes struct {
	MaxChars int `json:"max_chars"`
	MinChars int `json:"min_chars"`
}

TextIndexPrefixes type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L242-L245

func NewTextIndexPrefixes ¶ added in v8.5.0 

func NewTextIndexPrefixes() *TextIndexPrefixes

NewTextIndexPrefixes returns a TextIndexPrefixes.

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"`
	TermVector           *termvectoroption.TermVectorOption `json:"term_vector,omitempty"`
	Type                 string                             `json:"type,omitempty"`
}

TextProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L247-L263

func NewTextProperty ¶ added in v8.5.0 

func NewTextProperty() *TextProperty

NewTextProperty returns a TextProperty.

type TextToAnalyze ¶ 

type TextToAnalyze []string

TextToAnalyze type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/analyze/types.ts#L66-L66

type ThreadCount ¶ 

type ThreadCount struct {
	Active    *int64 `json:"active,omitempty"`
	Completed *int64 `json:"completed,omitempty"`
	Largest   *int64 `json:"largest,omitempty"`
	Queue     *int64 `json:"queue,omitempty"`
	Rejected  *int64 `json:"rejected,omitempty"`
	Threads   *int64 `json:"threads,omitempty"`
}

ThreadCount type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L397-L404

func NewThreadCount ¶ added in v8.5.0 

func NewThreadCount() *ThreadCount

NewThreadCount returns a ThreadCount.

type ThreadPoolRecord ¶ 

type ThreadPoolRecord struct {
	// Active number of active threads
	Active *string `json:"active,omitempty"`
	// Completed number of completed tasks
	Completed *string `json:"completed,omitempty"`
	// Core core number of threads in a scaling thread pool
	Core string `json:"core,omitempty"`
	// EphemeralNodeId ephemeral node id
	EphemeralNodeId *string `json:"ephemeral_node_id,omitempty"`
	// Host host name
	Host *string `json:"host,omitempty"`
	// Ip ip address
	Ip *string `json:"ip,omitempty"`
	// KeepAlive thread keep alive time
	KeepAlive string `json:"keep_alive,omitempty"`
	// Largest highest number of seen active threads
	Largest *string `json:"largest,omitempty"`
	// Max maximum number of threads in a scaling thread pool
	Max string `json:"max,omitempty"`
	// Name thread pool name
	Name *string `json:"name,omitempty"`
	// NodeId persistent node id
	NodeId *string `json:"node_id,omitempty"`
	// NodeName node name
	NodeName *string `json:"node_name,omitempty"`
	// Pid process id
	Pid *string `json:"pid,omitempty"`
	// PoolSize number of threads
	PoolSize *string `json:"pool_size,omitempty"`
	// Port bound transport port
	Port *string `json:"port,omitempty"`
	// Queue number of tasks currently in queue
	Queue *string `json:"queue,omitempty"`
	// QueueSize maximum number of tasks permitted in queue
	QueueSize *string `json:"queue_size,omitempty"`
	// Rejected number of rejected tasks
	Rejected *string `json:"rejected,omitempty"`
	// Size number of threads in a fixed thread pool
	Size string `json:"size,omitempty"`
	// Type thread pool type
	Type *string `json:"type,omitempty"`
}

ThreadPoolRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/thread_pool/types.ts#L22-L123

func NewThreadPoolRecord ¶ added in v8.5.0 

func NewThreadPoolRecord() *ThreadPoolRecord

NewThreadPoolRecord returns a ThreadPoolRecord.

type ThrottleState ¶ 

type ThrottleState struct {
	Reason    string   `json:"reason"`
	Timestamp DateTime `json:"timestamp"`
}

ThrottleState type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L123-L126

func NewThrottleState ¶ added in v8.5.0 

func NewThrottleState() *ThrottleState

NewThrottleState returns a ThrottleState.

type TimeOfMonth ¶ 

type TimeOfMonth struct {
	At []string `json:"at"`
	On []int    `json:"on"`
}

TimeOfMonth type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L115-L118

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L120-L123

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Schedule.ts#L125-L129

func NewTimeOfYear ¶ added in v8.5.0 

func NewTimeOfYear() *TimeOfYear

NewTimeOfYear returns a TimeOfYear.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L175-L187

func NewTimeSync ¶ added in v8.5.0 

func NewTimeSync() *TimeSync

NewTimeSync returns a TimeSync.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L421-L426

func NewTimingStats ¶ added in v8.5.0 

func NewTimingStats() *TimingStats

NewTimingStats returns a TimingStats.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

TokenCountProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/specialized.ts#L78-L85

func NewTokenCountProperty ¶ added in v8.5.0 

func NewTokenCountProperty() *TokenCountProperty

NewTokenCountProperty returns a TokenCountProperty.

type TokenDetail ¶ 

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

TokenDetail type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/analyze/types.ts#L68-L71

func NewTokenDetail ¶ added in v8.5.0 

func NewTokenDetail() *TokenDetail

NewTokenDetail returns a TokenDetail.

type TokenFilter ¶ 

type TokenFilter interface{}

TokenFilter holds the union for the following types: 

string
TokenFilterDefinition

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L342-L344

type TokenFilterDefinition ¶ 

type TokenFilterDefinition interface {
	// contains filtered or unexported methods
}

TokenFilterDefinition holds the union for the following types: 

AsciiFoldingTokenFilter
CommonGramsTokenFilter
ConditionTokenFilter
DelimitedPayloadTokenFilter
EdgeNGramTokenFilter
ElisionTokenFilter
FingerprintTokenFilter
HunspellTokenFilter
HyphenationDecompounderTokenFilter
KeepTypesTokenFilter
KeepWordsTokenFilter
KeywordMarkerTokenFilter
KStemTokenFilter
LengthTokenFilter
LimitTokenCountTokenFilter
LowercaseTokenFilter
MultiplexerTokenFilter
NGramTokenFilter
NoriPartOfSpeechTokenFilter
PatternCaptureTokenFilter
PatternReplaceTokenFilter
PorterStemTokenFilter
PredicateTokenFilter
RemoveDuplicatesTokenFilter
ReverseTokenFilter
ShingleTokenFilter
SnowballTokenFilter
StemmerOverrideTokenFilter
StemmerTokenFilter
StopTokenFilter
SynonymGraphTokenFilter
SynonymTokenFilter
TrimTokenFilter
TruncateTokenFilter
UniqueTokenFilter
UppercaseTokenFilter
WordDelimiterGraphTokenFilter
WordDelimiterTokenFilter
KuromojiStemmerTokenFilter
KuromojiReadingFormTokenFilter
KuromojiPartOfSpeechTokenFilter
IcuTokenizer
IcuCollationTokenFilter
IcuFoldingTokenFilter
IcuNormalizationTokenFilter
IcuTransformTokenFilter
PhoneticTokenFilter
DictionaryDecompounderTokenFilter

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L346-L399

type TokenizationConfigContainer ¶ 

type TokenizationConfigContainer struct {
	// Bert Indicates BERT tokenization and its options
	Bert *NlpBertTokenizationConfig `json:"bert,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"`
}

TokenizationConfigContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L97-L114

func NewTokenizationConfigContainer ¶ added in v8.5.0 

func NewTokenizationConfigContainer() *TokenizationConfigContainer

NewTokenizationConfigContainer returns a TokenizationConfigContainer.

type Tokenizer ¶ 

type Tokenizer interface{}

Tokenizer holds the union for the following types: 

string
TokenizerDefinition

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L119-L121

type TokenizerDefinition ¶ 

type TokenizerDefinition interface {
	// contains filtered or unexported methods
}

TokenizerDefinition holds the union for the following types: 

CharGroupTokenizer
EdgeNGramTokenizer
KeywordTokenizer
LetterTokenizer
LowercaseTokenizer
NGramTokenizer
NoriTokenizer
PathHierarchyTokenizer
StandardTokenizer
UaxEmailUrlTokenizer
WhitespaceTokenizer
KuromojiTokenizer
PatternTokenizer
IcuTokenizer

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L123-L141

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L393-L397

func NewTopClassEntry ¶ added in v8.5.0 

func NewTopClassEntry() *TopClassEntry

NewTopClassEntry returns a TopClassEntry.

type TopHitsAggregate ¶ 

type TopHitsAggregate struct {
	Hits HitsMetadata           `json:"hits"`
	Meta map[string]interface{} `json:"meta,omitempty"`
}

TopHitsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L645-L648

func NewTopHitsAggregate ¶ added in v8.5.0 

func NewTopHitsAggregate() *TopHitsAggregate

NewTopHitsAggregate returns a TopHitsAggregate.

type TopHitsAggregation ¶ 

type TopHitsAggregation struct {
	DocvalueFields   []string               `json:"docvalue_fields,omitempty"`
	Explain          *bool                  `json:"explain,omitempty"`
	Field            *string                `json:"field,omitempty"`
	From             *int                   `json:"from,omitempty"`
	Highlight        *Highlight             `json:"highlight,omitempty"`
	Missing          *Missing               `json:"missing,omitempty"`
	Script           *Script                `json:"script,omitempty"`
	ScriptFields     map[string]ScriptField `json:"script_fields,omitempty"`
	SeqNoPrimaryTerm *bool                  `json:"seq_no_primary_term,omitempty"`
	Size             *int                   `json:"size,omitempty"`
	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"`
}

TopHitsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L171-L184

func NewTopHitsAggregation ¶ added in v8.5.0 

func NewTopHitsAggregation() *TopHitsAggregation

NewTopHitsAggregation returns a TopHitsAggregation.

type TopLeftBottomRightGeoBounds ¶ 

type TopLeftBottomRightGeoBounds struct {
	BottomRight GeoLocation `json:"bottom_right"`
	TopLeft     GeoLocation `json:"top_left"`
}

TopLeftBottomRightGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L145-L148

func NewTopLeftBottomRightGeoBounds ¶ added in v8.5.0 

func NewTopLeftBottomRightGeoBounds() *TopLeftBottomRightGeoBounds

NewTopLeftBottomRightGeoBounds returns a TopLeftBottomRightGeoBounds.

type TopMetrics ¶ 

type TopMetrics struct {
	Metrics map[string]FieldValue `json:"metrics"`
	Sort    []FieldValue          `json:"sort"`
}

TopMetrics type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L720-L724

func NewTopMetrics ¶ added in v8.5.0 

func NewTopMetrics() *TopMetrics

NewTopMetrics returns a TopMetrics.

type TopMetricsAggregate ¶ 

type TopMetricsAggregate struct {
	Meta map[string]interface{} `json:"meta,omitempty"`
	Top  []TopMetrics           `json:"top"`
}

TopMetricsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L715-L718

func NewTopMetricsAggregate ¶ added in v8.5.0 

func NewTopMetricsAggregate() *TopMetricsAggregate

NewTopMetricsAggregate returns a TopMetricsAggregate.

type TopMetricsAggregation ¶ 

type TopMetricsAggregation struct {
	Field   *string            `json:"field,omitempty"`
	Metrics []TopMetricsValue  `json:"metrics,omitempty"`
	Missing *Missing           `json:"missing,omitempty"`
	Script  *Script            `json:"script,omitempty"`
	Size    *int               `json:"size,omitempty"`
	Sort    []SortCombinations `json:"sort,omitempty"`
}

TopMetricsAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L186-L190

func NewTopMetricsAggregation ¶ added in v8.5.0 

func NewTopMetricsAggregation() *TopMetricsAggregation

NewTopMetricsAggregation returns a TopMetricsAggregation.

type TopMetricsValue ¶ 

type TopMetricsValue struct {
	Field string `json:"field"`
}

TopMetricsValue type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L192-L194

func NewTopMetricsValue ¶ added in v8.5.0 

func NewTopMetricsValue() *TopMetricsValue

NewTopMetricsValue returns a TopMetricsValue.

type TopRightBottomLeftGeoBounds ¶ 

type TopRightBottomLeftGeoBounds struct {
	BottomLeft GeoLocation `json:"bottom_left"`
	TopRight   GeoLocation `json:"top_right"`
}

TopRightBottomLeftGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L150-L153

func NewTopRightBottomLeftGeoBounds ¶ added in v8.5.0 

func NewTopRightBottomLeftGeoBounds() *TopRightBottomLeftGeoBounds

NewTopRightBottomLeftGeoBounds returns a TopRightBottomLeftGeoBounds.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L221-L228

func NewTotalFeatureImportance ¶ added in v8.5.0 

func NewTotalFeatureImportance() *TotalFeatureImportance

NewTotalFeatureImportance returns a TotalFeatureImportance.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L230-L235

func NewTotalFeatureImportanceClass ¶ added in v8.5.0 

func NewTotalFeatureImportanceClass() *TotalFeatureImportanceClass

NewTotalFeatureImportanceClass returns a TotalFeatureImportanceClass.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L237-L244

func NewTotalFeatureImportanceStatistics ¶ added in v8.5.0 

func NewTotalFeatureImportanceStatistics() *TotalFeatureImportanceStatistics

NewTotalFeatureImportanceStatistics returns a TotalFeatureImportanceStatistics.

type TotalHits ¶ 

type TotalHits struct {
	Relation totalhitsrelation.TotalHitsRelation `json:"relation"`
	Value    int64                               `json:"value"`
}

TotalHits type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L94-L97

func NewTotalHits ¶ added in v8.5.0 

func NewTotalHits() *TotalHits

NewTotalHits returns a TotalHits.

type TotalUserProfiles ¶ 

type TotalUserProfiles struct {
	Relation string `json:"relation"`
	Value    int64  `json:"value"`
}

TotalUserProfiles type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/suggest_user_profiles/Response.ts#L24-L27

func NewTotalUserProfiles ¶ added in v8.5.0 

func NewTotalUserProfiles() *TotalUserProfiles

NewTotalUserProfiles returns a TotalUserProfiles.

type TrackHits ¶ 

type TrackHits interface{}

TrackHits holds the union for the following types: 

bool
int

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/search/_types/hits.ts#L126-L134

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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 {
	// AssignmentState The overall assignment state.
	AssignmentState deploymentassignmentstate.DeploymentAssignmentState `json:"assignment_state"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L379-L393

func NewTrainedModelAssignment ¶ added in v8.5.0 

func NewTrainedModelAssignment() *TrainedModelAssignment

NewTrainedModelAssignment returns a TrainedModelAssignment.

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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L350-L368

func NewTrainedModelAssignmentRoutingTable ¶ added in v8.5.0 

func NewTrainedModelAssignmentRoutingTable() *TrainedModelAssignmentRoutingTable

NewTrainedModelAssignmentRoutingTable returns a TrainedModelAssignmentRoutingTable.

type TrainedModelAssignmentTaskParameters ¶ 

type TrainedModelAssignmentTaskParameters struct {
	// CacheSize The size of the trained model cache.
	CacheSize ByteSize `json:"cache_size"`
	// ModelBytes The size of the trained model in bytes.
	ModelBytes int `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"`
	// 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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L299-L325

func NewTrainedModelAssignmentTaskParameters ¶ added in v8.5.0 

func NewTrainedModelAssignmentTaskParameters() *TrainedModelAssignmentTaskParameters

NewTrainedModelAssignmentTaskParameters returns a TrainedModelAssignmentTaskParameters.

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"`
	// 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.
	InferenceConfig InferenceConfigCreateContainer `json:"inference_config"`
	// 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"`
	ModelSizeBytes *ByteSize `json:"model_size_bytes,omitempty"`
	// ModelType The model type
	ModelType *trainedmodeltype.TrainedModelType `json:"model_type,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L156-L188

func NewTrainedModelConfig ¶ added in v8.5.0 

func NewTrainedModelConfig() *TrainedModelConfig

NewTrainedModelConfig returns a TrainedModelConfig.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L190-L193

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L195-L203

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L370-L377

func NewTrainedModelDeploymentAllocationStatus ¶ added in v8.5.0 

func NewTrainedModelDeploymentAllocationStatus() *TrainedModelDeploymentAllocationStatus

NewTrainedModelDeploymentAllocationStatus returns a TrainedModelDeploymentAllocationStatus.

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"`
	// ErrorCount The number of errors when evaluating the trained model.
	ErrorCount int `json:"error_count"`
	// InferenceCount The total number of inference calls made against this node for this model.
	InferenceCount int `json:"inference_count"`
	// LastAccess The epoch time stamp of the last inference call for the model on this node.
	LastAccess int64 `json:"last_access"`
	// Node Information pertaining to the node.
	Node DiscoveryNode `json:"node"`
	// NumberOfAllocations The number of allocations assigned to this node.
	NumberOfAllocations int `json:"number_of_allocations"`
	// NumberOfPendingRequests The number of inference requests queued to be processed.
	NumberOfPendingRequests int `json:"number_of_pending_requests"`
	// RejectionExecutionCount The number of inference requests that were not processed because the queue
	// was full.
	RejectionExecutionCount int `json:"rejection_execution_count"`
	// RoutingState The current routing state and reason for the current routing state for this
	// allocation.
	RoutingState TrainedModelAssignmentRoutingTable `json:"routing_state"`
	// StartTime The epoch timestamp when the allocation started.
	StartTime int64 `json:"start_time"`
	// ThreadsPerAllocation The number of threads used by each allocation during inference.
	ThreadsPerAllocation int `json:"threads_per_allocation"`
	// TimeoutCount The number of inference requests that timed out before being processed.
	TimeoutCount int `json:"timeout_count"`
}

TrainedModelDeploymentNodesStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L127-L154

func NewTrainedModelDeploymentNodesStats ¶ added in v8.5.0 

func NewTrainedModelDeploymentNodesStats() *TrainedModelDeploymentNodesStats

NewTrainedModelDeploymentNodesStats returns a TrainedModelDeploymentNodesStats.

type TrainedModelDeploymentStats ¶ 

type TrainedModelDeploymentStats struct {
	// AllocationStatus The detailed allocation status for the deployment.
	AllocationStatus TrainedModelDeploymentAllocationStatus `json:"allocation_status"`
	// ErrorCount The sum of `error_count` for all nodes in the deployment.
	ErrorCount int `json:"error_count"`
	// InferenceCount The sum of `inference_count` for all nodes in the deployment.
	InferenceCount int `json:"inference_count"`
	// ModelId The unique identifier for the trained model.
	ModelId string `json:"model_id"`
	// Nodes The deployent stats for each node that currently has the model allocated.
	Nodes TrainedModelDeploymentNodesStats `json:"nodes"`
	// NumberOfAllocations The number of allocations requested.
	NumberOfAllocations int `json:"number_of_allocations"`
	// QueueCapacity The number of inference requests that can be queued before new requests are
	// rejected.
	QueueCapacity int `json:"queue_capacity"`
	// Reason The reason for the current deployment state. Usually only populated when
	// the model is not deployed to a node.
	Reason string `json:"reason"`
	// 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"`
	// StartTime The epoch timestamp when the deployment started.
	StartTime int64 `json:"start_time"`
	// State The overall state of the deployment.
	State deploymentstate.DeploymentState `json:"state"`
	// ThreadsPerAllocation The number of threads used be each allocation during inference.
	ThreadsPerAllocation int `json:"threads_per_allocation"`
	// TimeoutCount The sum of `timeout_count` for all nodes in the deployment.
	TimeoutCount int `json:"timeout_count"`
}

TrainedModelDeploymentStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L62-L96

func NewTrainedModelDeploymentStats ¶ added in v8.5.0 

func NewTrainedModelDeploymentStats() *TrainedModelDeploymentStats

NewTrainedModelDeploymentStats returns a TrainedModelDeploymentStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L386-L392

func NewTrainedModelEntities ¶ added in v8.5.0 

func NewTrainedModelEntities() *TrainedModelEntities

NewTrainedModelEntities returns a TrainedModelEntities.

type TrainedModelInferenceClassImportance ¶ 

type TrainedModelInferenceClassImportance struct {
	ClassName  string  `json:"class_name"`
	Importance float64 `json:"importance"`
}

TrainedModelInferenceClassImportance type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L399-L402

func NewTrainedModelInferenceClassImportance ¶ added in v8.5.0 

func NewTrainedModelInferenceClassImportance() *TrainedModelInferenceClassImportance

NewTrainedModelInferenceClassImportance returns a TrainedModelInferenceClassImportance.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L404-L408

func NewTrainedModelInferenceFeatureImportance ¶ added in v8.5.0 

func NewTrainedModelInferenceFeatureImportance() *TrainedModelInferenceFeatureImportance

NewTrainedModelInferenceFeatureImportance returns a TrainedModelInferenceFeatureImportance.

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 DateTime `json:"timestamp"`
}

TrainedModelInferenceStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L98-L118

func NewTrainedModelInferenceStats ¶ added in v8.5.0 

func NewTrainedModelInferenceStats() *TrainedModelInferenceStats

NewTrainedModelInferenceStats returns a TrainedModelInferenceStats.

type TrainedModelLocation ¶ 

type TrainedModelLocation struct {
	Index TrainedModelLocationIndex `json:"index"`
}

TrainedModelLocation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L395-L397

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L399-L401

func NewTrainedModelLocationIndex ¶ added in v8.5.0 

func NewTrainedModelLocationIndex() *TrainedModelLocationIndex

NewTrainedModelLocationIndex returns a TrainedModelLocationIndex.

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 int `json:"required_native_memory_bytes"`
}

TrainedModelSizeStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L120-L125

func NewTrainedModelSizeStats ¶ added in v8.5.0 

func NewTrainedModelSizeStats() *TrainedModelSizeStats

NewTrainedModelSizeStats returns a TrainedModelSizeStats.

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]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/TrainedModel.ts#L42-L60

func NewTrainedModelStats ¶ added in v8.5.0 

func NewTrainedModelStats() *TrainedModelStats

NewTrainedModelStats returns a TrainedModelStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L74-L79

func NewTrainedModelTree ¶ added in v8.5.0 

func NewTrainedModelTree() *TrainedModelTree

NewTrainedModelTree returns a TrainedModelTree.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L81-L91

func NewTrainedModelTreeNode ¶ added in v8.5.0 

func NewTrainedModelTreeNode() *TrainedModelTreeNode

NewTrainedModelTreeNode returns a TrainedModelTreeNode.

type TrainedModelsRecord ¶ 

type TrainedModelsRecord struct {
	// CreateTime The time the model was created
	CreateTime *DateTime `json:"create_time,omitempty"`
	// CreatedBy who created 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 config was created
	DataFrameCreateTime *string `json:"data_frame.create_time,omitempty"`
	// DataFrameId The data frame analytics config id that created the model (if 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 The model description
	Description *string `json:"description,omitempty"`
	// HeapSize the estimated heap size to keep the model in memory
	HeapSize *ByteSize `json:"heap_size,omitempty"`
	// Id the trained model id
	Id *string `json:"id,omitempty"`
	// IngestCount The total number of docs processed by the model
	IngestCount *string `json:"ingest.count,omitempty"`
	// IngestCurrent The total documents currently being handled by the model
	IngestCurrent *string `json:"ingest.current,omitempty"`
	// IngestFailed The total count of failed ingest attempts with this model
	IngestFailed *string `json:"ingest.failed,omitempty"`
	// IngestPipelines The number of pipelines referencing the model
	IngestPipelines *string `json:"ingest.pipelines,omitempty"`
	// IngestTime The total time spent processing docs with this 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
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/ml_trained_models/types.ts#L23-L111

func NewTrainedModelsRecord ¶ added in v8.5.0 

func NewTrainedModelsRecord() *TrainedModelsRecord

NewTrainedModelsRecord returns a TrainedModelsRecord.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/Authorization.ts#L59-L71

func NewTransformAuthorization ¶ added in v8.5.0 

func NewTransformAuthorization() *TransformAuthorization

NewTransformAuthorization returns a TransformAuthorization.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L34-L45

func NewTransformDestination ¶ added in v8.5.0 

func NewTransformDestination() *TransformDestination

NewTransformDestination returns a TransformDestination.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform_stats/types.ts#L48-L66

func NewTransformIndexerStats ¶ added in v8.5.0 

func NewTransformIndexerStats() *TransformIndexerStats

NewTransformIndexerStats returns a TransformIndexerStats.

type TransformProgress ¶ 

type TransformProgress struct {
	DocsIndexed     int64   `json:"docs_indexed"`
	DocsProcessed   int64   `json:"docs_processed"`
	DocsRemaining   int64   `json:"docs_remaining"`
	PercentComplete float64 `json:"percent_complete"`
	TotalDocs       int64   `json:"total_docs"`
}

TransformProgress type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform_stats/types.ts#L40-L46

func NewTransformProgress ¶ added in v8.5.0 

func NewTransformProgress() *TransformProgress

NewTransformProgress returns a TransformProgress.

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 map[string]RuntimeField `json:"runtime_mappings,omitempty"`
}

TransformSource type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/_types/Transform.ts#L145-L163

func NewTransformSource ¶ added in v8.5.0 

func NewTransformSource() *TransformSource

NewTransformSource returns a TransformSource.

type TransformStats ¶ 

type TransformStats struct {
	Checkpointing Checkpointing         `json:"checkpointing"`
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform_stats/types.ts#L31-L38

func NewTransformStats ¶ added in v8.5.0 

func NewTransformStats() *TransformStats

NewTransformStats returns a TransformStats.

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"`
	// 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_     map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/transform/get_transform/types.ts#L33-L61

func NewTransformSummary ¶ added in v8.5.0 

func NewTransformSummary() *TransformSummary

NewTransformSummary returns a TransformSummary.

type TransformsRecord ¶ 

type TransformsRecord struct {
	// ChangesLastDetectionTime changes last detected time
	ChangesLastDetectionTime string `json:"changes_last_detection_time,omitempty"`
	// Checkpoint checkpoint
	Checkpoint *string `json:"checkpoint,omitempty"`
	// CheckpointDurationTimeExpAvg exponential average checkpoint processing time (milliseconds)
	CheckpointDurationTimeExpAvg *string `json:"checkpoint_duration_time_exp_avg,omitempty"`
	// CheckpointProgress progress of the checkpoint
	CheckpointProgress string `json:"checkpoint_progress,omitempty"`
	// CreateTime transform creation time
	CreateTime *string `json:"create_time,omitempty"`
	// DeleteTime total time spent deleting documents
	DeleteTime *string `json:"delete_time,omitempty"`
	// Description description
	Description *string `json:"description,omitempty"`
	// DestIndex destination index
	DestIndex *string `json:"dest_index,omitempty"`
	// DocsPerSecond docs per second
	DocsPerSecond *string `json:"docs_per_second,omitempty"`
	// DocumentsDeleted the number of documents deleted from the destination index
	DocumentsDeleted *string `json:"documents_deleted,omitempty"`
	// DocumentsIndexed the number of documents written to the destination index
	DocumentsIndexed *string `json:"documents_indexed,omitempty"`
	// DocumentsProcessed the number of documents read from source indices and processed
	DocumentsProcessed *string `json:"documents_processed,omitempty"`
	// Frequency frequency of transform
	Frequency *string `json:"frequency,omitempty"`
	// Id the id
	Id *string `json:"id,omitempty"`
	// IndexFailure total number of index failures
	IndexFailure *string `json:"index_failure,omitempty"`
	// IndexTime total time spent indexing documents
	IndexTime *string `json:"index_time,omitempty"`
	// IndexTotal total number of index phases done by the transform
	IndexTotal *string `json:"index_total,omitempty"`
	// IndexedDocumentsExpAvg exponential average number of documents indexed
	IndexedDocumentsExpAvg *string `json:"indexed_documents_exp_avg,omitempty"`
	// LastSearchTime last time transform searched for updates
	LastSearchTime string `json:"last_search_time,omitempty"`
	// MaxPageSearchSize max page search size
	MaxPageSearchSize *string `json:"max_page_search_size,omitempty"`
	// PagesProcessed the number of pages processed
	PagesProcessed *string `json:"pages_processed,omitempty"`
	// Pipeline transform pipeline
	Pipeline *string `json:"pipeline,omitempty"`
	// ProcessedDocumentsExpAvg exponential average number of documents processed
	ProcessedDocumentsExpAvg *string `json:"processed_documents_exp_avg,omitempty"`
	// ProcessingTime the total time spent processing documents
	ProcessingTime *string `json:"processing_time,omitempty"`
	// Reason reason for the current state
	Reason *string `json:"reason,omitempty"`
	// SearchFailure total number of search failures
	SearchFailure *string `json:"search_failure,omitempty"`
	// SearchTime total search time
	SearchTime *string `json:"search_time,omitempty"`
	// SearchTotal total number of search phases
	SearchTotal *string `json:"search_total,omitempty"`
	// SourceIndex source index
	SourceIndex *string `json:"source_index,omitempty"`
	// State transform state
	State *string `json:"state,omitempty"`
	// TransformType batch or continuous transform
	TransformType *string `json:"transform_type,omitempty"`
	// TriggerCount the number of times the transform has been triggered
	TriggerCount *string `json:"trigger_count,omitempty"`
	// Version the version of Elasticsearch when the transform was created
	Version *string `json:"version,omitempty"`
}

TransformsRecord type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cat/transforms/types.ts#L22-L187

func NewTransformsRecord ¶ added in v8.5.0 

func NewTransformsRecord() *TransformsRecord

NewTransformsRecord returns a TransformsRecord.

type TransientMetadataConfig ¶ 

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

TransientMetadataConfig type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/TransientMetadataConfig.ts#L20-L22

func NewTransientMetadataConfig ¶ added in v8.5.0 

func NewTransientMetadataConfig() *TransientMetadataConfig

NewTransientMetadataConfig returns a TransientMetadataConfig.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L332-L354

func NewTranslog ¶ added in v8.5.0 

func NewTranslog() *Translog

NewTranslog returns a Translog.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/_types/IndexSettings.ts#L373-L392

func NewTranslogRetention ¶ added in v8.5.0 

func NewTranslogRetention() *TranslogRetention

NewTranslogRetention returns a TranslogRetention.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L242-L250

func NewTranslogStats ¶ added in v8.5.0 

func NewTranslogStats() *TranslogStats

NewTranslogStats returns a TranslogStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L102-L109

func NewTranslogStatus ¶ added in v8.5.0 

func NewTranslogStatus() *TranslogStatus

NewTranslogStatus returns a TranslogStatus.

type Transport ¶ 

type Transport struct {
	InboundHandlingTimeHistogram  []TransportHistogram `json:"inbound_handling_time_histogram,omitempty"`
	OutboundHandlingTimeHistogram []TransportHistogram `json:"outbound_handling_time_histogram,omitempty"`
	RxCount                       *int64               `json:"rx_count,omitempty"`
	RxSize                        *string              `json:"rx_size,omitempty"`
	RxSizeInBytes                 *int64               `json:"rx_size_in_bytes,omitempty"`
	ServerOpen                    *int                 `json:"server_open,omitempty"`
	TotalOutboundConnections      *int64               `json:"total_outbound_connections,omitempty"`
	TxCount                       *int64               `json:"tx_count,omitempty"`
	TxSize                        *string              `json:"tx_size,omitempty"`
	TxSizeInBytes                 *int64               `json:"tx_size_in_bytes,omitempty"`
}

Transport type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L413-L424

func NewTransport ¶ added in v8.5.0 

func NewTransport() *Transport

NewTransport returns a Transport.

type TransportHistogram ¶ 

type TransportHistogram struct {
	Count    *int64 `json:"count,omitempty"`
	GeMillis *int64 `json:"ge_millis,omitempty"`
	LtMillis *int64 `json:"lt_millis,omitempty"`
}

TransportHistogram type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/nodes/_types/Stats.ts#L426-L430

func NewTransportHistogram ¶ added in v8.5.0 

func NewTransportHistogram() *TransportHistogram

NewTransportHistogram returns a TransportHistogram.

type TriggerContainer ¶ 

type TriggerContainer struct {
	Schedule *ScheduleContainer `json:"schedule,omitempty"`
}

TriggerContainer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Trigger.ts#L39-L43

func NewTriggerEventResult ¶ added in v8.5.0 

func NewTriggerEventResult() *TriggerEventResult

NewTriggerEventResult returns a TriggerEventResult.

type TrimProcessor ¶ 

type TrimProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

TrimProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L362-L366

func NewTrimProcessor ¶ added in v8.5.0 

func NewTrimProcessor() *TrimProcessor

NewTrimProcessor returns a TrimProcessor.

type TrimTokenFilter ¶ 

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

TrimTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L324-L326

func NewTrimTokenFilter ¶ added in v8.5.0 

func NewTrimTokenFilter() *TrimTokenFilter

NewTrimTokenFilter returns a TrimTokenFilter.

type TruncateTokenFilter ¶ 

type TruncateTokenFilter struct {
	Length  *int    `json:"length,omitempty"`
	Type    string  `json:"type,omitempty"`
	Version *string `json:"version,omitempty"`
}

TruncateTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L328-L331

func NewTruncateTokenFilter ¶ added in v8.5.0 

func NewTruncateTokenFilter() *TruncateTokenFilter

NewTruncateTokenFilter returns a TruncateTokenFilter.

type TypeFieldMappings ¶ 

type TypeFieldMappings struct {
	Mappings map[string]FieldMapping `json:"mappings"`
}

TypeFieldMappings type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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_                map[string]interface{}         `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"`
}

TypeMapping type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/TypeMapping.ts#L34-L55

func NewTypeMapping ¶ added in v8.5.0 

func NewTypeMapping() *TypeMapping

NewTypeMapping returns a TypeMapping.

type TypeQuery ¶ 

type TypeQuery struct {
	Boost      *float32 `json:"boost,omitempty"`
	QueryName_ *string  `json:"_name,omitempty"`
	Value      string   `json:"value"`
}

TypeQuery type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L145-L147

func NewTypeQuery ¶ added in v8.5.0 

func NewTypeQuery() *TypeQuery

NewTypeQuery returns a TypeQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L109-L112

func NewUaxEmailUrlTokenizer ¶ added in v8.5.0 

func NewUaxEmailUrlTokenizer() *UaxEmailUrlTokenizer

NewUaxEmailUrlTokenizer returns a UaxEmailUrlTokenizer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/cluster/allocation_explain/types.ts#L117-L125

func NewUnassignedInformation ¶ added in v8.5.0 

func NewUnassignedInformation() *UnassignedInformation

NewUnassignedInformation returns a UnassignedInformation.

type UniqueTokenFilter ¶ 

type UniqueTokenFilter struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L333-L336

func NewUniqueTokenFilter ¶ added in v8.5.0 

func NewUniqueTokenFilter() *UniqueTokenFilter

NewUniqueTokenFilter returns a UniqueTokenFilter.

type UnmappedRareTermsAggregate ¶ 

type UnmappedRareTermsAggregate struct {
	Buckets BucketsVoid            `json:"buckets"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

UnmappedRareTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L452-L458

func NewUnmappedRareTermsAggregate ¶ added in v8.5.0 

func NewUnmappedRareTermsAggregate() *UnmappedRareTermsAggregate

NewUnmappedRareTermsAggregate returns a UnmappedRareTermsAggregate.

type UnmappedSamplerAggregate ¶ 

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

UnmappedSamplerAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L500-L501

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

type UnmappedSignificantTermsAggregate ¶ 

type UnmappedSignificantTermsAggregate struct {
	BgCount  *int64                 `json:"bg_count,omitempty"`
	Buckets  BucketsVoid            `json:"buckets"`
	DocCount *int64                 `json:"doc_count,omitempty"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
}

UnmappedSignificantTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L609-L615

func NewUnmappedSignificantTermsAggregate ¶ added in v8.5.0 

func NewUnmappedSignificantTermsAggregate() *UnmappedSignificantTermsAggregate

NewUnmappedSignificantTermsAggregate returns a UnmappedSignificantTermsAggregate.

type UnmappedTermsAggregate ¶ 

type UnmappedTermsAggregate struct {
	Buckets                 BucketsVoid            `json:"buckets"`
	DocCountErrorUpperBound *int64                 `json:"doc_count_error_upper_bound,omitempty"`
	Meta                    map[string]interface{} `json:"meta,omitempty"`
	SumOtherDocCount        *int64                 `json:"sum_other_doc_count,omitempty"`
}

UnmappedTermsAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L422-L428

func NewUnmappedTermsAggregate ¶ added in v8.5.0 

func NewUnmappedTermsAggregate() *UnmappedTermsAggregate

NewUnmappedTermsAggregate returns a UnmappedTermsAggregate.

type UnratedDocument ¶ 

type UnratedDocument struct {
	Id_    string `json:"_id"`
	Index_ string `json:"_index"`
}

UnratedDocument type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/rank_eval/types.ts#L147-L150

func NewUnratedDocument ¶ added in v8.5.0 

func NewUnratedDocument() *UnratedDocument

NewUnratedDocument returns a UnratedDocument.

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"`
	Similarity    *string                      `json:"similarity,omitempty"`
	Store         *bool                        `json:"store,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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L166-L169

func NewUnsignedLongNumberProperty ¶ added in v8.5.0 

func NewUnsignedLongNumberProperty() *UnsignedLongNumberProperty

NewUnsignedLongNumberProperty returns a UnsignedLongNumberProperty.

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[TaskId]TaskInfo `json:"tasks"`
	TransportAddress string              `json:"transport_address"`
}

UpdateByQueryRethrottleNode type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_global/update_by_query_rethrottle/UpdateByQueryRethrottleNode.ts#L25-L27

func NewUpdateByQueryRethrottleNode ¶ added in v8.5.0 

func NewUpdateByQueryRethrottleNode() *UpdateByQueryRethrottleNode

NewUpdateByQueryRethrottleNode returns a UpdateByQueryRethrottleNode.

type UppercaseProcessor ¶ 

type UppercaseProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

UppercaseProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L368-L372

func NewUppercaseProcessor ¶ added in v8.5.0 

func NewUppercaseProcessor() *UppercaseProcessor

NewUppercaseProcessor returns a UppercaseProcessor.

type UppercaseTokenFilter ¶ 

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

UppercaseTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L338-L340

func NewUppercaseTokenFilter ¶ added in v8.5.0 

func NewUppercaseTokenFilter() *UppercaseTokenFilter

NewUppercaseTokenFilter returns a UppercaseTokenFilter.

type UrlDecodeProcessor ¶ 

type UrlDecodeProcessor struct {
	Description   *string              `json:"description,omitempty"`
	Field         string               `json:"field"`
	If            *string              `json:"if,omitempty"`
	IgnoreFailure *bool                `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer `json:"on_failure,omitempty"`
	Tag           *string              `json:"tag,omitempty"`
	TargetField   *string              `json:"target_field,omitempty"`
}

UrlDecodeProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L374-L378

func NewUrlDecodeProcessor ¶ added in v8.5.0 

func NewUrlDecodeProcessor() *UrlDecodeProcessor

NewUrlDecodeProcessor returns a UrlDecodeProcessor.

type UsageStatsIndex ¶ 

type UsageStatsIndex struct {
	Shards []UsageStatsShards `json:"shards"`
}

UsageStatsIndex type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L38-L40

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/field_usage_stats/IndicesFieldUsageStatsResponse.ts#L42-L47

func NewUsageStatsShards ¶ added in v8.5.0 

func NewUsageStatsShards() *UsageStatsShards

NewUsageStatsShards returns a UsageStatsShards.

type User ¶ 

type User struct {
	Email      string                 `json:"email,omitempty"`
	Enabled    bool                   `json:"enabled"`
	FullName   string                 `json:"full_name,omitempty"`
	Metadata   map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/User.ts#L23-L31

func NewUser ¶ added in v8.5.0 

func NewUser() *User

NewUser returns a User.

type UserAgentProcessor ¶ 

type UserAgentProcessor struct {
	Description   *string                               `json:"description,omitempty"`
	Field         string                                `json:"field"`
	If            *string                               `json:"if,omitempty"`
	IgnoreFailure *bool                                 `json:"ignore_failure,omitempty"`
	IgnoreMissing *bool                                 `json:"ignore_missing,omitempty"`
	OnFailure     []ProcessorContainer                  `json:"on_failure,omitempty"`
	Options       []useragentproperty.UserAgentProperty `json:"options,omitempty"`
	RegexFile     *string                               `json:"regex_file,omitempty"`
	Tag           *string                               `json:"tag,omitempty"`
	TargetField   *string                               `json:"target_field,omitempty"`
}

UserAgentProcessor type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ingest/_types/Processors.ts#L115-L121

func NewUserAgentProcessor ¶ added in v8.5.0 

func NewUserAgentProcessor() *UserAgentProcessor

NewUserAgentProcessor returns a UserAgentProcessor.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/Privileges.ts#L106-L128

func NewUserIndicesPrivileges ¶ added in v8.5.0 

func NewUserIndicesPrivileges() *UserIndicesPrivileges

NewUserIndicesPrivileges returns a UserIndicesPrivileges.

type UserProfile ¶ 

type UserProfile struct {
	Data    map[string]interface{} `json:"data"`
	Enabled *bool                  `json:"enabled,omitempty"`
	Labels  map[string]interface{} `json:"labels"`
	Uid     string                 `json:"uid"`
	User    UserProfileUser        `json:"user"`
}

UserProfile type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/UserProfile.ts#L42-L48

func NewUserProfile ¶ added in v8.5.0 

func NewUserProfile() *UserProfile

NewUserProfile returns a UserProfile.

type UserProfileHitMetadata ¶ 

type UserProfileHitMetadata struct {
	PrimaryTerm_ int64 `json:"_primary_term"`
	SeqNo_       int64 `json:"_seq_no"`
}

UserProfileHitMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/UserProfile.ts#L28-L31

func NewUserProfileHitMetadata ¶ added in v8.5.0 

func NewUserProfileHitMetadata() *UserProfileHitMetadata

NewUserProfileHitMetadata returns a UserProfileHitMetadata.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/UserProfile.ts#L33-L40

func NewUserProfileUser ¶ added in v8.5.0 

func NewUserProfileUser() *UserProfileUser

NewUserProfileUser returns a UserProfileUser.

type UserProfileWithMetadata ¶ 

type UserProfileWithMetadata struct {
	Data             map[string]interface{} `json:"data"`
	Doc_             UserProfileHitMetadata `json:"_doc"`
	Enabled          *bool                  `json:"enabled,omitempty"`
	Labels           map[string]interface{} `json:"labels"`
	LastSynchronized int64                  `json:"last_synchronized"`
	Uid              string                 `json:"uid"`
	User             UserProfileUser        `json:"user"`
}

UserProfileWithMetadata type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/_types/UserProfile.ts#L50-L53

func NewUserProfileWithMetadata ¶ added in v8.5.0 

func NewUserProfileWithMetadata() *UserProfileWithMetadata

NewUserProfileWithMetadata returns a UserProfileWithMetadata.

type UserRealm ¶ 

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

UserRealm type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/security/get_token/types.ts#L30-L33

func NewUserRealm ¶ added in v8.5.0 

func NewUserRealm() *UserRealm

NewUserRealm returns a UserRealm.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/DataframeAnalytics.ts#L428-L433

func NewValidationLoss ¶ added in v8.5.0 

func NewValidationLoss() *ValidationLoss

NewValidationLoss returns a ValidationLoss.

type ValueCountAggregate ¶ 

type ValueCountAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L217-L221

func NewValueCountAggregate ¶ added in v8.5.0 

func NewValueCountAggregate() *ValueCountAggregate

NewValueCountAggregate returns a ValueCountAggregate.

type ValueCountAggregation ¶ 

type ValueCountAggregation struct {
	Field   *string  `json:"field,omitempty"`
	Format  *string  `json:"format,omitempty"`
	Missing *Missing `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

ValueCountAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L196-L196

func NewValueCountAggregation ¶ added in v8.5.0 

func NewValueCountAggregation() *ValueCountAggregation

NewValueCountAggregation returns a ValueCountAggregation.

type VariableWidthHistogramAggregate ¶ 

type VariableWidthHistogramAggregate struct {
	Buckets BucketsVariableWidthHistogramBucket `json:"buckets"`
	Meta    map[string]interface{}              `json:"meta,omitempty"`
}

VariableWidthHistogramAggregate type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L361-L363

func NewVariableWidthHistogramAggregate ¶ added in v8.5.0 

func NewVariableWidthHistogramAggregate() *VariableWidthHistogramAggregate

NewVariableWidthHistogramAggregate returns a VariableWidthHistogramAggregate.

type VariableWidthHistogramAggregation ¶ 

type VariableWidthHistogramAggregation struct {
	Buckets       *int    `json:"buckets,omitempty"`
	Field         *string `json:"field,omitempty"`
	InitialBuffer *int    `json:"initial_buffer,omitempty"`
	ShardSize     *int    `json:"shard_size,omitempty"`
}

VariableWidthHistogramAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/bucket.ts#L430-L435

func NewVariableWidthHistogramAggregation ¶ added in v8.5.0 

func NewVariableWidthHistogramAggregation() *VariableWidthHistogramAggregation

NewVariableWidthHistogramAggregation returns a VariableWidthHistogramAggregation.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L365-L372

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

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L436-L440

func NewVector ¶ added in v8.5.0 

func NewVector() *Vector

NewVector returns a Vector.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/indices/recovery/types.ts#L111-L116

func NewVerifyIndex ¶ added in v8.5.0 

func NewVerifyIndex() *VerifyIndex

NewVerifyIndex returns a VerifyIndex.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

VersionProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L265-L267

func NewVersionProperty ¶ added in v8.5.0 

func NewVersionProperty() *VersionProperty

NewVersionProperty returns a VersionProperty.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/Vertex.ts#L23-L28

func NewVertex ¶ added in v8.5.0 

func NewVertex() *Vertex

NewVertex returns a Vertex.

type VertexDefinition ¶ 

type VertexDefinition struct {
	Exclude          []string        `json:"exclude,omitempty"`
	Field            string          `json:"field"`
	Include          []VertexInclude `json:"include,omitempty"`
	MinDocCount      *int64          `json:"min_doc_count,omitempty"`
	ShardMinDocCount *int64          `json:"shard_min_doc_count,omitempty"`
	Size             *int            `json:"size,omitempty"`
}

VertexDefinition type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/Vertex.ts#L30-L37

func NewVertexDefinition ¶ added in v8.5.0 

func NewVertexDefinition() *VertexDefinition

NewVertexDefinition returns a VertexDefinition.

type VertexInclude ¶ 

type VertexInclude struct {
	Boost float64 `json:"boost"`
	Term  string  `json:"term"`
}

VertexInclude type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/graph/_types/Vertex.ts#L39-L42

func NewVertexInclude ¶ added in v8.5.0 

func NewVertexInclude() *VertexInclude

NewVertexInclude returns a VertexInclude.

type WaitForActiveShards ¶ 

type WaitForActiveShards interface{}

WaitForActiveShards holds the union for the following types: 

int
waitforactiveshardoptions.WaitForActiveShardOptions

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/common.ts#L122-L123

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Stats.ts#L252-L257

func NewWarmerStats ¶ added in v8.5.0 

func NewWarmerStats() *WarmerStats

NewWarmerStats returns a WarmerStats.

type Watch ¶ 

type Watch struct {
	Actions                map[string]WatcherAction `json:"actions"`
	Condition              WatcherCondition         `json:"condition"`
	Input                  WatcherInput             `json:"input"`
	Metadata               map[string]interface{}   `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Watch.ts#L37-L47

func NewWatch ¶ added in v8.5.0 

func NewWatch() *Watch

NewWatch returns a Watch.

type WatchRecord ¶ 

type WatchRecord struct {
	Condition    WatcherCondition                `json:"condition"`
	Input        WatcherInput                    `json:"input"`
	Messages     []string                        `json:"messages"`
	Metadata     map[string]interface{}          `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/execute_watch/types.ts#L27-L39

func NewWatchRecord ¶ added in v8.5.0 

func NewWatchRecord() *WatchRecord

NewWatchRecord returns a WatchRecord.

type WatchRecordQueuedStats ¶ 

type WatchRecordQueuedStats struct {
	ExecutionTime DateTime `json:"execution_time"`
}

WatchRecordQueuedStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/stats/types.ts#L50-L52

func NewWatchRecordQueuedStats ¶ added in v8.5.0 

func NewWatchRecordQueuedStats() *WatchRecordQueuedStats

NewWatchRecordQueuedStats returns a WatchRecordQueuedStats.

type WatchRecordStats ¶ 

type WatchRecordStats struct {
	ExecutedActions []string                      `json:"executed_actions,omitempty"`
	ExecutionPhase  executionphase.ExecutionPhase `json:"execution_phase"`
	ExecutionTime   DateTime                      `json:"execution_time"`
	TriggeredTime   DateTime                      `json:"triggered_time"`
	WatchId         string                        `json:"watch_id"`
	WatchRecordId   string                        `json:"watch_record_id"`
}

WatchRecordStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/stats/types.ts#L54-L60

func NewWatchRecordStats ¶ added in v8.5.0 

func NewWatchRecordStats() *WatchRecordStats

NewWatchRecordStats returns a WatchRecordStats.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Watch.ts#L49-L56

func NewWatchStatus ¶ added in v8.5.0 

func NewWatchStatus() *WatchStatus

NewWatchStatus returns a WatchStatus.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L442-L446

func NewWatcher ¶ added in v8.5.0 

func NewWatcher() *Watcher

NewWatcher returns a Watcher.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L41-L57

func NewWatcherAction ¶ added in v8.5.0 

func NewWatcherAction() *WatcherAction

NewWatcherAction returns a WatcherAction.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L394-L397

func NewWatcherActionTotals ¶ added in v8.5.0 

func NewWatcherActionTotals() *WatcherActionTotals

NewWatcherActionTotals returns a WatcherActionTotals.

type WatcherActions ¶ 

type WatcherActions struct {
	Actions map[string]WatcherActionTotals `json:"actions"`
}

WatcherActions type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L378-L380

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Conditions.ts#L47-L59

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]interface{} `json:"simple,omitempty"`
}

WatcherInput type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Input.ts#L90-L98

func NewWatcherInput ¶ added in v8.5.0 

func NewWatcherInput() *WatcherInput

NewWatcherInput returns a WatcherInput.

type WatcherNodeStats ¶ 

type WatcherNodeStats struct {
	CurrentWatches      []WatchRecordStats        `json:"current_watches,omitempty"`
	ExecutionThreadPool ExecutionThreadPool       `json:"execution_thread_pool"`
	NodeId              string                    `json:"node_id"`
	QueuedWatches       []WatchRecordQueuedStats  `json:"queued_watches,omitempty"`
	WatchCount          int64                     `json:"watch_count"`
	WatcherState        watcherstate.WatcherState `json:"watcher_state"`
}

WatcherNodeStats type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/stats/types.ts#L33-L40

func NewWatcherNodeStats ¶ added in v8.5.0 

func NewWatcherNodeStats() *WatcherNodeStats

NewWatcherNodeStats returns a WatcherNodeStats.

type WatcherStatusActions ¶ added in v8.5.0 

type WatcherStatusActions map[string]ActionStatus

WatcherStatusActions type alias.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Action.ts#L59-L59

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L382-L387

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L389-L392

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L448-L451

func NewWatcherWatchTriggerSchedule ¶ added in v8.5.0 

func NewWatcherWatchTriggerSchedule() *WatcherWatchTriggerSchedule

NewWatcherWatchTriggerSchedule returns a WatcherWatchTriggerSchedule.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/watcher/_types/Actions.ts#L293-L293

func NewWebhookAction ¶ added in v8.5.0 

func NewWebhookAction() *WebhookAction

NewWebhookAction returns a WebhookAction.

type WebhookResult ¶ 

type WebhookResult struct {
	Request  HttpInputRequestResult   `json:"request"`
	Response *HttpInputResponseResult `json:"response,omitempty"`
}

WebhookResult type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/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    *string                `json:"format,omitempty"`
	Meta      map[string]interface{} `json:"meta,omitempty"`
	Name      *string                `json:"name,omitempty"`
	Value     *WeightedAverageValue  `json:"value,omitempty"`
	ValueType *valuetype.ValueType   `json:"value_type,omitempty"`
	Weight    *WeightedAverageValue  `json:"weight,omitempty"`
}

WeightedAverageAggregation type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L211-L216

func NewWeightedAverageAggregation ¶ added in v8.5.0 

func NewWeightedAverageAggregation() *WeightedAverageAggregation

NewWeightedAverageAggregation returns a WeightedAverageAggregation.

type WeightedAverageValue ¶ 

type WeightedAverageValue struct {
	Field   *string  `json:"field,omitempty"`
	Missing *float64 `json:"missing,omitempty"`
	Script  *Script  `json:"script,omitempty"`
}

WeightedAverageValue type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/metric.ts#L218-L222

func NewWeightedAverageValue ¶ added in v8.5.0 

func NewWeightedAverageValue() *WeightedAverageValue

NewWeightedAverageValue returns a WeightedAverageValue.

type WeightedAvgAggregate ¶ 

type WeightedAvgAggregate struct {
	Meta map[string]interface{} `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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/aggregations/Aggregate.ts#L211-L215

func NewWeightedAvgAggregate ¶ added in v8.5.0 

func NewWeightedAvgAggregate() *WeightedAvgAggregate

NewWeightedAvgAggregate returns a WeightedAvgAggregate.

type Weights ¶ 

type Weights struct {
	Weights float64 `json:"weights"`
}

Weights type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/put_trained_model/types.ts#L108-L110

func NewWeights ¶ added in v8.5.0 

func NewWeights() *Weights

NewWeights returns a Weights.

type WhitespaceAnalyzer ¶ 

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

WhitespaceAnalyzer type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/analyzers.ts#L108-L111

func NewWhitespaceAnalyzer ¶ added in v8.5.0 

func NewWhitespaceAnalyzer() *WhitespaceAnalyzer

NewWhitespaceAnalyzer returns a WhitespaceAnalyzer.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/tokenizers.ts#L114-L117

func NewWhitespaceTokenizer ¶ added in v8.5.0 

func NewWhitespaceTokenizer() *WhitespaceTokenizer

NewWhitespaceTokenizer returns a WhitespaceTokenizer.

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"`
	Similarity *string             `json:"similarity,omitempty"`
	Store      *bool               `json:"store,omitempty"`
	Type       string              `json:"type,omitempty"`
}

WildcardProperty type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/mapping/core.ts#L269-L273

func NewWildcardProperty ¶ added in v8.5.0 

func NewWildcardProperty() *WildcardProperty

NewWildcardProperty returns a WildcardProperty.

type WildcardQuery ¶ 

type WildcardQuery struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/term.ts#L149-L162

func NewWildcardQuery ¶ added in v8.5.0 

func NewWildcardQuery() *WildcardQuery

NewWildcardQuery returns a WildcardQuery.

type WktGeoBounds ¶ 

type WktGeoBounds struct {
	Wkt string `json:"wkt"`
}

WktGeoBounds type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/Geo.ts#L134-L136

func NewWktGeoBounds ¶ added in v8.5.0 

func NewWktGeoBounds() *WktGeoBounds

NewWktGeoBounds returns a WktGeoBounds.

type WordDelimiterGraphTokenFilter ¶ 

type WordDelimiterGraphTokenFilter struct {
	AdjustOffsets         *bool    `json:"adjust_offsets,omitempty"`
	CatenateAll           *bool    `json:"catenate_all,omitempty"`
	CatenateNumbers       *bool    `json:"catenate_numbers,omitempty"`
	CatenateWords         *bool    `json:"catenate_words,omitempty"`
	GenerateNumberParts   *bool    `json:"generate_number_parts,omitempty"`
	GenerateWordParts     *bool    `json:"generate_word_parts,omitempty"`
	IgnoreKeywords        *bool    `json:"ignore_keywords,omitempty"`
	PreserveOriginal      *bool    `json:"preserve_original,omitempty"`
	ProtectedWords        []string `json:"protected_words,omitempty"`
	ProtectedWordsPath    *string  `json:"protected_words_path,omitempty"`
	SplitOnCaseChange     *bool    `json:"split_on_case_change,omitempty"`
	SplitOnNumerics       *bool    `json:"split_on_numerics,omitempty"`
	StemEnglishPossessive *bool    `json:"stem_english_possessive,omitempty"`
	Type                  string   `json:"type,omitempty"`
	TypeTable             []string `json:"type_table,omitempty"`
	TypeTablePath         *string  `json:"type_table_path,omitempty"`
	Version               *string  `json:"version,omitempty"`
}

WordDelimiterGraphTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L148-L165

func NewWordDelimiterGraphTokenFilter ¶ added in v8.5.0 

func NewWordDelimiterGraphTokenFilter() *WordDelimiterGraphTokenFilter

NewWordDelimiterGraphTokenFilter returns a WordDelimiterGraphTokenFilter.

type WordDelimiterTokenFilter ¶ 

type WordDelimiterTokenFilter struct {
	CatenateAll           *bool    `json:"catenate_all,omitempty"`
	CatenateNumbers       *bool    `json:"catenate_numbers,omitempty"`
	CatenateWords         *bool    `json:"catenate_words,omitempty"`
	GenerateNumberParts   *bool    `json:"generate_number_parts,omitempty"`
	GenerateWordParts     *bool    `json:"generate_word_parts,omitempty"`
	PreserveOriginal      *bool    `json:"preserve_original,omitempty"`
	ProtectedWords        []string `json:"protected_words,omitempty"`
	ProtectedWordsPath    *string  `json:"protected_words_path,omitempty"`
	SplitOnCaseChange     *bool    `json:"split_on_case_change,omitempty"`
	SplitOnNumerics       *bool    `json:"split_on_numerics,omitempty"`
	StemEnglishPossessive *bool    `json:"stem_english_possessive,omitempty"`
	Type                  string   `json:"type,omitempty"`
	TypeTable             []string `json:"type_table,omitempty"`
	TypeTablePath         *string  `json:"type_table_path,omitempty"`
	Version               *string  `json:"version,omitempty"`
}

WordDelimiterTokenFilter type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/analysis/token_filters.ts#L131-L146

func NewWordDelimiterTokenFilter ¶ added in v8.5.0 

func NewWordDelimiterTokenFilter() *WordDelimiterTokenFilter

NewWordDelimiterTokenFilter returns a WordDelimiterTokenFilter.

type WrapperQuery ¶ 

type WrapperQuery struct {
	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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/_types/query_dsl/abstractions.ts#L197-L200

func NewWrapperQuery ¶ added in v8.5.0 

func NewWrapperQuery() *WrapperQuery

NewWrapperQuery returns a WrapperQuery.

type XpackDatafeed ¶ added in v8.5.0 

type XpackDatafeed struct {
	Count int64 `json:"count"`
}

XpackDatafeed type.

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L73-L75

func NewXpackDatafeed ¶ added in v8.5.0 

func NewXpackDatafeed() *XpackDatafeed

NewXpackDatafeed returns a XpackDatafeed.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/info/types.ts#L74-L79

func NewXpackFeature ¶ added in v8.5.0 

func NewXpackFeature() *XpackFeature

NewXpackFeature returns a XpackFeature.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L244-L249

func NewXpackQuery ¶ added in v8.5.0 

func NewXpackQuery() *XpackQuery

NewXpackQuery returns a XpackQuery.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L399-L408

func NewXpackRealm ¶ added in v8.5.0 

func NewXpackRealm() *XpackRealm

NewXpackRealm returns a XpackRealm.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L255-L258

func NewXpackRoleMapping ¶ added in v8.5.0 

func NewXpackRoleMapping() *XpackRoleMapping

NewXpackRoleMapping returns a XpackRoleMapping.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/xpack/usage/types.ts#L260-L262

func NewXpackRuntimeFieldTypes ¶ added in v8.5.0 

func NewXpackRuntimeFieldTypes() *XpackRuntimeFieldTypes

NewXpackRuntimeFieldTypes returns a XpackRuntimeFieldTypes.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L186-L207

func NewZeroShotClassificationInferenceOptions ¶ added in v8.5.0 

func NewZeroShotClassificationInferenceOptions() *ZeroShotClassificationInferenceOptions

NewZeroShotClassificationInferenceOptions returns a ZeroShotClassificationInferenceOptions.

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/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ml/_types/inference.ts#L333-L342

func NewZeroShotClassificationInferenceUpdateOptions ¶ added in v8.5.0 

func NewZeroShotClassificationInferenceUpdateOptions() *ZeroShotClassificationInferenceUpdateOptions

NewZeroShotClassificationInferenceUpdateOptions returns a ZeroShotClassificationInferenceUpdateOptions.

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
allocationexplaindecision
Package allocationexplaindecision
 Package allocationexplaindecision
apikeygranttype
Package apikeygranttype
 Package apikeygranttype
appliesto
Package appliesto
 Package appliesto
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
cattrainedmodelscolumn
Package cattrainedmodelscolumn
 Package cattrainedmodelscolumn
cattransformcolumn
Package cattransformcolumn
 Package cattransformcolumn
childscoremode
Package childscoremode
 Package childscoremode
chunkingmode
Package chunkingmode
 Package chunkingmode
clusterprivilege
Package clusterprivilege
 Package clusterprivilege
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
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
deploymentallocationstate
Package deploymentallocationstate
 Package deploymentallocationstate
deploymentassignmentstate
Package deploymentassignmentstate
 Package deploymentassignmentstate
deploymentstate
Package deploymentstate
 Package deploymentstate
deprecationlevel
Package deprecationlevel
 Package deprecationlevel
dfiindependencemeasure
Package dfiindependencemeasure
 Package dfiindependencemeasure
dfraftereffect
Package dfraftereffect
 Package dfraftereffect
dfrbasicmodel
Package dfrbasicmodel
 Package dfrbasicmodel
distanceunit
Package distanceunit
 Package distanceunit
dynamicmapping
Package dynamicmapping
 Package dynamicmapping
edgengramside
Package edgengramside
 Package edgengramside
emailpriority
Package emailpriority
 Package emailpriority
enrichpolicyphase
Package enrichpolicyphase
 Package enrichpolicyphase
excludefrequent
Package excludefrequent
 Package excludefrequent
executionphase
Package executionphase
 Package executionphase
executionstatus
Package executionstatus
 Package executionstatus
expandwildcard
Package expandwildcard
 Package expandwildcard
feature
Package feature
 Package feature
fieldsortnumerictype
Package fieldsortnumerictype
 Package fieldsortnumerictype
fieldtype
Package fieldtype
 Package fieldtype
fieldvaluefactormodifier
Package fieldvaluefactormodifier
 Package fieldvaluefactormodifier
filtertype
Package filtertype
 Package filtertype
followerindexstatus
Package followerindexstatus
 Package followerindexstatus
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
geoorientation
Package geoorientation
 Package geoorientation
geoshaperelation
Package geoshaperelation
 Package geoshaperelation
geostrategy
Package geostrategy
 Package geostrategy
geovalidationmethod
Package geovalidationmethod
 Package geovalidationmethod
granttype
Package granttype
 Package granttype
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
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
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
indicesblockoptions
Package indicesblockoptions
 Package indicesblockoptions
inputtype
Package inputtype
 Package inputtype
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
language
Package language
 Package language
level
Package level
 Package level
licensestatus
Package licensestatus
 Package licensestatus
licensetype
Package licensetype
 Package licensetype
lifecycleoperationmode
Package lifecycleoperationmode
 Package lifecycleoperationmode
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
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
operator
Package operator
 Package operator
optype
Package optype
 Package optype
pagerdutycontexttype
Package pagerdutycontexttype
 Package pagerdutycontexttype
pagerdutyeventtype
Package pagerdutyeventtype
 Package pagerdutyeventtype
phoneticencoder
Package phoneticencoder
 Package phoneticencoder
phoneticlanguage
Package phoneticlanguage
 Package phoneticlanguage
phoneticnametype
Package phoneticnametype
 Package phoneticnametype
phoneticruletype
Package phoneticruletype
 Package phoneticruletype
policytype
Package policytype
 Package policytype
quantifier
Package quantifier
 Package quantifier
rangerelation
Package rangerelation
 Package rangerelation
ratemode
Package ratemode
 Package ratemode
refresh
Package refresh
 Package refresh
responsecontenttype
Package responsecontenttype
 Package responsecontenttype
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
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
statslevel
Package statslevel
 Package statslevel
storagetype
Package storagetype
 Package storagetype
stringdistance
Package stringdistance
 Package stringdistance
suggestmode
Package suggestmode
 Package suggestmode
suggestsort
Package suggestsort
 Package suggestsort
synonymformat
Package synonymformat
 Package synonymformat
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
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
waitforactiveshardoptions
Package waitforactiveshardoptions
 Package waitforactiveshardoptions
waitforevents
Package waitforevents
 Package waitforevents
watchermetric
Package watchermetric
 Package watchermetric
watcherstate
Package watcherstate
 Package watcherstate
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.