Skip to content

Commit 1cc18f1

Browse files
authored
Set obsolete warning on GeoShape properties. (#3770)
Addresses: elastic/elasticsearch#35320
1 parent e1343ca commit 1cc18f1

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

src/Nest/Mapping/Types/Geo/GeoShape/GeoShapeProperty.cs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
using System;
12
using System.Diagnostics;
23
using Newtonsoft.Json;
34

@@ -23,6 +24,7 @@ public interface IGeoShapeProperty : IDocValuesProperty
2324
/// noting that large shapes will have greater false positives.
2425
/// </remarks>
2526
[JsonProperty("distance_error_pct")]
27+
[Obsolete("Removed in Elasticsearch 6.6")]
2628
double? DistanceErrorPercentage { get; set; }
2729

2830
/// <summary>
@@ -63,6 +65,7 @@ public interface IGeoShapeProperty : IDocValuesProperty
6365
/// so that geo_shape queries are optimal on a point only field.
6466
/// </summary>
6567
[JsonProperty("points_only")]
68+
[Obsolete("Removed in Elasticsearch 6.6")]
6669
bool? PointsOnly { get; set; }
6770

6871
/// <summary>
@@ -71,6 +74,7 @@ public interface IGeoShapeProperty : IDocValuesProperty
7174
/// the best tree_levels value to honor this precision.
7275
/// </summary>
7376
[JsonProperty("precision")]
77+
[Obsolete("Removed in Elasticsearch 6.6")]
7478
Distance Precision { get; set; }
7579

7680
/// <summary>
@@ -85,6 +89,7 @@ public interface IGeoShapeProperty : IDocValuesProperty
8589
/// Name of the PrefixTree implementation to be used.
8690
/// Defaults to <see cref="GeoTree.Geohash" />
8791
/// </summary>
92+
[Obsolete("Removed in Elasticsearch 6.6")]
8893
[JsonProperty("tree")]
8994
GeoTree? Tree { get; set; }
9095

@@ -96,6 +101,7 @@ public interface IGeoShapeProperty : IDocValuesProperty
96101
/// <see cref="Precision" /> parameter instead.
97102
/// </summary>
98103
[JsonProperty("tree_levels")]
104+
[Obsolete("Removed in Elasticsearch 6.6")]
99105
int? TreeLevels { get; set; }
100106

101107
/// <summary>
@@ -112,6 +118,7 @@ public class GeoShapeProperty : DocValuesPropertyBase, IGeoShapeProperty
112118
public GeoShapeProperty() : base(FieldType.GeoShape) { }
113119

114120
/// <inheritdoc />
121+
[Obsolete("Removed in Elasticsearch 6.6")]
115122
public double? DistanceErrorPercentage { get; set; }
116123

117124
/// <inheritdoc />
@@ -124,18 +131,22 @@ public GeoShapeProperty() : base(FieldType.GeoShape) { }
124131
public GeoOrientation? Orientation { get; set; }
125132

126133
/// <inheritdoc />
134+
[Obsolete("Removed in Elasticsearch 6.6")]
127135
public bool? PointsOnly { get; set; }
128136

129137
/// <inheritdoc />
138+
[Obsolete("Removed in Elasticsearch 6.6")]
130139
public Distance Precision { get; set; }
131140

132141
/// <inheritdoc />
133142
public GeoStrategy? Strategy { get; set; }
134143

135144
/// <inheritdoc />
145+
[Obsolete("Removed in Elasticsearch 6.6")]
136146
public GeoTree? Tree { get; set; }
137147

138148
/// <inheritdoc />
149+
[Obsolete("Removed in Elasticsearch 6.6")]
139150
public int? TreeLevels { get; set; }
140151

141152
/// <inheritdoc />
@@ -150,39 +161,55 @@ public class GeoShapePropertyDescriptor<T>
150161
{
151162
public GeoShapePropertyDescriptor() : base(FieldType.GeoShape) { }
152163

164+
165+
[Obsolete("Removed in Elasticsearch 6.6")]
153166
double? IGeoShapeProperty.DistanceErrorPercentage { get; set; }
154167
bool? IGeoShapeProperty.IgnoreMalformed { get; set; }
155168
bool? IGeoShapeProperty.IgnoreZValue { get; set; }
156169
GeoOrientation? IGeoShapeProperty.Orientation { get; set; }
170+
171+
[Obsolete("Removed in Elasticsearch 6.6")]
157172
bool? IGeoShapeProperty.PointsOnly { get; set; }
173+
174+
[Obsolete("Removed in Elasticsearch 6.6")]
158175
Distance IGeoShapeProperty.Precision { get; set; }
159176
GeoStrategy? IGeoShapeProperty.Strategy { get; set; }
177+
178+
[Obsolete("Removed in Elasticsearch 6.6")]
160179
GeoTree? IGeoShapeProperty.Tree { get; set; }
180+
181+
[Obsolete("Removed in Elasticsearch 6.6")]
161182
int? IGeoShapeProperty.TreeLevels { get; set; }
162183

163184
bool? IGeoShapeProperty.Coerce { get; set; }
164185

165186
/// <inheritdoc cref="IGeoShapeProperty.Tree" />
187+
188+
[Obsolete("Removed in Elasticsearch 6.6")]
166189
public GeoShapePropertyDescriptor<T> Tree(GeoTree? tree) => Assign(tree, (a, v) => a.Tree = v);
167190

168191
/// <inheritdoc cref="IGeoShapeProperty.TreeLevels" />
192+
[Obsolete("Removed in Elasticsearch 6.6")]
169193
public GeoShapePropertyDescriptor<T> TreeLevels(int? treeLevels) => Assign(treeLevels, (a, v) => a.TreeLevels = v);
170194

171195
/// <inheritdoc cref="IGeoShapeProperty.Strategy" />
172196
public GeoShapePropertyDescriptor<T> Strategy(GeoStrategy? strategy) => Assign(strategy, (a, v) => a.Strategy = v);
173197

174198
/// <inheritdoc cref="IGeoShapeProperty.Precision" />
199+
[Obsolete("Removed in Elasticsearch 6.6")]
175200
public GeoShapePropertyDescriptor<T> Precision(double precision, DistanceUnit unit) =>
176201
Assign(new Distance(precision, unit), (a, v) => a.Precision = v);
177202

178203
/// <inheritdoc cref="IGeoShapeProperty.Orientation" />
179204
public GeoShapePropertyDescriptor<T> Orientation(GeoOrientation? orientation) => Assign(orientation, (a, v) => a.Orientation = v);
180205

181206
/// <inheritdoc cref="IGeoShapeProperty.DistanceErrorPercentage" />
207+
[Obsolete("Removed in Elasticsearch 6.6")]
182208
public GeoShapePropertyDescriptor<T> DistanceErrorPercentage(double? distanceErrorPercentage) =>
183209
Assign(distanceErrorPercentage, (a, v) => a.DistanceErrorPercentage = v);
184210

185211
/// <inheritdoc cref="IGeoShapeProperty.PointsOnly" />
212+
[Obsolete("Removed in Elasticsearch 6.6")]
186213
public GeoShapePropertyDescriptor<T> PointsOnly(bool? pointsOnly = true) => Assign(pointsOnly, (a, v) => a.PointsOnly = v);
187214

188215
/// <inheritdoc cref="IGeoShapeProperty.IgnoreMalformed" />

0 commit comments

Comments
 (0)