Class StorageIntegration

A tenant object-storage integration.

Hierarchy (View Summary)

Entity<StorageIntegrationData>
- StorageIntegration

Index

Constructors

Properties

Accessors

credentialsPresent data displayName id isActive isDeleted storageRef tenantId

Methods

delete reload setActive update

Constructors

constructor

new StorageIntegration(
options: EntityOptions<StorageIntegrationData>,
): StorageIntegration
Parameters
- options: EntityOptions<StorageIntegrationData>
  The client, path, backing data, and delete state.
Returns StorageIntegration
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

credentialsPresent

get credentialsPresent(): boolean
Whether credentials are stored.

Returns boolean
- Defined in storage-integrations/entity.ts:45

data

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

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

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in storage-integrations/entity.ts:35

id

get id(): string
Integration identifier.

Returns string
- Defined in storage-integrations/entity.ts:20

isActive

get isActive(): boolean
Whether the integration is active.

Returns boolean
- Defined in storage-integrations/entity.ts:40

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

storageRef

get storageRef(): string
Immutable storage reference.

Returns string
- Defined in storage-integrations/entity.ts:30

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in storage-integrations/entity.ts:25

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

reload

reload(options?: RequestOptions): Promise<StorageIntegration>
Re-fetches this integration.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
A fresh snapshot.

Throws
NotFoundException When the integration is no longer visible.
- Defined in storage-integrations/entity.ts:58

setActive

setActive(
isActive: boolean,
options?: RequestOptions,
): Promise<StorageIntegration>
Activates or deactivates the integration.
Parameters
- isActive: boolean
  Whether the integration should be active.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
The updated integration.
- Defined in storage-integrations/entity.ts:102

update

update(
request: UpdateStorageIntegrationRequest,
options?: RequestOptions,
): Promise<StorageIntegration>
Replaces the integration configuration and credentials.
Parameters
- request: UpdateStorageIntegrationRequest
  The new configuration and credentials.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
The updated integration.
- Defined in storage-integrations/entity.ts:79