Class ConnectionModel

Hierarchy

ConnectionModel

Index

Constructors

Properties

Methods

get getSyncCatalog reset save state stateType trigger update createConnectionInstance createConnectionInstanceFromId

Constructors

constructor

new ConnectionModel(connection: ConnectionRead): ConnectionModel
Parameters
- connection: ConnectionRead
Returns ConnectionModel

Properties

meta

meta: ConnectionRead

Methods

get

get(key: keyof ConnectionRead): undefined | string | string[] | AirbyteCatalog | ConnectionSchedule | ResourceRequirements
Parameters
- key: keyof ConnectionRead
Returns undefined | string | string[] | AirbyteCatalog | ConnectionSchedule | ResourceRequirements

getSyncCatalog

getSyncCatalog(): AirbyteCatalog
Returns AirbyteCatalog

reset

reset(): Promise<JobInfoRead>
Returns Promise<JobInfoRead>

save

save(): Promise<void>
Returns Promise<void>

state

state(): Promise<ConnectionState>
Returns Promise<ConnectionState>

stateType

stateType(): Promise<ConnectionStateType>
Returns Promise<ConnectionStateType>

trigger

trigger(): Promise<JobInfoRead>
Returns Promise<JobInfoRead>

update

update(updateBody: Partial<ConnectionRead>): Promise<void>
Parameters
- updateBody: Partial<ConnectionRead>
Returns Promise<void>

`Static` createConnectionInstance

createConnectionInstance(connection: ConnectionRead): ConnectionModel
Parameters
- connection: ConnectionRead
Returns ConnectionModel

`Static` createConnectionInstanceFromId

createConnectionInstanceFromId(connectionId: string): Promise<ConnectionModel>
Parameters
- connectionId: string
Returns Promise<ConnectionModel>

Generated using TypeDoc