Class ClusterStatsResponse
java.lang.Object
org.opensearch.client.opensearch.nodes.NodesResponseBase
org.opensearch.client.opensearch.cluster.ClusterStatsResponse
- All Implemented Interfaces:
JsonpSerializable,PlainJsonSerializable,ToCopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>
@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ClusterStatsResponse
extends NodesResponseBase
implements ToCopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse>
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch.nodes.NodesResponseBase
NodesResponseBase.AbstractBuilder<BuilderT extends NodesResponseBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<ClusterStatsResponse> Json deserializer forClusterStatsResponse -
Method Summary
Modifier and TypeMethodDescriptionstatic ClusterStatsResponse.Builderbuilder()final StringRequired - The name of the cluster.final StringRequired - The unique identifier of the cluster.booleaninthashCode()final ClusterIndicesindices()Displays statistics about indexes in the cluster.final ClusterNodesnodes()Displays statistics about nodes selected by the request's node filters.static ClusterStatsResponseprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal HealthStatusstatus()Required - The health status of the cluster, based on the state of its primary and replica shards.final longRequired - The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch.nodes.NodesResponseBase
nodeStats, serialize, setupNodesResponseBaseDeserializerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forClusterStatsResponse
-
-
Method Details
-
of
public static ClusterStatsResponse of(Function<ClusterStatsResponse.Builder, ObjectBuilder<ClusterStatsResponse>> fn) -
clusterName
Required - The name of the cluster.API name:
cluster_name -
clusterUuid
Required - The unique identifier of the cluster.API name:
cluster_uuid -
indices
Displays statistics about indexes in the cluster.API name:
indices -
nodes
Displays statistics about nodes selected by the request's node filters.API name:
nodes -
status
Required - The health status of the cluster, based on the state of its primary and replica shards.API name:
status -
timestamp
public final long timestamp()Required - The Unix timestamp, in milliseconds, indicating when any cluster statistics were last refreshed.API name:
timestamp -
serializeInternal
- Overrides:
serializeInternalin classNodesResponseBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ClusterStatsResponse.Builder,ClusterStatsResponse> - Returns:
- a new builder instance.
-
builder
-
setupClusterStatsResponseDeserializer
protected static void setupClusterStatsResponseDeserializer(ObjectDeserializer<ClusterStatsResponse.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classNodesResponseBase
-
equals
- Overrides:
equalsin classNodesResponseBase
-