Class S3Provider

S3 provider implementation consumed by the Gestalt runtime.

Hierarchy (View Summary)

ProviderBase
- S3Provider

Constructors

constructor

new S3Provider(options: S3ProviderOptions): S3Provider
Parameters
- options: S3ProviderOptions
Returns S3Provider
Overrides ProviderBase.constructor

Properties

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

`Readonly`kind

kind: "s3" = ...

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider

headObject

headObject(ref: ObjectRef): Promise<ObjectMeta>
Fetches object metadata without reading the object body.
Parameters
- ref: ObjectRef
Returns Promise<ObjectMeta>

readObject

readObject(ref: ObjectRef, options?: ReadOptions): Promise<ProviderReadResult>
Reads an object body from the provider implementation.
Parameters
- ref: ObjectRef
- Optionaloptions: ReadOptions
Returns Promise<ProviderReadResult>

writeObject

writeObject(
    ref: ObjectRef,
    body: AsyncIterable<Uint8Array<ArrayBufferLike>>,
    options?: WriteOptions,
): Promise<ObjectMeta>
Writes an object body through the provider implementation.
Parameters
- ref: ObjectRef
- body: AsyncIterable<Uint8Array<ArrayBufferLike>>
- Optionaloptions: WriteOptions
Returns Promise<ObjectMeta>

deleteObject

deleteObject(ref: ObjectRef): Promise<void>
Deletes an object from the provider implementation.
Parameters
- ref: ObjectRef
Returns Promise<void>

listObjects

listObjects(options: ListOptions): Promise<ListPage>
Lists objects from the provider implementation.
Parameters
- options: ListOptions
Returns Promise<ListPage>

copyObject

copyObject(
    source: ObjectRef,
    destination: ObjectRef,
    options?: CopyOptions,
): Promise<ObjectMeta>
Copies an object in the provider implementation.
Parameters
- source: ObjectRef
- destination: ObjectRef
- Optionaloptions: CopyOptions
Returns Promise<ObjectMeta>

presignObject

presignObject(ref: ObjectRef, options?: PresignOptions): Promise<PresignResult>
Generates a presigned URL from the provider implementation.
Parameters
- ref: ObjectRef
- Optionaloptions: PresignOptions
Returns Promise<PresignResult>