Package io.fabric8.kubernetes.client.extended.leaderelection.resourcelock

Interface Lock

All Known Implementing Classes:

ConfigMapLock, LeaseLock

public interface Lock

Field Summary

Fields

Modifier and Type	Field	Description
static String	LEADER_ELECTION_RECORD_ANNOTATION_KEY

Method Summary

Modifier and Type	Method	Description
<C extends Namespaceable<C> & KubernetesClient> void	create(C client, LeaderElectionRecord leaderElectionRecord)	Attempt to create a new LeaderElectionRecord.
String	describe()	Full description of the current lock.
<C extends Namespaceable<C> & KubernetesClient> LeaderElectionRecord	get(C client)	Returns the current LeaderElectionRecord or null if none.
String	identity()	Returns the unique id of the lock holder.
<C extends Namespaceable<C> & KubernetesClient> void	update(C client, LeaderElectionRecord leaderElectionRecord)	Attempts to update the current LeaderElectionRecord.

Field Detail

LEADER_ELECTION_RECORD_ANNOTATION_KEY

static final String LEADER_ELECTION_RECORD_ANNOTATION_KEY

See Also:

Constant Field Values

Method Detail

get

<C extends Namespaceable<C> & KubernetesClient> LeaderElectionRecord get(C client)

Returns the current LeaderElectionRecord or null if none.

Type Parameters:

C - Type parameter for the Client

Parameters:

client - used to retrieve the LeaderElectionRecord

Returns:

the current LeaderElectionRecord or null if none

create

<C extends Namespaceable<C> & KubernetesClient> void create(C client,
                                                            LeaderElectionRecord leaderElectionRecord)
                                                     throws LockException

Attempt to create a new LeaderElectionRecord.

Type Parameters:

C - Type parameter for the Client

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

Throws:

LockException - if update was not possible

update

<C extends Namespaceable<C> & KubernetesClient> void update(C client,
                                                            LeaderElectionRecord leaderElectionRecord)
                                                     throws LockException

Attempts to update the current LeaderElectionRecord.

Type Parameters:

C - Type parameter for the Client

Parameters:

client - used to retrieve the LeaderElectionRecord

leaderElectionRecord - to update

Throws:

LockException - if update was not possible

identity

String identity()

Returns the unique id of the lock holder. This id is to compare ids with current LeaderElectionRecord.getHolderIdentity() to check for leadership.

Returns:

unique id for the lock

describe

String describe()

Full description of the current lock.

Returns:

lock description