Class IntervalLease

constructor

• new IntervalLease(
      client: K8,
      renewalService: LeaseRenewalService,
      leaseHolder: LeaseHolder,
      namespace: string,
      leaseName?: string,
      durationSeconds?: number,
  ): IntervalLease

• Parameters

  • client: K8

    Injected kubernetes client need by the methods to create, renew, and delete leases.
  • renewalService: LeaseRenewalService

    Injected lease renewal service need to support automatic (background) lease renewals.
  • leaseHolder: LeaseHolder

    The holder of the lease.
  • namespace: string

    The namespace in which the lease is to be acquired.
  • leaseName: string = null

    The name of the lease to be acquired; if not provided, the namespace is used.
  • durationSeconds: number = null

    The duration in seconds for which the lease is to be held; if not provided, the default value is used.

  Returns IntervalLease

Readonlyclient

ReadonlyrenewalService

Static ReadonlyDEFAULT_LEASE_DURATION

durationSeconds

• get durationSeconds(): number

• The duration in seconds for which the lease is held before being considered expired. By default, the duration is set to 20 seconds. It is recommended to renew the lease at 50% of the duration to prevent unexpected expiration.

  Returns number

leaseHolder

• get leaseHolder(): LeaseHolder

• The holder of the lease.

  Returns LeaseHolder

leaseName

• get leaseName(): string

• The name of the lease.

  Returns string

namespace

• get namespace(): string

• The namespace in which the lease is to be acquired. By default, the namespace is used as the lease name. The defaults assume there is only a single deployment in a given namespace.

  Returns string

scheduleId

• get scheduleId(): number

• The identifier of the scheduled lease renewal task.

  Returns number
• set scheduleId(scheduleId: number): void

• Internal setter for the scheduleId property. External callers should not use this method.

  Parameters

  • scheduleId: number

    The identifier of the scheduled lease renewal task.

  Returns void

acquire

• acquire(): Promise<void>

• Acquires the lease. If the lease is already acquired, it checks if the lease is expired or held by the same process. If the lease is expired, it creates a new lease. If the lease is held by the same process, it renews the lease. If the lease is held by another process, then an exception is thrown.

  Returns Promise<void>

  Throws

  LeaseAcquisitionError - If the lease is already acquired by another process or an error occurs during acquisition.

isAcquired

• isAcquired(): Promise<boolean>

• Checks if the lease is acquired. If the lease is acquired and not expired, it returns true; otherwise, false.

  Returns Promise<boolean>

  true if the lease is acquired and not expired; otherwise, false.

isExpired

• isExpired(): Promise<boolean>

• Checks if the lease is expired. If the lease is expired, it returns true; otherwise, false. This method does not verify if the lease is acquired by the current process.

  Returns Promise<boolean>

  true if the lease is expired; otherwise, false.

release

• release(): Promise<void>

• Releases the lease. If the lease is expired or held by the same process, it deletes the lease. If the lease is held by another process, then an exception is thrown.

  Returns Promise<void>

  Throws

  LeaseRelinquishmentError - If the lease is already acquired by another process or an error occurs during relinquishment.

renew

• renew(): Promise<void>

• Renews the lease. If the lease is expired or held by the same process, it creates or renews the lease. If the lease is held by another process, then an exception is thrown.

  Returns Promise<void>

  Throws

  LeaseAcquisitionError - If the lease is already acquired by another process or an error occurs during renewal.

tryAcquire

• tryAcquire(): Promise<boolean>

• Attempts to acquire the lease, by calling the acquire method. If an exception is thrown, it is caught and false is returned. If the lease is successfully acquired, true is returned; otherwise, false is returned.

  Returns Promise<boolean>

  true if the lease is successfully acquired; otherwise, false.

tryRelease

• tryRelease(): Promise<boolean>

• Attempts to release the lease, by calling the release method. If an exception is thrown, it is caught and false is returned. If the lease is successfully released, true is returned; otherwise, false is returned.

  Returns Promise<boolean>

  true if the lease is successfully released; otherwise, false.

tryRenew

• tryRenew(): Promise<boolean>

• Attempts to renew the lease, by calling the renew method. If an exception is thrown, it is caught and false is returned. If the lease is successfully renewed, true is returned; otherwise, false is returned.

  Returns Promise<boolean>

  true if the lease is successfully renewed; otherwise, false.