Class StorageIntegrationsClient

Tenant storage-integration collection.

Index

Constructors

Methods

create get getByRef list

Constructors

constructor

new StorageIntegrationsClient(
options: StorageIntegrationsClientOptions,
): StorageIntegrationsClient
Parameters
- options: StorageIntegrationsClientOptions
  The underlying admin client and tenant slug.
Returns StorageIntegrationsClient
- Defined in storage-integrations/client.ts:38

Methods

create

create(
request: CreateStorageIntegrationRequest,
options?: RequestOptions,
): Promise<StorageIntegration>
Creates a storage integration.
Parameters
- request: CreateStorageIntegrationRequest
  The reference, configuration, and credentials.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
The created integration.

Throws
Error When a field fails local validation.
- Defined in storage-integrations/client.ts:108

get

get(
integrationId: string,
options?: RequestOptions,
): Promise<StorageIntegration>
Gets a storage integration by identifier.
Parameters
- integrationId: string
  The integration identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
The hydrated integration.

Throws
NotFoundException When the integration is not visible.
- Defined in storage-integrations/client.ts:74

getByRef

getByRef(
storageRef: string,
options?: RequestOptions,
): Promise<StorageIntegration>
Gets a storage integration by its immutable reference.
Parameters
- storageRef: string
  The storage reference.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<StorageIntegration>
The hydrated integration.

Throws
NotFoundException When the integration is not visible.
- Defined in storage-integrations/client.ts:90

list

list(options?: ListOptions): Promise<Paged<StorageIntegration>>
Lists storage integrations.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Paged<StorageIntegration>>
A lazily paginating collection of integrations.

Throws
ApiException When the control plane returns a non-success status.
- Defined in storage-integrations/client.ts:52