Class APIKey

A listener API key. Only deletion is supported.

Hierarchy (View Summary)

Entity<APIKeyData>
- APIKey

Index

Constructors

Properties

Accessors

data id isDeleted listenerId tenantId username

Methods

Constructors

constructor

new APIKey(options: EntityOptions<APIKeyData>): APIKey
Parameters
- options: EntityOptions<APIKeyData>
  The client, path, backing data, and delete state.
Returns APIKey
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

id

get id(): string
Key identifier.

Returns string
- Defined in listeners/api-keys.ts:78

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

listenerId

get listenerId(): string
Owning listener identifier.

Returns string
- Defined in listeners/api-keys.ts:88

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in listeners/api-keys.ts:83

username

get username(): string
The API-key username.

Returns string
- Defined in listeners/api-keys.ts:93

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84