CirrusSearch\Assignment\ClusterAssignment Interface Reference

Inheritance diagram for CirrusSearch\Assignment\ClusterAssignment:

Public Member Functions
	uniqueId ( $cluster)
	getSearchCluster ()
	getWritableClusters ()
	canWriteToCluster ( $clusterName)
	getServerList ( $cluster=null)
	getCrossClusterName ()

Member Function Documentation

canWriteToCluster()

CirrusSearch\Assignment\ClusterAssignment::canWriteToCluster

(

$clusterName

)

Parameters

string

$clusterName

Returns

bool True when the named cluster is writable

Implemented in CirrusSearch\Assignment\MultiClusterAssignment, and CirrusSearch\Assignment\ConstantAssignment.

getCrossClusterName()

CirrusSearch\Assignment\ClusterAssignment::getCrossClusterName

(

)

Returns

string|null The name to use to refer to this wikis group in cross-cluster-search.

Implemented in CirrusSearch\Assignment\ConstantAssignment, and CirrusSearch\Assignment\MultiClusterAssignment.

getSearchCluster()

CirrusSearch\Assignment\ClusterAssignment::getSearchCluster

(

)

Returns

string Name of the cluster group to search against

Implemented in CirrusSearch\Assignment\ConstantAssignment, and CirrusSearch\Assignment\MultiClusterAssignment.

getServerList()

CirrusSearch\Assignment\ClusterAssignment::getServerList

(

$cluster = null

)

Parameters

string | null

$cluster

Name of cluster group to return connection configuration for, or null for the default search cluster.

Returns

string[]|array[] Either a list of hostnames, for default connection configuration, or an array of arrays giving full connection specifications.

Implemented in CirrusSearch\Assignment\ConstantAssignment, and CirrusSearch\Assignment\MultiClusterAssignment.

getWritableClusters()

CirrusSearch\Assignment\ClusterAssignment::getWritableClusters

(

)

Returns

string[] List of the cluster groups to send writes to

Implemented in CirrusSearch\Assignment\ConstantAssignment, and CirrusSearch\Assignment\MultiClusterAssignment.

uniqueId()

CirrusSearch\Assignment\ClusterAssignment::uniqueId

(

$cluster

)

Parameters

string

$cluster

The cluster to id.

Returns

string An identifier that unique describes the connection properties. Instances of the same implementation will return same value for same configuration.

Implemented in CirrusSearch\Assignment\ConstantAssignment, and CirrusSearch\Assignment\MultiClusterAssignment.

---

The documentation for this interface was generated from the following file:

• includes/Assignment/ClusterAssignment.php