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
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ public final Time masterTimeout() {
}

/**
* Comma-separated list of component template names used to limit the request.
* Wildcard (<code>*</code>) expressions are supported.
* Name of component template to retrieve. Wildcard (<code>*</code>) expressions
* are supported.
* <p>
* API name: {@code name}
*/
Expand Down Expand Up @@ -254,8 +254,8 @@ public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> f
}

/**
* Comma-separated list of component template names used to limit the request.
* Wildcard (<code>*</code>) expressions are supported.
* Name of component template to retrieve. Wildcard (<code>*</code>) expressions
* are supported.
* <p>
* API name: {@code name}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,7 @@ public static HealthRequest of(Function<Builder, ObjectBuilder<HealthRequest>> f
}

/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
* Expand wildcard expression to concrete indices that are open, closed or both.
* <p>
* API name: {@code expand_wildcards}
*/
Expand All @@ -153,10 +152,10 @@ public final List<ExpandWildcard> expandWildcards() {
}

/**
* Comma-separated list of data streams, indices, and index aliases used to
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
* target all data streams and indices in a cluster, omit this parameter or use
* _all or <code>*</code>.
* A comma-separated list of data streams, indices, and index aliases that limit
* the request. Wildcard expressions (<code>*</code>) are supported. To target
* all data streams and indices in a cluster, omit this parameter or use _all or
* <code>*</code>.
* <p>
* API name: {@code index}
*/
Expand All @@ -165,8 +164,7 @@ public final List<String> index() {
}

/**
* Can be one of cluster, indices or shards. Controls the details level of the
* health information returned.
* Return health information at a specific level of detail.
* <p>
* API name: {@code level}
*/
Expand All @@ -176,8 +174,8 @@ public final Level level() {
}

/**
* If true, the request retrieves information from the local node only. Defaults
* to false, which means information is retrieved from the master node.
* If true, retrieve information from the local node only. If false, retrieve
* information from the master node.
* <p>
* API name: {@code local}
*/
Expand All @@ -187,7 +185,7 @@ public final Boolean local() {
}

/**
* Period to wait for a connection to the master node. If no response is
* The period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
* <p>
* API name: {@code master_timeout}
Expand All @@ -198,8 +196,8 @@ public final Time masterTimeout() {
}

/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error.
* <p>
* API name: {@code timeout}
*/
Expand All @@ -209,8 +207,8 @@ public final Time timeout() {
}

/**
* A number controlling to how many active shards to wait for, all to wait for
* all shards in the cluster to be active, or 0 to not wait.
* Wait for the specified number of active shards. Use <code>all</code> to wait
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
* <p>
* API name: {@code wait_for_active_shards}
*/
Expand All @@ -220,8 +218,7 @@ public final WaitForActiveShards waitForActiveShards() {
}

/**
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all
* currently queued events with the given priority are processed.
* Wait until all currently queued events with the given priority are processed.
* <p>
* API name: {@code wait_for_events}
*/
Expand All @@ -231,9 +228,8 @@ public final WaitForEvents waitForEvents() {
}

/**
* A boolean value which controls whether to wait (until the timeout provided)
* for the cluster to have no shard initializations. Defaults to false, which
* means it will not wait for initializing shards.
* Wait (until the timeout expires) for the cluster to have no shard
* initializations. If false, the request does not wait for initializing shards.
* <p>
* API name: {@code wait_for_no_initializing_shards}
*/
Expand All @@ -243,9 +239,8 @@ public final Boolean waitForNoInitializingShards() {
}

/**
* A boolean value which controls whether to wait (until the timeout provided)
* for the cluster to have no shard relocations. Defaults to false, which means
* it will not wait for relocating shards.
* Wait (until the timeout expires) for the cluster to have no shard
* relocations. If false, the request not wait for relocating shards.
* <p>
* API name: {@code wait_for_no_relocating_shards}
*/
Expand All @@ -255,9 +250,10 @@ public final Boolean waitForNoRelocatingShards() {
}

/**
* The request waits until the specified number N of nodes is available. It also
* accepts &gt;=N, &lt;=N, &gt;N and &lt;N. Alternatively, it is possible to use
* ge(N), le(N), gt(N) and lt(N) notation.
* Wait until the specified number (N) of nodes is available. It also accepts
* <code>&gt;=N</code>, <code>&lt;=N</code>, <code>&gt;N</code> and
* <code>&lt;N</code>. Alternatively, use the notations <code>ge(N)</code>,
* <code>le(N)</code>, <code>gt(N)</code>, and <code>lt(N)</code>.
* <p>
* API name: {@code wait_for_nodes}
*/
Expand All @@ -267,9 +263,10 @@ public final String waitForNodes() {
}

/**
* One of green, yellow or red. Will wait (until the timeout provided) until the
* status of the cluster changes to the one provided or better, i.e. green &gt;
* yellow &gt; red. By default, will not wait for any status.
* Wait (until the timeout expires) for the cluster to reach a specific health
* status (or a better status). A green status is better than yellow and yellow
* is better than red. By default, the request does not wait for a particular
* status.
* <p>
* API name: {@code wait_for_status}
*/
Expand Down Expand Up @@ -322,8 +319,7 @@ public static class Builder extends RequestBase.AbstractBuilder<Builder> impleme
private HealthStatus waitForStatus;

/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
* Expand wildcard expression to concrete indices that are open, closed or both.
* <p>
* API name: {@code expand_wildcards}
* <p>
Expand All @@ -335,8 +331,7 @@ public final Builder expandWildcards(List<ExpandWildcard> list) {
}

/**
* Whether to expand wildcard expression to concrete indices that are open,
* closed or both.
* Expand wildcard expression to concrete indices that are open, closed or both.
* <p>
* API name: {@code expand_wildcards}
* <p>
Expand All @@ -348,10 +343,10 @@ public final Builder expandWildcards(ExpandWildcard value, ExpandWildcard... val
}

/**
* Comma-separated list of data streams, indices, and index aliases used to
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
* target all data streams and indices in a cluster, omit this parameter or use
* _all or <code>*</code>.
* A comma-separated list of data streams, indices, and index aliases that limit
* the request. Wildcard expressions (<code>*</code>) are supported. To target
* all data streams and indices in a cluster, omit this parameter or use _all or
* <code>*</code>.
* <p>
* API name: {@code index}
* <p>
Expand All @@ -363,10 +358,10 @@ public final Builder index(List<String> list) {
}

/**
* Comma-separated list of data streams, indices, and index aliases used to
* limit the request. Wildcard expressions (<code>*</code>) are supported. To
* target all data streams and indices in a cluster, omit this parameter or use
* _all or <code>*</code>.
* A comma-separated list of data streams, indices, and index aliases that limit
* the request. Wildcard expressions (<code>*</code>) are supported. To target
* all data streams and indices in a cluster, omit this parameter or use _all or
* <code>*</code>.
* <p>
* API name: {@code index}
* <p>
Expand All @@ -378,8 +373,7 @@ public final Builder index(String value, String... values) {
}

/**
* Can be one of cluster, indices or shards. Controls the details level of the
* health information returned.
* Return health information at a specific level of detail.
* <p>
* API name: {@code level}
*/
Expand All @@ -389,8 +383,8 @@ public final Builder level(@Nullable Level value) {
}

/**
* If true, the request retrieves information from the local node only. Defaults
* to false, which means information is retrieved from the master node.
* If true, retrieve information from the local node only. If false, retrieve
* information from the master node.
* <p>
* API name: {@code local}
*/
Expand All @@ -400,7 +394,7 @@ public final Builder local(@Nullable Boolean value) {
}

/**
* Period to wait for a connection to the master node. If no response is
* The period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
* <p>
* API name: {@code master_timeout}
Expand All @@ -411,7 +405,7 @@ public final Builder masterTimeout(@Nullable Time value) {
}

/**
* Period to wait for a connection to the master node. If no response is
* The period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
* <p>
* API name: {@code master_timeout}
Expand All @@ -421,8 +415,8 @@ public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> f
}

/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error.
* <p>
* API name: {@code timeout}
*/
Expand All @@ -432,8 +426,8 @@ public final Builder timeout(@Nullable Time value) {
}

/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
* The period to wait for a response. If no response is received before the
* timeout expires, the request fails and returns an error.
* <p>
* API name: {@code timeout}
*/
Expand All @@ -442,8 +436,8 @@ public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
}

/**
* A number controlling to how many active shards to wait for, all to wait for
* all shards in the cluster to be active, or 0 to not wait.
* Wait for the specified number of active shards. Use <code>all</code> to wait
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
* <p>
* API name: {@code wait_for_active_shards}
*/
Expand All @@ -453,8 +447,8 @@ public final Builder waitForActiveShards(@Nullable WaitForActiveShards value) {
}

/**
* A number controlling to how many active shards to wait for, all to wait for
* all shards in the cluster to be active, or 0 to not wait.
* Wait for the specified number of active shards. Use <code>all</code> to wait
* for all shards in the cluster to be active. Use <code>0</code> to not wait.
* <p>
* API name: {@code wait_for_active_shards}
*/
Expand All @@ -464,8 +458,7 @@ public final Builder waitForActiveShards(
}

/**
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all
* currently queued events with the given priority are processed.
* Wait until all currently queued events with the given priority are processed.
* <p>
* API name: {@code wait_for_events}
*/
Expand All @@ -475,9 +468,8 @@ public final Builder waitForEvents(@Nullable WaitForEvents value) {
}

/**
* A boolean value which controls whether to wait (until the timeout provided)
* for the cluster to have no shard initializations. Defaults to false, which
* means it will not wait for initializing shards.
* Wait (until the timeout expires) for the cluster to have no shard
* initializations. If false, the request does not wait for initializing shards.
* <p>
* API name: {@code wait_for_no_initializing_shards}
*/
Expand All @@ -487,9 +479,8 @@ public final Builder waitForNoInitializingShards(@Nullable Boolean value) {
}

/**
* A boolean value which controls whether to wait (until the timeout provided)
* for the cluster to have no shard relocations. Defaults to false, which means
* it will not wait for relocating shards.
* Wait (until the timeout expires) for the cluster to have no shard
* relocations. If false, the request not wait for relocating shards.
* <p>
* API name: {@code wait_for_no_relocating_shards}
*/
Expand All @@ -499,9 +490,10 @@ public final Builder waitForNoRelocatingShards(@Nullable Boolean value) {
}

/**
* The request waits until the specified number N of nodes is available. It also
* accepts &gt;=N, &lt;=N, &gt;N and &lt;N. Alternatively, it is possible to use
* ge(N), le(N), gt(N) and lt(N) notation.
* Wait until the specified number (N) of nodes is available. It also accepts
* <code>&gt;=N</code>, <code>&lt;=N</code>, <code>&gt;N</code> and
* <code>&lt;N</code>. Alternatively, use the notations <code>ge(N)</code>,
* <code>le(N)</code>, <code>gt(N)</code>, and <code>lt(N)</code>.
* <p>
* API name: {@code wait_for_nodes}
*/
Expand All @@ -511,9 +503,10 @@ public final Builder waitForNodes(@Nullable String value) {
}

/**
* One of green, yellow or red. Will wait (until the timeout provided) until the
* status of the cluster changes to the one provided or better, i.e. green &gt;
* yellow &gt; red. By default, will not wait for any status.
* Wait (until the timeout expires) for the cluster to reach a specific health
* status (or a better status). A green status is better than yellow and yellow
* is better than red. By default, the request does not wait for a particular
* status.
* <p>
* API name: {@code wait_for_status}
*/
Expand Down
Loading