Skip to content

Commit

Permalink
[codegen] update to latest spec
Browse files Browse the repository at this point in the history
  • Loading branch information
l-trotta committed Dec 17, 2024
1 parent dae1f43 commit 5c44c85
Show file tree
Hide file tree
Showing 135 changed files with 6,370 additions and 1,744 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,7 @@ public final CompletableFuture<ClosePointInTimeResponse> closePointInTime(
// ----- Endpoint: count

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
Expand All @@ -517,7 +517,7 @@ public CompletableFuture<CountResponse> count(CountRequest request) {
}

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -533,7 +533,7 @@ public final CompletableFuture<CountResponse> count(
}

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
Expand Down Expand Up @@ -1151,7 +1151,34 @@ public final <TDocument> CompletableFuture<GetSourceResponse<TDocument>> getSour
// ----- Endpoint: health_report

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
Expand All @@ -1166,7 +1193,34 @@ public CompletableFuture<HealthReportResponse> healthReport(HealthReportRequest
}

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -1182,7 +1236,34 @@ public final CompletableFuture<HealthReportResponse> healthReport(
}

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
Expand Down Expand Up @@ -1814,7 +1895,7 @@ public final CompletableFuture<OpenPointInTimeResponse> openPointInTime(
// ----- Endpoint: ping

/**
* Ping the cluster. Returns whether the cluster is running.
* Ping the cluster. Get information about whether the cluster is running.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ public final ClosePointInTimeResponse closePointInTime(
// ----- Endpoint: count

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
Expand All @@ -522,7 +522,7 @@ public CountResponse count(CountRequest request) throws IOException, Elasticsear
}

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -538,7 +538,7 @@ public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<Co
}

/**
* Returns number of documents matching a query.
* Count search results. Get the number of documents matching a query.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html">Documentation
Expand Down Expand Up @@ -1168,7 +1168,34 @@ public final <TDocument> GetSourceResponse<TDocument> getSource(
// ----- Endpoint: health_report

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
Expand All @@ -1183,7 +1210,34 @@ public HealthReportResponse healthReport(HealthReportRequest request) throws IOE
}

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @param fn
* a function that initializes a builder to create the
Expand All @@ -1200,7 +1254,34 @@ public final HealthReportResponse healthReport(
}

/**
* Returns the health of the cluster.
* Get the cluster health. Get a report with the health status of an
* Elasticsearch cluster. The report contains a list of indicators that compose
* Elasticsearch functionality.
* <p>
* Each indicator has a health status of: green, unknown, yellow or red. The
* indicator will provide an explanation and metadata describing the reason for
* its current health status.
* <p>
* The cluster’s status is controlled by the worst indicator status.
* <p>
* In the event that an indicator’s status is non-green, a list of impacts may
* be present in the indicator result which detail the functionalities that are
* negatively affected by the health issue. Each impact carries with it a
* severity level, an area of the system that is affected, and a simple
* description of the impact on the system.
* <p>
* Some health indicators can determine the root cause of a health problem and
* prescribe a set of steps that can be performed in order to improve the health
* of the system. The root cause and remediation steps are encapsulated in a
* diagnosis. A diagnosis contains a cause detailing a root cause analysis, an
* action containing a brief description of the steps to take to fix the
* problem, the list of affected resources (if applicable), and a detailed
* step-by-step troubleshooting guide to fix the diagnosed problem.
* <p>
* NOTE: The health indicators perform root cause analysis of non-green health
* statuses. This can be computationally expensive when called frequently. When
* setting up automated polling of the API for health status, set verbose to
* false to disable the more expensive analysis logic.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html">Documentation
Expand Down Expand Up @@ -1842,7 +1923,7 @@ public final OpenPointInTimeResponse openPointInTime(
// ----- Endpoint: ping

/**
* Ping the cluster. Returns whether the cluster is running.
* Ping the cluster. Get information about whether the cluster is running.
*
* @see <a href=
* "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html">Documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,13 @@
// typedef: cluster.allocation_explain.Request

/**
* Provides explanations for shard allocations in the cluster.
* Explain the shard allocations. Get explanations for shard allocations in the
* cluster. For unassigned shards, it provides an explanation for why the shard
* is unassigned. For assigned shards, it provides an explanation for why the
* shard is remaining on its current node and has not moved or rebalanced to
* another node. This API can be very useful when attempting to diagnose why a
* shard is unassigned or why a shard continues to remain on its current node
* when you might expect otherwise.
*
* @see <a href=
* "../doc-files/api-spec.html#cluster.allocation_explain.Request">API
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,9 @@
// typedef: cluster.stats.Request

/**
* Returns cluster statistics. It returns basic index metrics (shard numbers,
* store size, memory usage) and information about the current nodes that form
* the cluster (number, roles, os, jvm versions, memory usage, cpu and installed
* plugins).
* Get cluster statistics. Get basic index metrics (shard numbers, store size,
* memory usage) and information about the current nodes that form the cluster
* (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
*
* @see <a href="../doc-files/api-spec.html#cluster.stats.Request">API
* specification</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@
// typedef: cluster.delete_voting_config_exclusions.Request

/**
* Clears cluster voting config exclusions.
* Clear cluster voting config exclusions. Remove master-eligible nodes from the
* voting configuration exclusion list.
*
* @see <a href=
* "../doc-files/api-spec.html#cluster.delete_voting_config_exclusions.Request">API
Expand Down
Loading

0 comments on commit 5c44c85

Please sign in to comment.