Package org.opensearch.client

Class SyncedFlushResponse

java.lang.Object

org.opensearch.client.SyncedFlushResponse

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncedFlushResponse.IndexResult	Description for the flush/synced results for a particular index.
static class	SyncedFlushResponse.ShardCounts	Encapsulates the number of total successful and failed shard copies
static class	SyncedFlushResponse.ShardFailure	Description of a failed shard copy for an index.

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 java.lang.String	SHARDS_FIELD

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
int	failedShards()
static SyncedFlushResponse	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
java.util.Map<java.lang.String,SyncedFlushResponse.IndexResult>	getIndexResults()
int	successfulShards()
int	totalShards()
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Field Detail

SHARDS_FIELD

public static final java.lang.String SHARDS_FIELD

See Also:

Constant Field Values

Method Detail

totalShards

public int totalShards()

Returns:

The total number of shard copies that were processed across all indexes

successfulShards

public int successfulShards()

Returns:

The number of successful shard copies that were processed across all indexes

failedShards

public int failedShards()

Returns:

The number of failed shard copies that were processed across all indexes

getIndexResults

public java.util.Map<java.lang.String,SyncedFlushResponse.IndexResult> getIndexResults()

Returns:

A map of results for each index where the keys of the map are the index names and the values are the results encapsulated in SyncedFlushResponse.IndexResult.

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

fromXContent

public static SyncedFlushResponse fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                        throws java.io.IOException

Throws:

java.io.IOException