/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* 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.
*/
using System.Runtime.Serialization;
using OpenSearch.Net;
namespace OpenSearch.Client
{
///
/// Define the type of field content.
///
[StringEnum]
public enum FieldType
{
///
/// Default. Will be defined by the type of property return.
///
[EnumMember(Value = "none")]
None,
[EnumMember(Value = "geo_point")]
GeoPoint,
[EnumMember(Value = "geo_shape")]
GeoShape,
///
/// An ip mapping type allows to store ipv4 addresses in a numeric form allowing to easily sort, and range query it (using ip values).
///
[EnumMember(Value = "ip")]
Ip,
///
/// The binary type is a base64 representation of binary data that can be stored in the index.
///
[EnumMember(Value = "binary")]
Binary,
[EnumMember(Value = "keyword")]
Keyword,
[EnumMember(Value = "text")]
Text,
///
/// A text-like field that is optimized to provide out-of-the-box support for queries that serve an as-you-type completion use case.
///
[EnumMember(Value = "search_as_you_type")]
SearchAsYouType,
[EnumMember(Value = "date")]
Date,
[EnumMember(Value = "date_nanos")]
DateNanos,
[EnumMember(Value = "boolean")]
Boolean,
[EnumMember(Value = "completion")]
Completion,
[EnumMember(Value = "nested")]
Nested,
///
/// object type, no need to set this manually if its not a value type this will be set.
/// Only set this if you need to force a value type to be mapped to an OpenSearch object type.
///
[EnumMember(Value = "object")]
Object,
///
/// Murmur hash type, for use with the cardinality aggregation.
///
[EnumMember(Value = "murmur3")]
Murmur3Hash,
[EnumMember(Value = "token_count")]
TokenCount,
[EnumMember(Value = "percolator")]
Percolator,
[EnumMember(Value = "integer")]
Integer,
[EnumMember(Value = "long")]
Long,
[EnumMember(Value = "short")]
Short,
[EnumMember(Value = "byte")]
Byte,
[EnumMember(Value = "float")]
Float,
[EnumMember(Value = "half_float")]
HalfFloat,
[EnumMember(Value = "scaled_float")]
ScaledFloat,
[EnumMember(Value = "double")]
Double,
[EnumMember(Value = "integer_range")]
IntegerRange,
[EnumMember(Value = "float_range")]
FloatRange,
[EnumMember(Value = "long_range")]
LongRange,
[EnumMember(Value = "double_range")]
DoubleRange,
[EnumMember(Value = "date_range")]
DateRange,
[EnumMember(Value = "ip_range")]
IpRange,
[EnumMember(Value = "alias")]
Alias,
[EnumMember(Value = "join")]
Join,
[EnumMember(Value = "rank_feature")]
RankFeature,
[EnumMember(Value = "rank_features")]
RankFeatures,
[EnumMember(Value = "knn_vector")]
KnnVector
}
}