Skip to main content
Version: 2.x

Interface: CreateLeaseOptions

Defined in: javascript/src/credits/store.ts:70

Options for atomically acquiring a lease.

Extends​

  • OperationUsageOptions

Properties​

billingMode?​

optional billingMode?: BillingMode

Defined in: javascript/src/credits/store.ts:76

dimensions?​

optional dimensions?: Record<string, boolean | Value> | null

Defined in: javascript/src/credits/store.ts:66

Inherited from​

OperationUsageOptions.dimensions

feature?​

optional feature?: string | null

Defined in: javascript/src/credits/store.ts:62

Entitlement feature that must be enabled for the operation.

Inherited from​

OperationUsageOptions.feature

floor?​

optional floor?: Decimal

Defined in: javascript/src/credits/store.ts:77

idempotencyKey​

idempotencyKey: string

Defined in: javascript/src/credits/store.ts:75

Replay-safe acquisition key. Supplying the same key with the same request returns the original lease; conflicting reuse is rejected.

maxConcurrent?​

optional maxConcurrent?: number | null

Defined in: javascript/src/credits/store.ts:78

measures?​

optional measures?: Record<string, boolean | Value> | null

Defined in: javascript/src/credits/store.ts:65

Inherited from​

OperationUsageOptions.measures

metadata?​

optional metadata?: CreditMetadata | null

Defined in: javascript/src/credits/store.ts:81

model?​

optional model?: string | null

Defined in: javascript/src/credits/store.ts:63

Inherited from​

OperationUsageOptions.model

overdraftFloor?​

optional overdraftFloor?: Decimal | null

Defined in: javascript/src/credits/store.ts:79

region?​

optional region?: string | null

Defined in: javascript/src/credits/store.ts:64

Inherited from​

OperationUsageOptions.region

ttlSeconds?​

optional ttlSeconds?: number

Defined in: javascript/src/credits/store.ts:80