--- api_metadata: apiVersion: "coordination.k8s.io/v1alpha1" import: "k8s.io/api/coordination/v1alpha1" kind: "LeaseCandidate" content_type: "api_reference" description: "LeaseCandidate defines a candidate for a Lease object." title: "LeaseCandidate v1alpha1" weight: 6 auto_generated: true --- `apiVersion: coordination.k8s.io/v1alpha1` `import "k8s.io/api/coordination/v1alpha1"` ## LeaseCandidate {#LeaseCandidate} LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

- **apiVersion**: coordination.k8s.io/v1alpha1 - **kind**: LeaseCandidate - **metadata** (}}">ObjectMeta) More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **spec** (}}">LeaseCandidateSpec) spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ## LeaseCandidateSpec {#LeaseCandidateSpec} LeaseCandidateSpec is a specification of a Lease.

- **leaseName** (string), required LeaseName is the name of the lease for which this candidate is contending. This field is immutable. - **preferredStrategies** ([]string), required *Atomic: will be replaced during a merge* PreferredStrategies indicates the list of strategies for picking the leader for coordinated leader election. The list is ordered, and the first strategy supersedes all other strategies. The list is used by coordinated leader election to make a decision about the final election strategy. This follows as - If all clients have strategy X as the first element in this list, strategy X will be used. - If a candidate has strategy [X] and another candidate has strategy [Y, X], Y supersedes X and strategy Y will be used. - If a candidate has strategy [X, Y] and another candidate has strategy [Y, X], this is a user error and leader election will not operate the Lease until resolved. (Alpha) Using this field requires the CoordinatedLeaderElection feature gate to be enabled. - **binaryVersion** (string) BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required when strategy is "OldestEmulationVersion" - **emulationVersion** (string) EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is "OldestEmulationVersion" - **pingTime** (MicroTime) PingTime is the last time that the server has requested the LeaseCandidate to renew. It is only done during leader election to check if any LeaseCandidates have become ineligible. When PingTime is updated, the LeaseCandidate will respond by updating RenewTime. *MicroTime is version of Time with microsecond level precision.* - **renewTime** (MicroTime) RenewTime is the time that the LeaseCandidate was last updated. Any time a Lease needs to do leader election, the PingTime field is updated to signal to the LeaseCandidate that they should update the RenewTime. Old LeaseCandidate objects are also garbage collected if it has been hours since the last renew. The PingTime field is updated regularly to prevent garbage collection for still active LeaseCandidates. *MicroTime is version of Time with microsecond level precision.* ## LeaseCandidateList {#LeaseCandidateList} LeaseCandidateList is a list of Lease objects.

- **apiVersion**: coordination.k8s.io/v1alpha1 - **kind**: LeaseCandidateList - **metadata** (}}">ListMeta) Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]}}">LeaseCandidate), required items is a list of schema objects. ## Operations {#Operations}

### `get` read the specified LeaseCandidate #### HTTP Request GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name} #### Parameters - **name** (*in path*): string, required name of the LeaseCandidate - **namespace** (*in path*): string, required }}">namespace - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">LeaseCandidate): OK 401: Unauthorized ### `list` list or watch objects of kind LeaseCandidate #### HTTP Request GET /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates #### Parameters - **namespace** (*in path*): string, required }}">namespace - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">LeaseCandidateList): OK 401: Unauthorized ### `list` list or watch objects of kind LeaseCandidate #### HTTP Request GET /apis/coordination.k8s.io/v1alpha1/leasecandidates #### Parameters - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">LeaseCandidateList): OK 401: Unauthorized ### `create` create a LeaseCandidate #### HTTP Request POST /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates #### Parameters - **namespace** (*in path*): string, required }}">namespace - **body**: }}">LeaseCandidate, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">LeaseCandidate): OK 201 (}}">LeaseCandidate): Created 202 (}}">LeaseCandidate): Accepted 401: Unauthorized ### `update` replace the specified LeaseCandidate #### HTTP Request PUT /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name} #### Parameters - **name** (*in path*): string, required name of the LeaseCandidate - **namespace** (*in path*): string, required }}">namespace - **body**: }}">LeaseCandidate, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">LeaseCandidate): OK 201 (}}">LeaseCandidate): Created 401: Unauthorized ### `patch` partially update the specified LeaseCandidate #### HTTP Request PATCH /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name} #### Parameters - **name** (*in path*): string, required name of the LeaseCandidate - **namespace** (*in path*): string, required }}">namespace - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">LeaseCandidate): OK 201 (}}">LeaseCandidate): Created 401: Unauthorized ### `delete` delete a LeaseCandidate #### HTTP Request DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates/{name} #### Parameters - **name** (*in path*): string, required name of the LeaseCandidate - **namespace** (*in path*): string, required }}">namespace - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### Response 200 (}}">Status): OK 202 (}}">Status): Accepted 401: Unauthorized ### `deletecollection` delete collection of LeaseCandidate #### HTTP Request DELETE /apis/coordination.k8s.io/v1alpha1/namespaces/{namespace}/leasecandidates #### Parameters - **namespace** (*in path*): string, required }}">namespace - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized