Interface Leases

interface Leases {
    create(
        namespace: NamespaceName,
        leaseName: string,
        holderName: string,
        durationSeconds: number,
    ): Promise<V1Lease>;
    delete(namespace: NamespaceName, name: string): Promise<V1Status>;
    read(
        namespace: NamespaceName,
        leaseName: string,
        timesCalled?: number,
    ): Promise<any>;
    renew(
        namespace: NamespaceName,
        leaseName: string,
        lease: V1Lease,
    ): Promise<V1Lease>;
    transfer(lease: V1Lease, newHolderName: string): Promise<V1Lease>;
}

Implemented by

Methods

create delete read renew transfer

Methods

create

  • create(
        namespace: NamespaceName,
        leaseName: string,
        holderName: string,
        durationSeconds: number,
    ): Promise<V1Lease>

    Create a new lease

    Parameters

    • namespace: NamespaceName

      the namespace to create the lease in

    • leaseName: string

      the name of the lease

    • holderName: string

      the name of the lease holder

    • durationSeconds: number

      the duration of the lease in seconds\

    Returns Promise<V1Lease>

    the created lease

delete

read

  • read(
        namespace: NamespaceName,
        leaseName: string,
        timesCalled?: number,
    ): Promise<any>

    Returns the lease with the specified name

    Parameters

    • namespace: NamespaceName

      the namespace to list leases in

    • leaseName: string

      the name of the lease

    • OptionaltimesCalled: number

      the number of times this function has been called

    Returns Promise<any>

    a list of lease names

renew

  • renew(
        namespace: NamespaceName,
        leaseName: string,
        lease: V1Lease,
    ): Promise<V1Lease>

    Renew a lease

    Parameters

    • namespace: NamespaceName

      the namespace of the lease

    • leaseName: string

      the name of the lease

    • lease: V1Lease

      the lease object

    Returns Promise<V1Lease>

    the renewed lease

transfer

  • transfer(lease: V1Lease, newHolderName: string): Promise<V1Lease>

    Transfer a lease

    Parameters

    • lease: V1Lease

      the lease object

    • newHolderName: string

      the name of the new lease holder

    Returns Promise<V1Lease>

    the transferred lease

Settings

Member Visibility

On This Page

Methods