avgaggregate.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.


// Code generated from the elasticsearch-specification DO NOT EDIT.
// https://github.com/elastic/elasticsearch-specification/tree/93ed2b29c9e75f49cd340f06286d6ead5965f900


package types

// AvgAggregate type.
//
// https://github.com/elastic/elasticsearch-specification/blob/93ed2b29c9e75f49cd340f06286d6ead5965f900/specification/_types/aggregations/Aggregate.ts#L200-L201
type AvgAggregate struct {
	Meta *Metadata `json:"meta,omitempty"`
	// Value The metric value. A missing value generally means that there was no data to
	// aggregate,
	// unless specified otherwise.
	Value         float64 `json:"value,omitempty"`
	ValueAsString *string `json:"value_as_string,omitempty"`
}

// AvgAggregateBuilder holds AvgAggregate struct and provides a builder API.
type AvgAggregateBuilder struct {
	v *AvgAggregate
}

// NewAvgAggregate provides a builder for the AvgAggregate struct.
func NewAvgAggregateBuilder() *AvgAggregateBuilder {
	r := AvgAggregateBuilder{
		&AvgAggregate{},
	}

	return &r
}

// Build finalize the chain and returns the AvgAggregate struct
func (rb *AvgAggregateBuilder) Build() AvgAggregate {
	return *rb.v
}

func (rb *AvgAggregateBuilder) Meta(meta *MetadataBuilder) *AvgAggregateBuilder {
	v := meta.Build()
	rb.v.Meta = &v
	return rb
}

// Value The metric value. A missing value generally means that there was no data to
// aggregate,
// unless specified otherwise.

func (rb *AvgAggregateBuilder) Value(value float64) *AvgAggregateBuilder {
	rb.v.Value = value
	return rb
}

func (rb *AvgAggregateBuilder) ValueAsString(valueasstring string) *AvgAggregateBuilder {
	rb.v.ValueAsString = &valueasstring
	return rb
}