io.kubernetes.client.extended.leaderelection

Interface Lock

All Known Implementing Classes:

ConfigMapLock, EndpointsLock

public interface Lock

Lock offers a common interface for locking on arbitrary resources used in leader election. The Lock is used to hide the details on specific implementations in order to allow them to change over time. This interface is strictly for use by the leaderelection code.

Method Summary

Modifier and Type	Method and Description
boolean	create(LeaderElectionRecord record) create attempts to create a LeaderElectionRecord
java.lang.String	describe() Describe is used to convert details on current resource lock into a string
LeaderElectionRecord	get() get returns the LeaderElectionRecord which contains the information about the current lock holder
java.lang.String	identity() identity returns the locks Identity
boolean	update(LeaderElectionRecord record) update attempts to update the existing LeaderElectionRecord

Method Detail

get

LeaderElectionRecord get()
                  throws io.kubernetes.client.ApiException

get returns the LeaderElectionRecord which contains the information about the current lock holder

Returns:

the Leader election record

Throws:

io.kubernetes.client.ApiException

create

boolean create(LeaderElectionRecord record)

create attempts to create a LeaderElectionRecord

Parameters:

record - the information of this candidate

Returns:

the result is successful or not

update

boolean update(LeaderElectionRecord record)

update attempts to update the existing LeaderElectionRecord

Parameters:

record - the information of this candidate

Returns:

the result is successful or not

identity

java.lang.String identity()

identity returns the locks Identity

Returns:

the identity

describe

java.lang.String describe()

Describe is used to convert details on current resource lock into a string

Returns:

the description