Package org.opensearch.client.opensearch._types

Class RemoteStoreUploadStats

java.lang.Object

org.opensearch.client.opensearch._types.RemoteStoreUploadStats

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<RemoteStoreUploadStats.Builder,RemoteStoreUploadStats>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RemoteStoreUploadStats
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<RemoteStoreUploadStats.Builder,RemoteStoreUploadStats>

Any statistics related to uploads to the remote segment store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoteStoreUploadStats.Builder	Builder for RemoteStoreUploadStats.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RemoteStoreUploadStats>	_DESERIALIZER	Json deserializer for RemoteStoreUploadStats

Method Summary

Modifier and Type	Method	Description
static RemoteStoreUploadStats.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Time	maxRefreshTimeLag()	The maximum duration that the remote refresh is behind the local refresh.
final long	maxRefreshTimeLagInMillis()	Required - The maximum duration, in milliseconds, that the remote refresh is behind the local refresh.
static RemoteStoreUploadStats	of(Function<RemoteStoreUploadStats.Builder,ObjectBuilder<RemoteStoreUploadStats>> fn)
final RemoteStoreUploadPressureStats	pressure()	API name: pressure
final RemoteStoreUploadRefreshSizeLagStats	refreshSizeLag()	Required - API name: refresh_size_lag
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRemoteStoreUploadStatsDeserializer(ObjectDeserializer<RemoteStoreUploadStats.Builder> op)
RemoteStoreUploadStats.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Time	totalTimeSpent()	The total amount of time spent on uploads to the remote segment store.
final long	totalTimeSpentInMillis()	Required - The total amount of time, in milliseconds, spent on uploads to the remote segment store.
final RemoteStoreUploadDownloadStats	totalUploadSize()	Required - API name: total_upload_size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RemoteStoreUploadStats> _DESERIALIZER

Json deserializer for RemoteStoreUploadStats

Method Details

of

public static RemoteStoreUploadStats of(Function<RemoteStoreUploadStats.Builder,ObjectBuilder<RemoteStoreUploadStats>> fn)

maxRefreshTimeLag

@Nullable
public final Time maxRefreshTimeLag()

The maximum duration that the remote refresh is behind the local refresh.

API name: max_refresh_time_lag

maxRefreshTimeLagInMillis

public final long maxRefreshTimeLagInMillis()

Required - The maximum duration, in milliseconds, that the remote refresh is behind the local refresh.

API name: max_refresh_time_lag_in_millis

pressure

@Nullable
public final RemoteStoreUploadPressureStats pressure()

API name: pressure

refreshSizeLag

@Nonnull
public final RemoteStoreUploadRefreshSizeLagStats refreshSizeLag()

Required - API name: refresh_size_lag

totalTimeSpent

@Nullable
public final Time totalTimeSpent()

The total amount of time spent on uploads to the remote segment store.

API name: total_time_spent

totalTimeSpentInMillis

public final long totalTimeSpentInMillis()

Required - The total amount of time, in milliseconds, spent on uploads to the remote segment store.

API name: total_time_spent_in_millis

totalUploadSize

@Nonnull
public final RemoteStoreUploadDownloadStats totalUploadSize()

Required - API name: total_upload_size

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public RemoteStoreUploadStats.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RemoteStoreUploadStats.Builder,RemoteStoreUploadStats>

Returns:

a new builder instance.

builder

@Nonnull
public static RemoteStoreUploadStats.Builder builder()

setupRemoteStoreUploadStatsDeserializer

protected static void setupRemoteStoreUploadStatsDeserializer(ObjectDeserializer<RemoteStoreUploadStats.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object