Package org.opensearch.client.slm

Class SnapshotLifecycleStats

java.lang.Object

org.opensearch.client.slm.SnapshotLifecycleStats

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class SnapshotLifecycleStats
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotLifecycleStats.SnapshotPolicyStats

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static org.opensearch.common.ParseField	POLICY_STATS
static org.opensearch.common.ParseField	RETENTION_FAILED
static org.opensearch.common.ParseField	RETENTION_RUNS
static org.opensearch.common.ParseField	RETENTION_TIME
static org.opensearch.common.ParseField	RETENTION_TIME_MILLIS
static org.opensearch.common.ParseField	RETENTION_TIMED_OUT
static org.opensearch.common.ParseField	TOTAL_DELETION_FAILURES
static org.opensearch.common.ParseField	TOTAL_DELETIONS
static org.opensearch.common.ParseField	TOTAL_FAILED
static org.opensearch.common.ParseField	TOTAL_TAKEN

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,SnapshotLifecycleStats.SnapshotPolicyStats>	getMetrics()
long	getRetentionFailedCount()
long	getRetentionRunCount()
long	getRetentionTimedOut()
long	getRetentionTimeMillis()
int	hashCode()
static SnapshotLifecycleStats	parse(org.opensearch.common.xcontent.XContentParser parser)
java.lang.String	toString()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Field Detail

RETENTION_RUNS

public static final org.opensearch.common.ParseField RETENTION_RUNS

RETENTION_FAILED

public static final org.opensearch.common.ParseField RETENTION_FAILED

RETENTION_TIMED_OUT

public static final org.opensearch.common.ParseField RETENTION_TIMED_OUT

RETENTION_TIME

public static final org.opensearch.common.ParseField RETENTION_TIME

RETENTION_TIME_MILLIS

public static final org.opensearch.common.ParseField RETENTION_TIME_MILLIS

POLICY_STATS

public static final org.opensearch.common.ParseField POLICY_STATS

TOTAL_TAKEN

public static final org.opensearch.common.ParseField TOTAL_TAKEN

TOTAL_FAILED

public static final org.opensearch.common.ParseField TOTAL_FAILED

TOTAL_DELETIONS

public static final org.opensearch.common.ParseField TOTAL_DELETIONS

TOTAL_DELETION_FAILURES

public static final org.opensearch.common.ParseField TOTAL_DELETION_FAILURES

Method Detail

parse

public static SnapshotLifecycleStats parse(org.opensearch.common.xcontent.XContentParser parser)

getRetentionRunCount

public long getRetentionRunCount()

getRetentionFailedCount

public long getRetentionFailedCount()

getRetentionTimedOut

public long getRetentionTimedOut()

getRetentionTimeMillis

public long getRetentionTimeMillis()

getMetrics

public java.util.Map<java.lang.String,SnapshotLifecycleStats.SnapshotPolicyStats> getMetrics()

Returns:

a map of per-policy stats for each SLM policy

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
                                                                 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object