KeyValueClientCreateKeysUrlOptions

Options for creating a public URL to list keys in a Key-Value Store.

Extends KeyValueClientListKeysOptions with URL expiration control, minus chunkSize (it only sizes a client-side iteration) and signature (this method produces one).

Hierarchy

• Omit<KeyValueClientListKeysOptions, chunkSize | signature>
  • KeyValueClientCreateKeysUrlOptions

Added in 2.16.0

Index

Properties

• collection
• exclusiveStartKey
• expiresInSecs
• limit
• prefix
• signal
• timeoutSecs

Properties

optionalinheritedcollection

collection?: string

Inherited from Omit.collection

optionalinheritedexclusiveStartKey

exclusiveStartKey?: string

Inherited from Omit.exclusiveStartKey

optionalexpiresInSecs

expiresInSecs?: number

optionalinheritedlimit

limit?: number

Inherited from Omit.limit

optionalinheritedprefix

prefix?: string

Inherited from Omit.prefix

Added in 2.12.5

optionalinheritedsignal

signal?: AbortSignal

Inherited from Omit.signal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from Omit.timeoutSecs

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.