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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5148,6 +5148,7 @@ A query ID is provided in the ES|QL async query API response for a query that do
A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`.
** *`drop_null_columns` (Optional, boolean)*: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
** *`format` (Optional, Enum("csv" | "json" | "tsv" | "txt" | "yaml" | "cbor" | "smile" | "arrow"))*: A short version of the Accept header, for example `json` or `yaml`.
** *`keep_alive` (Optional, string | -1 | 0)*: The period for which the query and its results are stored in the cluster.
When this period expires, the query and its results are deleted, even if the query is still ongoing.
** *`wait_for_completion_timeout` (Optional, string | -1 | 0)*: The period to wait for the request to finish.
Expand Down
16 changes: 12 additions & 4 deletions src/api/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10642,6 +10642,7 @@ export type EsqlAsyncQueryDeleteResponse = AcknowledgedResponseBase
export interface EsqlAsyncQueryGetRequest extends RequestBase {
id: Id
drop_null_columns?: boolean
format?: EsqlQueryEsqlFormat
keep_alive?: Duration
wait_for_completion_timeout?: Duration
}
Expand Down Expand Up @@ -12070,10 +12071,6 @@ export interface IndicesGetRequest extends RequestBase {

export type IndicesGetResponse = Record<IndexName, IndicesIndexState>

export interface IndicesGetAliasIndexAliases {
aliases: Record<string, IndicesAliasDefinition>
}

export interface IndicesGetAliasRequest extends RequestBase {
name?: Names
index?: Indices
Expand All @@ -12085,6 +12082,17 @@ export interface IndicesGetAliasRequest extends RequestBase {

export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>

export interface IndicesGetAliasIndexAliases {
aliases: Record<string, IndicesAliasDefinition>
}

export interface IndicesGetAliasNotFoundAliasesKeys {
error: string
status: number
}
export type IndicesGetAliasNotFoundAliases = IndicesGetAliasNotFoundAliasesKeys
& { [property: string]: IndicesGetAliasIndexAliases | string | number }

export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName
lifecycle?: IndicesDataStreamLifecycleWithRollover
Expand Down
16 changes: 12 additions & 4 deletions src/api/typesWithBodyKey.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10816,6 +10816,7 @@ export type EsqlAsyncQueryDeleteResponse = AcknowledgedResponseBase
export interface EsqlAsyncQueryGetRequest extends RequestBase {
id: Id
drop_null_columns?: boolean
format?: EsqlQueryEsqlFormat
keep_alive?: Duration
wait_for_completion_timeout?: Duration
}
Expand Down Expand Up @@ -12274,10 +12275,6 @@ export interface IndicesGetRequest extends RequestBase {

export type IndicesGetResponse = Record<IndexName, IndicesIndexState>

export interface IndicesGetAliasIndexAliases {
aliases: Record<string, IndicesAliasDefinition>
}

export interface IndicesGetAliasRequest extends RequestBase {
name?: Names
index?: Indices
Expand All @@ -12289,6 +12286,17 @@ export interface IndicesGetAliasRequest extends RequestBase {

export type IndicesGetAliasResponse = Record<IndexName, IndicesGetAliasIndexAliases>

export interface IndicesGetAliasIndexAliases {
aliases: Record<string, IndicesAliasDefinition>
}

export interface IndicesGetAliasNotFoundAliasesKeys {
error: string
status: number
}
export type IndicesGetAliasNotFoundAliases = IndicesGetAliasNotFoundAliasesKeys
& { [property: string]: IndicesGetAliasIndexAliases | string | number }

export interface IndicesGetDataLifecycleDataStreamWithLifecycle {
name: DataStreamName
lifecycle?: IndicesDataStreamLifecycleWithRollover
Expand Down