Skip to content

[Backport 8.6] Add additional client overloads. #7547

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.

Sign up for GitHub

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 4, 2023
Merged

[Backport 8.6] Add additional client overloads. #7547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion exclusion.dic
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ yyyy
enum
trippable
geotile
yaml
yaml
rethrottle
120 changes: 104 additions & 16 deletions src/Elastic.Clients.Elasticsearch/Client/ElasticsearchClient-Manual.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,131 @@ namespace Elastic.Clients.Elasticsearch;

public partial class ElasticsearchClient
{
/// <summary>
/// <para>Creates a new document in the index.</para>
/// <para>Returns a 409 response when a document with a same ID already exists in the index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual CreateResponse Create<TDocument>(TDocument document, IndexName index, Id id)
{
var descriptor = new CreateRequestDescriptor<TDocument>(document, index, id);
descriptor.BeforeRequest();
return DoRequest<CreateRequestDescriptor<TDocument>, CreateResponse, CreateRequestParameters>(descriptor);
}

/// <summary>
/// <para>Creates a new document in the index.</para>
/// <para>Returns a 409 response when a document with a same ID already exists in the index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<CreateResponse> CreateAsync<TDocument>(TDocument document, IndexName index, Id id, CancellationToken cancellationToken = default)
{
var descriptor = new CreateRequestDescriptor<TDocument>(document, index, id);
descriptor.BeforeRequest();
return DoRequestAsync<CreateRequestDescriptor<TDocument>, CreateResponse, CreateRequestParameters>(descriptor);
}

/// <summary>
/// <para>Creates or updates a document in an index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual IndexResponse Index<TDocument>(TDocument document)
{
var descriptor = new IndexRequestDescriptor<TDocument>(document);
descriptor.BeforeRequest();
return DoRequest<IndexRequestDescriptor<TDocument>, IndexResponse, IndexRequestParameters>(descriptor);
}

/// <summary>
/// <para>Creates or updates a document in an index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual IndexResponse Index<TDocument>(TDocument document, IndexName index)
{
var descriptor = new IndexRequestDescriptor<TDocument>(document, index);
descriptor.BeforeRequest();
return DoRequest<IndexRequestDescriptor<TDocument>, IndexResponse, IndexRequestParameters>(descriptor);
}

/// <summary>
/// <para>Creates or updates a document in an index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<IndexResponse> IndexAsync<TDocument>(TDocument document,CancellationToken cancellationToken = default)
{
var descriptor = new IndexRequestDescriptor<TDocument>(document);
descriptor.BeforeRequest();
return DoRequestAsync<IndexRequestDescriptor<TDocument>, IndexResponse, IndexRequestParameters>(descriptor);
}

/// <summary>
/// <para>Creates or updates a document in an index.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<IndexResponse> IndexAsync<TDocument>(TDocument document, IndexName index, CancellationToken cancellationToken = default)
{
var descriptor = new IndexRequestDescriptor<TDocument>(document, index);
descriptor.BeforeRequest();
return DoRequestAsync<IndexRequestDescriptor<TDocument>, IndexResponse, IndexRequestParameters>(descriptor);
}

/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<UpdateResponse<TDocument>> UpdateAsync<TDocument, TPartialDocument>(IndexName index, Id id, CancellationToken cancellationToken = default)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(index, id);
return DoRequestAsync<UpdateRequestDescriptor<TDocument, TPartialDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor, cancellationToken);
}

/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<UpdateResponse<TDocument>> UpdateAsync<TDocument, TPartialDocument>(IndexName index, Id id, Action<UpdateRequestDescriptor<TDocument, TPartialDocument>> configureRequest, CancellationToken cancellationToken = default)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(index, id);
configureRequest?.Invoke(descriptor);
return DoRequestAsync<UpdateRequestDescriptor<TDocument, TPartialDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor, cancellationToken);
}

// TODO: Test and introduce in a future release
//public virtual Task<UpdateResponse<TDocument>> UpdateAsync<TDocument>(IndexName index, Id id, Action<UpdateRequestDescriptor<TDocument, TDocument>> configureRequest, CancellationToken cancellationToken = default)
//{
// var descriptor = new UpdateRequestDescriptor<TDocument, TDocument>(index, id);
// configureRequest?.Invoke(descriptor);
// return DoRequestAsync<UpdateRequestDescriptor<TDocument, TDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor, cancellationToken);
//}

// TODO: Test and introduce in a future release
//public virtual Task<UpdateResponse<TPartialDocument>> UpdateAsync<TPartialDocument>(IndexName index, Id id, TPartialDocument doc, CancellationToken cancellationToken = default)
//{
// var descriptor = new UpdateRequestDescriptor<TPartialDocument, TPartialDocument>(index, id);
// descriptor.Doc(doc);
// return DoRequestAsync<UpdateRequestDescriptor<TPartialDocument, TPartialDocument>, UpdateResponse<TPartialDocument>, UpdateRequestParameters>(descriptor, cancellationToken);
//}
/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(TDocument document, TPartialDocument partialDocument, IndexName index, Id id)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(document, index, id);
descriptor.BeforeRequest();
return DoRequest<UpdateRequestDescriptor<TDocument, TPartialDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor);
}

// TODO - Add methods to infer index and/or ID + use expressions as we know the document type.
/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual Task<UpdateResponse<TDocument>> UpdateAsync<TDocument, TPartialDocument>(TDocument document, TPartialDocument partialDocument, IndexName index, Id id, CancellationToken cancellationToken = default)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(document, index, id);
descriptor.BeforeRequest();
return DoRequestAsync<UpdateRequestDescriptor<TDocument, TPartialDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor);
}

/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(IndexName index, Id id)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(index, id);
return DoRequest<UpdateRequestDescriptor<TDocument, TPartialDocument>, UpdateResponse<TDocument>, UpdateRequestParameters>(descriptor);
}

/// <summary>
/// <para>Updates a document with a script or partial document.</para>
/// <para><see href="https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html">Learn more about this API in the Elasticsearch documentation.</see></para>
/// </summary>
public virtual UpdateResponse<TDocument> Update<TDocument, TPartialDocument>(IndexName index, Id id, Action<UpdateRequestDescriptor<TDocument, TPartialDocument>> configureRequest)
{
var descriptor = new UpdateRequestDescriptor<TDocument, TPartialDocument>(index, id);
Expand Down
Loading