# LeaseCandidate v1beta1

LeaseCandidate v1beta1LeaseCandidate defines a candidate for a Lease object.apiVersion: coordination.k8s.io/v1beta1import "k8s.io/api/coordination/v1beta1"LeaseCandidateLeaseCandidate 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/v1beta1kind: LeaseCandidatemetadata (ObjectMeta)More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (LeaseCandidateSpec)spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-statusLeaseCandidateSpecLeaseCandidateSpec is a specification of a Lease.binaryVersion (string), requiredBinaryVersion is the binary version. It must be in a semver format without leading v. This field is required.leaseName (string), requiredLeaseName is the name of the lease for which this candidate is contending. The limits on this field are the same as on Lease.name. Multiple lease candidates may reference the same Lease.name. This field is immutable.strategy (string), requiredStrategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the candidate with the latest BinaryVersion will be used. If there is still conflict, this is a user error and coordinated leader election will not operate the Lease until resolved.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.LeaseCandidateListLeaseCandidateList is a list of Lease objects.apiVersion: coordination.k8s.io/v1beta1kind: LeaseCandidateListmetadata (ListMeta)Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataitems ([]LeaseCandidate), requireditems is a list of schema objects.Operationsget read the specified LeaseCandidateHTTP RequestGET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name}Parametersname (in path): string, requiredname of the LeaseCandidatenamespace (in path): string, requirednamespacepretty (in query): stringprettyResponse200 (LeaseCandidate): OK401: Unauthorizedlist list or watch objects of kind LeaseCandidateHTTP RequestGET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidatesParametersnamespace (in path): string, requirednamespaceallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (LeaseCandidateList): OK401: Unauthorizedlist list or watch objects of kind LeaseCandidateHTTP RequestGET /apis/coordination.k8s.io/v1beta1/leasecandidatesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (LeaseCandidateList): OK401: Unauthorizedcreate create a LeaseCandidateHTTP RequestPOST /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidatesParametersnamespace (in path): string, requirednamespacebody: LeaseCandidate, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (LeaseCandidate): OK201 (LeaseCandidate): Created202 (LeaseCandidate): Accepted401: Unauthorizedupdate replace the specified LeaseCandidateHTTP RequestPUT /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name}Parametersname (in path): string, requiredname of the LeaseCandidatenamespace (in path): string, requirednamespacebody: LeaseCandidate, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (LeaseCandidate): OK201 (LeaseCandidate): Created401: Unauthorizedpatch partially update the specified LeaseCandidateHTTP RequestPATCH /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name}Parametersname (in path): string, requiredname of the LeaseCandidatenamespace (in path): string, requirednamespacebody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (LeaseCandidate): OK201 (LeaseCandidate): Created401: Unauthorizeddelete delete a LeaseCandidateHTTP RequestDELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidates/{name}Parametersname (in path): string, requiredname of the LeaseCandidatenamespace (in path): string, requirednamespacebody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of LeaseCandidateHTTP RequestDELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leasecandidatesParametersnamespace (in path): string, requirednamespacebody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.