Lock (Fabric8 :: Kubernetes :: Java Client API 7.2.0 API)

All Known Implementing Classes:

ConfigMapLock, LeaseLock, ResourceLock
```
public interface Lock
```

Field Summary

Fields
Modifier and Type Field Description

static String LEADER_ELECTION_RECORD_ANNOTATION_KEY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`create(KubernetesClient client, LeaderElectionRecord leaderElectionRecord)`	Attempt to create a new `LeaderElectionRecord`.
`String`	`describe()`	Full description of the current lock.
`LeaderElectionRecord`	`get(KubernetesClient client)`	Returns the current `LeaderElectionRecord` or null if none.
`String`	`identity()`	Returns the unique id of the lock holder.
`void`	`update(KubernetesClient 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
```
LeaderElectionRecord get(KubernetesClient client)
```
    Returns the current LeaderElectionRecord or null if none.
    
    Parameters:
    
    client - used to retrieve the LeaderElectionRecord
    
    Returns:
    
    the current LeaderElectionRecord or null if none
  - create
```
void create(KubernetesClient client,
            LeaderElectionRecord leaderElectionRecord)
```
    Attempt to create a new LeaderElectionRecord.
    
    Parameters:
    
    client - used to retrieve the LeaderElectionRecord
    
    leaderElectionRecord - to update
  - update
```
void update(KubernetesClient client,
            LeaderElectionRecord leaderElectionRecord)
```
    Attempts to update the current LeaderElectionRecord.
    
    Parameters:
    
    client - used to retrieve the LeaderElectionRecord
    
    leaderElectionRecord - to update
  - 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