Package co.elastic.clients.elasticsearch.indices.resolve_cluster

Class ResolveClusterInfo

java.lang.Object

co.elastic.clients.elasticsearch.indices.resolve_cluster.ResolveClusterInfo

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ResolveClusterInfo
extends Object
implements JsonpSerializable

Provides information about each cluster request relevant to doing a cross-cluster search.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final boolean	connected()	Required - Whether the remote cluster is connected to the local (querying) cluster.
final String	error()	Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (for example, lack of security privileges to query an index).
final Boolean	matchingIndices()	Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster.
static ResolveClusterInfo	of(Function<ResolveClusterInfo.Builder,ObjectBuilder<ResolveClusterInfo>> fn)
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	setupResolveClusterInfoDeserializer(ObjectDeserializer<ResolveClusterInfo.Builder> op)
final boolean	skipUnavailable()	Required - The skip_unavailable setting for a remote cluster.
String	toString()
final ElasticsearchVersionMinInfo	version()	Provides version information about the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ResolveClusterInfo> _DESERIALIZER

Json deserializer for ResolveClusterInfo

Method Details

of

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

connected

public final boolean connected()

Required - Whether the remote cluster is connected to the local (querying) cluster.

API name: connected

skipUnavailable

public final boolean skipUnavailable()

Required - The skip_unavailable setting for a remote cluster.

API name: skip_unavailable

matchingIndices

@Nullable
public final Boolean matchingIndices()

Whether the index expression provided in the request matches any indices, aliases or data streams on the cluster.

API name: matching_indices

error

@Nullable
public final String error()

Provides error messages that are likely to occur if you do a search with this index expression on the specified cluster (for example, lack of security privileges to query an index).

API name: error

version

@Nullable
public final ElasticsearchVersionMinInfo version()

Provides version information about the cluster.

API name: version

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)

toString

public String toString()

Overrides:

toString in class Object

setupResolveClusterInfoDeserializer

protected static void setupResolveClusterInfoDeserializer(ObjectDeserializer<ResolveClusterInfo.Builder> op)