Skip to content

Address 9.0-preview feedback #8497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,19 @@ new SearchRequest
};
```

Previously required methods like e.g. `TryGet<TVariant>(out)` have been removed.

The new recommended way of inspecting container types is to use simple pattern matching:

```csharp
var query = new Query();

if (query.Nested is { } nested)
{
// We have a nested query.
}
```

#### 2. Removal of certain generic request descriptors [2-removal-of-certain-generic-request-descriptors]

**Impact**: High.
Expand Down Expand Up @@ -199,6 +212,16 @@ These values have not been used for some time.

#### 9. `FieldSort` [9-fieldsort]

**Impact**: High.

Removed `FieldSort` parameterless constructor.

Please use the new constructor instead:

```csharp
public FieldSort(Elastic.Clients.Elasticsearch.Field field)
```

**Impact**: Low.

Removed static `FieldSort.Empty` member.
Expand Down
13 changes: 13 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,19 @@ var agg = new Aggregation
};
```

Previously required methods like e.g. `TryGet<TVariant>(out)` have been removed.

The new recommended way of inspecting container types is to use simple pattern matching:

```csharp
var query = new Query();

if (query.Nested is { } nested)
{
// We have a nested query.
}
```

:::{warning}

A container can still only contain a single variant. Setting multiple variants at once is invalid.
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ Known issues are significant defects or limitations that may impact your impleme

:::

_No known issues_
Known issues are tracked on [GitHub](https://github.com/elastic/elasticsearch-net/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22Category%3A%20Bug%22).
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,14 @@ public virtual Elastic.Clients.Elasticsearch.Cluster.HealthResponse Health(Elast
return DoRequest<Elastic.Clients.Elasticsearch.Cluster.HealthRequest, Elastic.Clients.Elasticsearch.Cluster.HealthResponse, Elastic.Clients.Elasticsearch.Cluster.HealthRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.Cluster.HealthResponse Health<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.Cluster.HealthRequest, Elastic.Clients.Elasticsearch.Cluster.HealthResponse, Elastic.Clients.Elasticsearch.Cluster.HealthRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.Cluster.HealthResponse Health<TDocument>(System.Action<Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -446,6 +454,14 @@ public virtual Elastic.Clients.Elasticsearch.Cluster.HealthResponse Health<TDocu
return DoRequestAsync<Elastic.Clients.Elasticsearch.Cluster.HealthRequest, Elastic.Clients.Elasticsearch.Cluster.HealthResponse, Elastic.Clients.Elasticsearch.Cluster.HealthRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.Cluster.HealthResponse> HealthAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.Cluster.HealthRequest, Elastic.Clients.Elasticsearch.Cluster.HealthResponse, Elastic.Clients.Elasticsearch.Cluster.HealthRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.Cluster.HealthResponse> HealthAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.Cluster.HealthRequestDescriptor<TDocument>();
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemory
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequest, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse EstimateModelMemory<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequest, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse EstimateModelMemory<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -805,6 +813,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemory
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequest, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse> EstimateModelMemoryAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequest, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse, Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryResponse> EstimateModelMemoryAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.EstimateModelMemoryRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -902,6 +918,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAna
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse ExplainDataFrameAnalytics<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -960,6 +984,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAna
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse> ExplainDataFrameAnalyticsAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsResponse> ExplainDataFrameAnalyticsAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ExplainDataFrameAnalyticsRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -2770,6 +2802,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAna
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse PreviewDataFrameAnalytics<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -2828,6 +2868,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAna
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse> PreviewDataFrameAnalyticsAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequest, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse, Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsResponse> PreviewDataFrameAnalyticsAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.PreviewDataFrameAnalyticsRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -4157,6 +4205,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse Va
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequest, Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse, Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse Validate<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequest, Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse, Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse Validate<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -4189,6 +4245,14 @@ public virtual Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse Va
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequest, Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse, Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse> ValidateAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequest, Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse, Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.MachineLearning.ValidateResponse> ValidateAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.MachineLearning.ValidateRequestDescriptor<TDocument>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,14 @@ public virtual Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse Stats(Elas
return DoRequest<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequest, Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse, Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse Stats<TDocument>()
{
var builder = new Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequest<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequest, Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse, Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestParameters>(request);
}

public virtual Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse Stats<TDocument>(System.Action<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>> action)
{
var builder = new Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>();
Expand Down Expand Up @@ -708,6 +716,14 @@ public virtual Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse Stats<TDoc
return DoRequestAsync<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequest, Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse, Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse> StatsAsync<TDocument>(System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>();
var request = builder.Instance;
request.BeforeRequest();
return DoRequestAsync<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequest, Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse, Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestParameters>(request, cancellationToken);
}

public virtual System.Threading.Tasks.Task<Elastic.Clients.Elasticsearch.Nodes.NodesStatsResponse> StatsAsync<TDocument>(System.Action<Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>> action, System.Threading.CancellationToken cancellationToken = default)
{
var builder = new Elastic.Clients.Elasticsearch.Nodes.NodesStatsRequestDescriptor<TDocument>();
Expand Down
Loading
Loading