Package org.opensearch.client

Class SyncedFlushResponse.IndexResult

java.lang.Object

org.opensearch.client.SyncedFlushResponse.IndexResult

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

Enclosing class:

SyncedFlushResponse

public static final class SyncedFlushResponse.IndexResult
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentFragment

Description for the flush/synced results for a particular index. This includes total, successful and failed copies along with failure description for each failed copy.

Nested Class Summary

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	FAILED_FIELD
static java.lang.String	FAILURES_FIELD
static java.lang.String	SUCCESSFUL_FIELD
static java.lang.String	TOTAL_FIELD

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
int	failedShards()
java.util.List<SyncedFlushResponse.ShardFailure>	failures()
static SyncedFlushResponse.IndexResult	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
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.ToXContentFragment

isFragment

Field Detail

TOTAL_FIELD

public static final java.lang.String TOTAL_FIELD

See Also:

Constant Field Values

SUCCESSFUL_FIELD

public static final java.lang.String SUCCESSFUL_FIELD

See Also:

Constant Field Values

FAILED_FIELD

public static final java.lang.String FAILED_FIELD

See Also:

Constant Field Values

FAILURES_FIELD

public static final java.lang.String FAILURES_FIELD

See Also:

Constant Field Values

Method Detail

totalShards

public int totalShards()

Returns:

The total number of shard copies that were processed for this index.

successfulShards

public int successfulShards()

Returns:

The number of successful shard copies that were processed for this index.

failedShards

public int failedShards()

Returns:

The number of failed shard copies that were processed for this index.

failures

public java.util.List<SyncedFlushResponse.ShardFailure> failures()

Returns:

A list of SyncedFlushResponse.ShardFailure objects that describe each of the failed shard copies for this index.

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.IndexResult fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                                    throws java.io.IOException

Throws:

java.io.IOException