Skip to content
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,16 @@

namespace Elastic.Clients.Elasticsearch.AsyncSearch;

/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.status.Request']/*"/>
public sealed partial class AsyncSearchStatusRequestParameters : Elastic.Transport.RequestParameters
{
/// <summary>
/// <para>
/// The length of time that the async search needs to be available.
/// Ongoing async searches and any saved search results are deleted after this period.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request#keep_alive']/*"/>
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
}

/// <summary>
/// <para>
/// Get the async search status.
/// </para>
/// <para>
/// Get the status of a previously submitted async search request given its identifier, without retrieving search results.
/// If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
/// </para>
/// <list type="bullet">
/// <item>
/// <para>
/// The user or API key that submitted the original async search request.
/// </para>
/// </item>
/// <item>
/// <para>
/// Users that have the <c>monitor</c> cluster privilege or greater privileges.
/// </para>
/// </item>
/// </list>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.status.Request']/*"/>
[System.Text.Json.Serialization.JsonConverter(typeof(Elastic.Clients.Elasticsearch.AsyncSearch.Json.AsyncSearchStatusRequestConverter))]
public sealed partial class AsyncSearchStatusRequest : Elastic.Clients.Elasticsearch.Requests.PlainRequest<Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestParameters>
{
Expand All @@ -81,43 +59,15 @@ internal AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serialization.Js

internal override string OperationName => "async_search.status";

/// <summary>
/// <para>
/// A unique identifier for the async search.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request#id']/*"/>
public required Elastic.Clients.Elasticsearch.Id Id { get => P<Elastic.Clients.Elasticsearch.Id>("id"); set => PR("id", value); }

/// <summary>
/// <para>
/// The length of time that the async search needs to be available.
/// Ongoing async searches and any saved search results are deleted after this period.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request#keep_alive']/*"/>
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
}

/// <summary>
/// <para>
/// Get the async search status.
/// </para>
/// <para>
/// Get the status of a previously submitted async search request given its identifier, without retrieving search results.
/// If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
/// </para>
/// <list type="bullet">
/// <item>
/// <para>
/// The user or API key that submitted the original async search request.
/// </para>
/// </item>
/// <item>
/// <para>
/// Users that have the <c>monitor</c> cluster privilege or greater privileges.
/// </para>
/// </item>
/// </list>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.status.Request']/*"/>
public readonly partial struct AsyncSearchStatusRequestDescriptor
{
internal Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequest Instance { get; init; }
Expand All @@ -142,23 +92,14 @@ public AsyncSearchStatusRequestDescriptor()
public static explicit operator Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequest instance) => new Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestDescriptor(instance);
public static implicit operator Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestDescriptor descriptor) => descriptor.Instance;

/// <summary>
/// <para>
/// A unique identifier for the async search.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request#id']/*"/>
public Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id value)
{
Instance.Id = value;
return this;
}

/// <summary>
/// <para>
/// The length of time that the async search needs to be available.
/// Ongoing async searches and any saved search results are deleted after this period.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusRequest.g.xml" path="doc/member[@key='async_search.status.Request#keep_alive']/*"/>
public Elastic.Clients.Elasticsearch.AsyncSearch.AsyncSearchStatusRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? value)
{
Instance.KeepAlive = value;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<member key="async_search.status.Request"><summary><para>
Get the async search status.
</para>
<para>
Get the status of a previously submitted async search request given its identifier, without retrieving search results.
If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to:
</para>
<list type="bullet">
<item>
<para>
The user or API key that submitted the original async search request.
</para>
</item>
<item>
<para>
Users that have the <c>monitor</c> cluster privilege or greater privileges.
</para>
</item>
</list></summary></member>
<member key="async_search.status.Request#id"><summary><para>
A unique identifier for the async search.
</para></summary></member>
<member key="async_search.status.Request#keep_alive"><summary><para>
The length of time that the async search needs to be available.
Ongoing async searches and any saved search results are deleted after this period.
</para></summary></member>
</doc>
Original file line number Diff line number Diff line change
Expand Up @@ -37,66 +37,29 @@ internal AsyncSearchStatusResponse(Elastic.Clients.Elasticsearch.Serialization.J
_ = sentinel;
}

/// <summary>
/// <para>
/// Metadata about clusters involved in the cross-cluster search.
/// It is not shown for local-only searches.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#_clusters']/*"/>
public Elastic.Clients.Elasticsearch.ClusterStatistics? Clusters { get; set; }

/// <summary>
/// <para>
/// If the async search completed, this field shows the status code of the search.
/// For example, <c>200</c> indicates that the async search was successfully completed.
/// <c>503</c> indicates that the async search was completed with an error.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#completion_status']/*"/>
public int? CompletionStatus { get; set; }

/// <summary>
/// <para>
/// Indicates when the async search completed.
/// It is present only when the search has completed.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#completion_time']/*"/>
public System.DateTimeOffset? CompletionTime { get; set; }
public System.DateTimeOffset? CompletionTimeInMillis { get; set; }
public Elastic.Clients.Elasticsearch.ErrorCause? Error { get; set; }

/// <summary>
/// <para>
/// Indicates when the async search will expire.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#expiration_time']/*"/>
public System.DateTimeOffset? ExpirationTime { get; set; }
public required System.DateTimeOffset ExpirationTimeInMillis { get; set; }
public string? Id { get; set; }

/// <summary>
/// <para>
/// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
/// While the query is running, <c>is_partial</c> is always set to <c>true</c>.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#is_partial']/*"/>
public required bool IsPartial { get; set; }

/// <summary>
/// <para>
/// Indicates whether the search is still running or has completed.
/// </para>
/// <para>
/// info
/// If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though <c>is_running</c> is <c>false</c>.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#is_running']/*"/>
public required bool IsRunning { get; set; }

/// <summary>
/// <para>
/// The number of shards that have run the query so far.
/// </para>
/// </summary>
/// <include file="AsyncSearchStatusResponse.g.xml" path="doc/member[@key='async_search.status.Response#_shards']/*"/>
public required Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; set; }
public System.DateTimeOffset? StartTime { get; set; }
public required System.DateTimeOffset StartTimeInMillis { get; set; }
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<member key="async_search.status.Response#_clusters"><summary><para>
Metadata about clusters involved in the cross-cluster search.
It is not shown for local-only searches.
</para></summary></member>
<member key="async_search.status.Response#_shards"><summary><para>
The number of shards that have run the query so far.
</para></summary></member>
<member key="async_search.status.Response#completion_status"><summary><para>
If the async search completed, this field shows the status code of the search.
For example, <c>200</c> indicates that the async search was successfully completed.
<c>503</c> indicates that the async search was completed with an error.
</para></summary></member>
<member key="async_search.status.Response#completion_time"><summary><para>
Indicates when the async search completed.
It is present only when the search has completed.
</para></summary></member>
<member key="async_search.status.Response#expiration_time"><summary><para>
Indicates when the async search will expire.
</para></summary></member>
<member key="async_search.status.Response#is_partial"><summary><para>
When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
While the query is running, <c>is_partial</c> is always set to <c>true</c>.
</para></summary></member>
<member key="async_search.status.Response#is_running"><summary><para>
Indicates whether the search is still running or has completed.
</para>
<para>
info
If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though <c>is_running</c> is <c>false</c>.
</para></summary></member>
</doc>
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,14 @@

namespace Elastic.Clients.Elasticsearch.AsyncSearch;

/// <include file="DeleteAsyncSearchRequest.g.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
public sealed partial class DeleteAsyncSearchRequestParameters : Elastic.Transport.RequestParameters
{
}

/// <summary>
/// <para>
/// Delete an async search.
/// </para>
/// <para>
/// If the asynchronous search is still running, it is cancelled.
/// Otherwise, the saved search results are deleted.
/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
/// </para>
/// </summary>
/// <include file="DeleteAsyncSearchRequest.g.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
[System.Text.Json.Serialization.JsonConverter(typeof(Elastic.Clients.Elasticsearch.AsyncSearch.Json.DeleteAsyncSearchRequestConverter))]
public sealed partial class DeleteAsyncSearchRequest : Elastic.Clients.Elasticsearch.Requests.PlainRequest<Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequestParameters>
{
Expand All @@ -63,24 +57,12 @@ internal DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serialization.Js

internal override string OperationName => "async_search.delete";

/// <summary>
/// <para>
/// A unique identifier for the async search.
/// </para>
/// </summary>
/// <include file="DeleteAsyncSearchRequest.g.xml" path="doc/member[@key='async_search.delete.Request#id']/*"/>
public required Elastic.Clients.Elasticsearch.Id Id { get => P<Elastic.Clients.Elasticsearch.Id>("id"); set => PR("id", value); }
}

/// <summary>
/// <para>
/// Delete an async search.
/// </para>
/// <para>
/// If the asynchronous search is still running, it is cancelled.
/// Otherwise, the saved search results are deleted.
/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
/// </para>
/// </summary>
/// <include file="DeleteAsyncSearchRequest.g.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
/// <include file="../../SpecReferences.xml" path="doc/member[@key='async_search.delete.Request']/*"/>
public readonly partial struct DeleteAsyncSearchRequestDescriptor
{
internal Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequest Instance { get; init; }
Expand All @@ -105,11 +87,7 @@ public DeleteAsyncSearchRequestDescriptor()
public static explicit operator Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequest instance) => new Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequestDescriptor(instance);
public static implicit operator Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequestDescriptor descriptor) => descriptor.Instance;

/// <summary>
/// <para>
/// A unique identifier for the async search.
/// </para>
/// </summary>
/// <include file="DeleteAsyncSearchRequest.g.xml" path="doc/member[@key='async_search.delete.Request#id']/*"/>
public Elastic.Clients.Elasticsearch.AsyncSearch.DeleteAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id value)
{
Instance.Id = value;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<member key="async_search.delete.Request"><summary><para>
Delete an async search.
</para>
<para>
If the asynchronous search is still running, it is cancelled.
Otherwise, the saved search results are deleted.
If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
</para></summary></member>
<member key="async_search.delete.Request#id"><summary><para>
A unique identifier for the async search.
</para></summary></member>
</doc>
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ internal DeleteAsyncSearchResponse(Elastic.Clients.Elasticsearch.Serialization.J
_ = sentinel;
}

/// <summary>
/// <para>
/// For a successful response, this value is always true. On failure, an exception is returned instead.
/// </para>
/// </summary>
/// <include file="DeleteAsyncSearchResponse.g.xml" path="doc/member[@key='async_search.delete.Response#acknowledged']/*"/>
public required bool Acknowledged { get; set; }
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<member key="async_search.delete.Response#acknowledged"><summary><para>
For a successful response, this value is always true. On failure, an exception is returned instead.
</para></summary></member>
</doc>
Loading
Loading