You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs
+3-3
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ public sealed class AsyncSearchStatusRequestParameters : RequestParameters
34
34
}
35
35
36
36
/// <summary>
37
-
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
37
+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
@@ -50,7 +50,7 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
50
50
}
51
51
52
52
/// <summary>
53
-
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
53
+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
85
+
/// <para>Retreives the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
/// <para>If the async search completed, this field shows the status code of the search.<br/>For example, 200 indicates that the async search was successfully completed.<br/>503 indicates that the async search was completed with an error.</para>
Copy file name to clipboardExpand all lines: src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs
+3-3
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ public sealed class DeleteAsyncSearchRequestParameters : RequestParameters
34
34
}
35
35
36
36
/// <summary>
37
-
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled.Otherwise, the saved search results are deleted.</para>
37
+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>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 `cancel_task` cluster privilege.</para>
@@ -50,7 +50,7 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
50
50
}
51
51
52
52
/// <summary>
53
-
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled.Otherwise, the saved search results are deleted.</para>
53
+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>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 `cancel_task` cluster privilege.</para>
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled.Otherwise, the saved search results are deleted.</para>
85
+
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>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 `cancel_task` cluster privilege.</para>
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
35
+
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
/// <para>Specify the time that the request should block waiting for the final response</para>
45
+
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
51
+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
@@ -63,7 +63,7 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.
63
63
internaloverrideboolSupportsBody=>false;
64
64
65
65
/// <summary>
66
-
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
66
+
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
/// <para>Specify the time that the request should block waiting for the final response</para>
78
+
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
85
+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
121
+
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
0 commit comments