Skip to content

Commit

Permalink
Fix javadoc
Browse files Browse the repository at this point in the history 
Signed-off-by: Thomas Farr <[email protected]>
  • Loading branch information
@Xtansia
Xtansia committed Aug 2, 2024
1 parent 2ad0a42 commit 36dfe94
Show file tree
Hide file tree
Showing 6 changed files with 121 additions and 41 deletions.
8 changes: 6 additions & 2 deletions .../src/generated/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,10 @@ protected AcknowledgedResponseBase(AbstractBuilder<?> builder) {
}

/**
* Required - For a successful response, this value is always true. On failure, an exception is returned instead.<br/>
* Required - For a successful response, this value is always true. On failure, an exception is returned instead.
* <p>
* API name: {@code acknowledged}
* </p>
*/
public final boolean acknowledged() {
return this.acknowledged;
Expand Down Expand Up @@ -88,8 +90,10 @@ protected abstract static class AbstractBuilder<BuilderT extends AbstractBuilder
private Boolean acknowledged;

/**
* Required - For a successful response, this value is always true. On failure, an exception is returned instead.<br/>
* Required - For a successful response, this value is always true. On failure, an exception is returned instead.
* <p>
* API name: {@code acknowledged}
* </p>
*/
public final BuilderT acknowledged(boolean value) {
this.acknowledged = value;
Expand Down
24 changes: 18 additions & 6 deletions java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,10 @@ public final ErrorCause causedBy() {
}

/**
* A human-readable explanation of the error, in english<br/>
* A human-readable explanation of the error, in english
* <p>
* API name: {@code reason}
* </p>
*/
@Nullable
public final String reason() {
Expand All @@ -118,8 +120,10 @@ public final List<ErrorCause> rootCause() {
}

/**
* The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.<br/>
* The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.
* <p>
* API name: {@code stack_trace}
* </p>
*/
@Nullable
public final String stackTrace() {
Expand All @@ -134,8 +138,10 @@ public final List<ErrorCause> suppressed() {
}

/**
* Required - The type of error<br/>
* Required - The type of error
* <p>
* API name: {@code type}
* </p>
*/
public final String type() {
return this.type;
Expand Down Expand Up @@ -246,8 +252,10 @@ public final Builder causedBy(Function<ErrorCause.Builder, ObjectBuilder<ErrorCa
}

/**
* A human-readable explanation of the error, in english<br/>
* A human-readable explanation of the error, in english
* <p>
* API name: {@code reason}
* </p>
*/
public final Builder reason(@Nullable String value) {
this.reason = value;
Expand Down Expand Up @@ -290,8 +298,10 @@ public final Builder rootCause(Function<ErrorCause.Builder, ObjectBuilder<ErrorC
}

/**
* The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.<br/>
* The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.
* <p>
* API name: {@code stack_trace}
* </p>
*/
public final Builder stackTrace(@Nullable String value) {
this.stackTrace = value;
Expand Down Expand Up @@ -334,8 +344,10 @@ public final Builder suppressed(Function<ErrorCause.Builder, ObjectBuilder<Error
}

/**
* Required - The type of error<br/>
* Required - The type of error
* <p>
* API name: {@code type}
* </p>
*/
public final Builder type(String value) {
this.type = value;
Expand Down
24 changes: 18 additions & 6 deletions java-client/src/generated/java/org/opensearch/client/opensearch/_types/NodeStatistics.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,10 @@ public static NodeStatistics of(Function<NodeStatistics.Builder, ObjectBuilder<N

/**
* Required - Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or
* failure is included in the response.<br/>
* failure is included in the response.
* <p>
* API name: {@code failed}
* </p>
*/
public final int failed() {
return this.failed;
Expand All @@ -95,16 +97,20 @@ public final List<ErrorCause> failures() {
}

/**
* Required - Number of nodes that responded successfully to the request.<br/>
* Required - Number of nodes that responded successfully to the request.
* <p>
* API name: {@code successful}
* </p>
*/
public final int successful() {
return this.successful;
}

/**
* Required - Total number of nodes selected by the request.<br/>
* Required - Total number of nodes selected by the request.
* <p>
* API name: {@code total}
* </p>
*/
public final int total() {
return this.total;
Expand Down Expand Up @@ -157,8 +163,10 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder<N

/**
* Required - Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or
* failure is included in the response.<br/>
* failure is included in the response.
* <p>
* API name: {@code failed}
* </p>
*/
public final Builder failed(int value) {
this.failed = value;
Expand Down Expand Up @@ -201,17 +209,21 @@ public final Builder failures(Function<ErrorCause.Builder, ObjectBuilder<ErrorCa
}

/**
* Required - Number of nodes that responded successfully to the request.<br/>
* Required - Number of nodes that responded successfully to the request.
* <p>
* API name: {@code successful}
* </p>
*/
public final Builder successful(int value) {
this.successful = value;
return this;
}

/**
* Required - Total number of nodes selected by the request.<br/>
* Required - Total number of nodes selected by the request.
* <p>
* API name: {@code total}
* </p>
*/
public final Builder total(int value) {
this.total = value;
Expand Down
52 changes: 39 additions & 13 deletions ...ed/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,33 +89,41 @@ public static DeleteDanglingIndexRequest of(
}

/**
* Required - Must be set to true in order to delete the dangling index<br/>
* Required - Must be set to true in order to delete the dangling index
* <p>
* API name: {@code accept_data_loss}
* </p>
*/
public final boolean acceptDataLoss() {
return this.acceptDataLoss;
}

/**
* Operation timeout for connection to cluster-manager node.<br/>
* Operation timeout for connection to cluster-manager node.
* <p>
* API name: {@code cluster_manager_timeout}
* </p>
*/
@Nullable
public final Time clusterManagerTimeout() {
return this.clusterManagerTimeout;
}

/**
* Required - The UUID of the dangling index<br/>
* Required - The UUID of the dangling index
* <p>
* API name: {@code index_uuid}
* </p>
*/
public final String indexUuid() {
return this.indexUuid;
}

/**
* Specify timeout for connection to master<br/>
* Specify timeout for connection to master
* <p>
* API name: {@code master_timeout}
* </p>
*/
@Deprecated
@Nullable
Expand All @@ -124,8 +132,10 @@ public final Time masterTimeout() {
}

/**
* Explicit operation timeout<br/>
* Explicit operation timeout
* <p>
* API name: {@code timeout}
* </p>
*/
@Nullable
public final Time timeout() {
Expand All @@ -148,43 +158,53 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder<D
private Time timeout;

/**
* Required - Must be set to true in order to delete the dangling index<br/>
* Required - Must be set to true in order to delete the dangling index
* <p>
* API name: {@code accept_data_loss}
* </p>
*/
public final Builder acceptDataLoss(boolean value) {
this.acceptDataLoss = value;
return this;
}

/**
* Operation timeout for connection to cluster-manager node.<br/>
* Operation timeout for connection to cluster-manager node.
* <p>
* API name: {@code cluster_manager_timeout}
* </p>
*/
public final Builder clusterManagerTimeout(@Nullable Time value) {
this.clusterManagerTimeout = value;
return this;
}

/**
* Operation timeout for connection to cluster-manager node.<br/>
* Operation timeout for connection to cluster-manager node.
* <p>
* API name: {@code cluster_manager_timeout}
* </p>
*/
public final Builder clusterManagerTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
return clusterManagerTimeout(fn.apply(new Time.Builder()).build());
}

/**
* Required - The UUID of the dangling index<br/>
* Required - The UUID of the dangling index
* <p>
* API name: {@code index_uuid}
* </p>
*/
public final Builder indexUuid(String value) {
this.indexUuid = value;
return this;
}

/**
* Specify timeout for connection to master<br/>
* Specify timeout for connection to master
* <p>
* API name: {@code master_timeout}
* </p>
*/
@Deprecated
public final Builder masterTimeout(@Nullable Time value) {
Expand All @@ -193,26 +213,32 @@ public final Builder masterTimeout(@Nullable Time value) {
}

/**
* Specify timeout for connection to master<br/>
* Specify timeout for connection to master
* <p>
* API name: {@code master_timeout}
* </p>
*/
@Deprecated
public final Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
return masterTimeout(fn.apply(new Time.Builder()).build());
}

/**
* Explicit operation timeout<br/>
* Explicit operation timeout
* <p>
* API name: {@code timeout}
* </p>
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}

/**
* Explicit operation timeout<br/>
* Explicit operation timeout
* <p>
* API name: {@code timeout}
* </p>
*/
public final Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) {
return timeout(fn.apply(new Time.Builder()).build());
Expand Down
Loading

0 comments on commit 36dfe94

Please sign in to comment.