> ## Documentation Index > Fetch the complete documentation index at: https://docs.prequel.co/llms.txt > Use this file to discover all available pages before exploring further. # React SDK API Models > API model types used by the Prequel Import React SDK public hooks. # React SDK API Models API model types used by the Prequel Import React SDK public hooks. These types are re-exported from the Import API client so their shapes are available without duplicating them on the main React SDK reference page. ### AbsSourceOptions > **AbsSourceOptions** = `object` #### Properties ##### bucket\_name > **bucket\_name**: `string` Container name ##### storage\_account\_name > **storage\_account\_name**: `string` Storage account name ##### auth\_method > **auth\_method**: `"azure_service_shared_access_signature"` Auth method ##### azure\_service\_shared\_access\_signature > **azure\_service\_shared\_access\_signature**: [`AzureServiceSharedAccessSignature`](#azureservicesharedaccesssignature) SAS Token *** ### AwsAccessKeys > **AwsAccessKeys** = `object` #### Properties ##### access\_id > **access\_id**: `string` Bucket access ID ##### secret\_key > **secret\_key**: `string` Bucket secret key *** ### AwsiamRole > **AwsiamRole** = `object` #### Properties ##### aws\_iam\_role\_arn > **aws\_iam\_role\_arn**: `string` IAM role ARN *** ### AzureServiceSharedAccessSignature > **AzureServiceSharedAccessSignature** = `object` #### Properties ##### shared\_access\_signature\_token > **shared\_access\_signature\_token**: `string` Storage Account SAS Token *** ### BearerTokenAuth > **BearerTokenAuth** = `object` #### Properties ##### bearer\_token > **bearer\_token**: `string` Bearer Token *** ### BigQuerySourceOptions > **BigQuerySourceOptions** = `object` & [`BigQuerySourceOptionsGcpServiceAccountRole`](#bigquerysourceoptionsgcpserviceaccountrole) | `object` & [`BigQuerySourceOptionsFederatedGcpServiceAccountRole`](#bigquerysourceoptionsfederatedgcpserviceaccountrole) | `object` & [`BigQuerySourceOptionsGcpServiceAccountKey`](#bigquerysourceoptionsgcpserviceaccountkey) *** ### CredentialSource > **CredentialSource** = `object` #### Properties ##### environment\_id > **environment\_id**: `string` ##### region\_url > **region\_url**: `string` ##### url > **url**: `string` ##### regional\_cred\_verification\_url > **regional\_cred\_verification\_url**: `string` *** ### DeltaSharingSourceOptions > **DeltaSharingSourceOptions** = `object` & [`DeltaSharingSourceOptionsBearerToken`](#deltasharingsourceoptionsbearertoken) | `object` & [`DeltaSharingSourceOptionsOAuth2`](#deltasharingsourceoptionsoauth2) *** ### FederatedGcpServiceAccountRole > **FederatedGcpServiceAccountRole** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Service account email ##### workload\_identity\_federation\_metadata? > `optional` **workload\_identity\_federation\_metadata?**: [`GcpExternalAccountMetadata`](#gcpexternalaccountmetadata) Workload identity metadata *** ### GcpServiceAccountRole > **GcpServiceAccountRole** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Service account email *** ### GcpSourceServiceAccountKey > **GcpSourceServiceAccountKey** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Source service account email ##### service\_account\_key > **service\_account\_key**: `unknown` JSON Token The credentials (JSON) that will be used to extract data from your BigQuery database. Create a service account just for this use. *** ### GcsAccessKeys > **GcsAccessKeys** = `object` #### Properties ##### access\_key > **access\_key**: `string` Bucket access ID The access key to use for authentication. ##### secret > **secret**: `string` Bucket secret key The secret to use for authentication. *** ### GcsSourceOptions > **GcsSourceOptions** = `object` & [`GcsSourceOptionsGcpServiceAccountRole`](#gcssourceoptionsgcpserviceaccountrole) | `object` & [`GcsSourceOptionsFederatedGcpServiceAccountRole`](#gcssourceoptionsfederatedgcpserviceaccountrole) | `object` & [`GcsSourceOptionsGcshmacKeys`](#gcssourceoptionsgcshmackeys) | `object` & [`GcsSourceOptionsGcpServiceAccountKey`](#gcssourceoptionsgcpserviceaccountkey) *** ### GcpExternalAccountMetadata > **GcpExternalAccountMetadata** = `object` #### Properties ##### type > **type**: `string` ##### audience > **audience**: `string` ##### subject\_token\_type > **subject\_token\_type**: `string` ##### service\_account\_impersonation\_url > **service\_account\_impersonation\_url**: `string` ##### token\_url > **token\_url**: `string` ##### credential\_source > **credential\_source**: [`CredentialSource`](#credentialsource) *** ### OAuthAuth > **OAuthAuth** = `object` #### Properties ##### client\_id > **client\_id**: `string` Client ID ##### client\_secret > **client\_secret**: `string` Client Secret *** ### PasswordAuth > **PasswordAuth** = `object` #### Properties ##### username > **username**: `string` Username ##### password > **password**: `string` Password *** ### PostgresSourceOptions > **PostgresSourceOptions** = `object` #### Properties ##### host > **host**: `string` Host Host address of the database. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### auth\_method > **auth\_method**: `"password_auth"` Auth method Authentication method. ##### password\_auth > **password\_auth**: [`PasswordAuth`](#passwordauth) Username and Password Required details for username/password authentication. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL *** ### PublicKeyAuth > **PublicKeyAuth** = `object` #### Properties ##### public\_key > **public\_key**: `string` Public key This is the PKCS8 public key generated for keypair authentication. *** ### RedshiftAccessKeys > **RedshiftAccessKeys** = `object` #### Properties ##### password > **password**: `string` Password ##### access\_id > **access\_id**: `string` Bucket access ID ##### secret\_key > **secret\_key**: `string` Bucket secret key *** ### RedshiftServerlessSourceOptions > **RedshiftServerlessSourceOptions** = `object` & [`RedshiftServerlessSourceOptionsAwsAccessKeys`](#redshiftserverlesssourceoptionsawsaccesskeys) | `object` & [`RedshiftServerlessSourceOptionsAwsiamRole`](#redshiftserverlesssourceoptionsawsiamrole) *** ### RedshiftSourceOptions > **RedshiftSourceOptions** = `object` & [`RedshiftSourceOptionsAwsAccessKeys`](#redshiftsourceoptionsawsaccesskeys) | `object` & [`RedshiftSourceOptionsAwsiamRole`](#redshiftsourceoptionsawsiamrole) *** ### S3CompatibleSourceOptions > **S3CompatibleSourceOptions** = `object` #### Properties ##### host > **host**: `string` Host ##### port > **port**: `number` Port ##### bucket\_name > **bucket\_name**: `string` Bucket name ##### auth\_method > **auth\_method**: `"access_keys"` Auth method ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeys`](#awsaccesskeys) Access Keys Required details for access key authentication. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. *** ### S3SourceOptions > **S3SourceOptions** = `object` & [`S3SourceOptionsAwsiamRole`](#s3sourceoptionsawsiamrole) | `object` & [`S3SourceOptionsAwsAccessKeys`](#s3sourceoptionsawsaccesskeys) *** ### SftpSourceOptions > **SftpSourceOptions** = `object` #### Properties ##### username > **username**: `string` Username ##### host > **host**: `string` Host ##### port > **port**: `number` Port ##### auth\_method > **auth\_method**: `"public_key_auth"` Auth method ##### public\_key\_auth > **public\_key\_auth**: [`PublicKeyAuth`](#publickeyauth) Key Pair Authentication *** ### SshTunnelParams > **SshTunnelParams** = `object` #### Properties ##### ssh\_tunnel\_host > **ssh\_tunnel\_host**: `string` SSH tunnel host ##### ssh\_tunnel\_port > **ssh\_tunnel\_port**: `number` SSH tunnel port ##### ssh\_tunnel\_username > **ssh\_tunnel\_username**: `string` SSH tunnel username ##### ssh\_public\_key? > `optional` **ssh\_public\_key?**: `"primary_public_key"` | `"secondary_public_key"` SSH Public Key This is the public SSH key that will be used to establish the SSH tunnel. It should be added to the list of authorized keys on the bastion host. *** ### SnowflakeSourceOptions > **SnowflakeSourceOptions** = [`SnowflakeSourceOptionsPublicKeyAuth`](#snowflakesourceoptionspublickeyauth) *** ### SourceOptions > **SourceOptions** = \{ `vendor`: `"postgres"`; `postgres`: [`PostgresSourceOptions`](#postgressourceoptions); } | \{ `vendor`: `"redshift"`; `redshift`: [`RedshiftSourceOptions`](#redshiftsourceoptions); } | \{ `vendor`: `"redshift_serverless"`; `redshift_serverless`: [`RedshiftServerlessSourceOptions`](#redshiftserverlesssourceoptions); } | \{ `vendor`: `"bigquery"`; `bigquery`: [`BigQuerySourceOptions`](#bigquerysourceoptions); } | \{ `vendor`: `"s3"`; `s3`: [`S3SourceOptions`](#s3sourceoptions); } | \{ `vendor`: `"abs"`; `abs`: [`AbsSourceOptions`](#abssourceoptions); } | \{ `vendor`: `"sftp"`; `sftp`: [`SftpSourceOptions`](#sftpsourceoptions); } | \{ `vendor`: `"gcs"`; `gcs`: [`GcsSourceOptions`](#gcssourceoptions); } | \{ `vendor`: `"s3_compatible"`; `s3_compatible`: [`S3CompatibleSourceOptions`](#s3compatiblesourceoptions); } | \{ `vendor`: `"snowflake"`; `snowflake`: [`SnowflakeSourceOptions`](#snowflakesourceoptions); } | \{ `vendor`: `"delta_sharing"`; `delta_sharing`: [`DeltaSharingSourceOptions`](#deltasharingsourceoptions); } & `object` #### Type Declaration ##### provider\_id > **provider\_id**: `string` Provider ID ID of the import provider this source belongs to. ##### name > **name**: `string` Name Unique name for this import source. *** ### AbsDatalakeResource > **AbsDatalakeResource** = `object` #### Properties ##### prefix > **prefix**: `string` ##### container\_name > **container\_name**: `string` ##### storage\_account\_name > **storage\_account\_name**: `string` ##### auth\_method > **auth\_method**: `string` ##### azure\_storage\_account\_access\_key? > `optional` **azure\_storage\_account\_access\_key?**: [`AzureStorageAccountAccessKeyResource`](#azurestorageaccountaccesskeyresource) *** ### AwsAccessKeysResource > **AwsAccessKeysResource** = `object` #### Properties ##### access\_key\_id > **access\_key\_id**: `string` *** ### AwsiamRoleResource > **AwsiamRoleResource** = `object` #### Properties ##### aws\_iam\_role > **aws\_iam\_role**: `string` *** ### AzureStorageAccountAccessKeyResource > **AzureStorageAccountAccessKeyResource** = `object` #### Index Signature \[`key`: `string`]: `never` *** ### DatalakeResource > **DatalakeResource** = \{ `storage`: `"s3"`; `s3`: [`S3DatalakeResource`](#s3datalakeresource); } | \{ `storage`: `"s3_compatible"`; `s3_compatible`: [`S3CompatibleDatalakeResource`](#s3compatibledatalakeresource); } | \{ `storage`: `"gcs"`; `gcs`: [`GcsDatalakeResource`](#gcsdatalakeresource); } | \{ `storage`: `"abs"`; `abs`: [`AbsDatalakeResource`](#absdatalakeresource); } & `object` #### Type Declaration ##### id > **id**: `string` ##### name > **name**: `string` ##### retention\_window\_days? > `optional` **retention\_window\_days?**: `number` ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### FederatedGcpDatalakeServiceAccountRoleResource > **FederatedGcpDatalakeServiceAccountRoleResource** = `object` #### Properties ##### gcp\_service\_account\_email > **gcp\_service\_account\_email**: `string` *** ### GcpDatalakeServiceAccountKeyResource > **GcpDatalakeServiceAccountKeyResource** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` *** ### GcpDatalakeServiceAccountRoleResource > **GcpDatalakeServiceAccountRoleResource** = `object` #### Properties ##### gcp\_service\_account\_email > **gcp\_service\_account\_email**: `string` *** ### GcsDatalakeResource > **GcsDatalakeResource** = `object` & [`GcsDatalakeResourceGcpServiceAccountRole`](#gcsdatalakeresourcegcpserviceaccountrole) | `object` & [`GcsDatalakeResourceGcpServiceAccountKey`](#gcsdatalakeresourcegcpserviceaccountkey) | `object` & [`GcsDatalakeResourceFederatedGcpServiceAccountRole`](#gcsdatalakeresourcefederatedgcpserviceaccountrole) *** ### ListDatalakesResponse > **ListDatalakesResponse** = `object` #### Properties ##### datalakes > **datalakes**: [`DatalakeResource`](#datalakeresource)\[] *** ### S3CompatibleDatalakeResource > **S3CompatibleDatalakeResource** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### bucket\_host > **bucket\_host**: `string` ##### bucket\_port > **bucket\_port**: `number` ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeysResource`](#awsaccesskeysresource) *** ### S3DatalakeResource > **S3DatalakeResource** = `object` & [`S3DatalakeResourceAwsiamRole`](#s3datalakeresourceawsiamrole) | `object` & [`S3DatalakeResourceAwsAccessKeys`](#s3datalakeresourceawsaccesskeys) *** ### AbsDatalakeOptions > **AbsDatalakeOptions** = `object` #### Properties ##### prefix > **prefix**: `string` Prefix to use for the ABS bucket. ##### container\_name > **container\_name**: `string` Container Name ##### storage\_account\_name > **storage\_account\_name**: `string` Storage Account Name ##### auth\_method > **auth\_method**: `"azure_storage_account_access_key"` Auth Method ##### azure\_storage\_account\_access\_key? > `optional` **azure\_storage\_account\_access\_key?**: [`AzureStorageAccountAccessKey`](#azurestorageaccountaccesskey) Required parameters to authenticate to Azure using an access key. *** ### AzureStorageAccountAccessKey > **AzureStorageAccountAccessKey** = `object` #### Properties ##### storage\_account\_access\_key > **storage\_account\_access\_key**: `string` Access key *** ### CreateDatalakeRequest > **CreateDatalakeRequest** = `object` #### Properties ##### datalake > **datalake**: [`DatalakeOptions`](#datalakeoptions) *** ### DatalakeOptions > **DatalakeOptions** = \{ `storage`: `"s3"`; `s3`: [`S3DatalakeOptions`](#s3datalakeoptions); } | \{ `storage`: `"s3_compatible"`; `s3_compatible`: [`S3CompatibleDatalakeOptions`](#s3compatibledatalakeoptions); } | \{ `storage`: `"gcs"`; `gcs`: [`GcsDatalakeOptions`](#gcsdatalakeoptions); } | \{ `storage`: `"abs"`; `abs`: [`AbsDatalakeOptions`](#absdatalakeoptions); } & `object` #### Type Declaration ##### name > **name**: `string` Name Unique name for this import datalake. ##### retention\_window\_days? > `optional` **retention\_window\_days?**: `number` Retention Window (Days) Number of days to retain data. Null means infinite retention. *** ### FederatedGcpDatalakeServiceAccountRole > **FederatedGcpDatalakeServiceAccountRole** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Datalake service account email ##### workload\_identity\_federation\_metadata? > `optional` **workload\_identity\_federation\_metadata?**: [`GcpExternalAccountMetadata`](#gcpexternalaccountmetadata) Workload identity metadata *** ### GcpDatalakeServiceAccountKey > **GcpDatalakeServiceAccountKey** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Datalake service account email ##### service\_account\_key > **service\_account\_key**: `unknown` JSON Token The credentials (JSON) that will be used to access the datalake. Create a service account just for this use. *** ### GcpDatalakeServiceAccountRole > **GcpDatalakeServiceAccountRole** = `object` #### Properties ##### gcp\_service\_account\_email > **gcp\_service\_account\_email**: `string` GCP Service Account Email Email of the GCP service account. *** ### GcsDatalakeOptions > **GcsDatalakeOptions** = `object` & [`GcsDatalakeOptionsGcpServiceAccountRole`](#gcsdatalakeoptionsgcpserviceaccountrole) | `object` & [`GcsDatalakeOptionsGcpServiceAccountKey`](#gcsdatalakeoptionsgcpserviceaccountkey) | `object` & [`GcsDatalakeOptionsFederatedGcpServiceAccountRole`](#gcsdatalakeoptionsfederatedgcpserviceaccountrole) *** ### S3CompatibleDatalakeOptions > **S3CompatibleDatalakeOptions** = `object` #### Properties ##### prefix > **prefix**: `string` Prefix to use for the S3 bucket. ##### bucket\_name > **bucket\_name**: `string` Bucket Name ##### bucket\_region > **bucket\_region**: `string` Region ##### bucket\_host > **bucket\_host**: `string` Host ##### bucket\_port > **bucket\_port**: `number` Port ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeys`](#awsaccesskeys) Access credentials for S3-compatible storage. *** ### S3DatalakeOptions > **S3DatalakeOptions** = `object` & [`S3DatalakeOptionsAwsiamRole`](#s3datalakeoptionsawsiamrole) | `object` & [`S3DatalakeOptionsAwsAccessKeys`](#s3datalakeoptionsawsaccesskeys) *** ### GetDatalakeResponse > **GetDatalakeResponse** = `object` #### Properties ##### datalake > **datalake**: [`DatalakeResource`](#datalakeresource) *** ### DatalakeUpdateOptions > **DatalakeUpdateOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Unique name for this import datalake. ##### retention\_window\_days? > `optional` **retention\_window\_days?**: `number` Number of days to retain data. Null means infinite retention. ##### s3? > `optional` **s3?**: [`UpdateS3DatalakeOptions`](#updates3datalakeoptions) ##### s3\_compatible? > `optional` **s3\_compatible?**: [`UpdateS3CompatibleDatalakeOptions`](#updates3compatibledatalakeoptions) ##### gcs? > `optional` **gcs?**: [`UpdateGcsDatalakeOptions`](#updategcsdatalakeoptions) ##### abs? > `optional` **abs?**: [`UpdateAbsDatalakeOptions`](#updateabsdatalakeoptions) *** ### UpdateAbsDatalakeOptions > **UpdateAbsDatalakeOptions** = `object` #### Properties ##### prefix? > `optional` **prefix?**: `string` Prefix to use for the ABS bucket. ##### container\_name? > `optional` **container\_name?**: `string` ##### storage\_account\_name? > `optional` **storage\_account\_name?**: `string` ##### auth\_method? > `optional` **auth\_method?**: `"azure_storage_account_access_key"` ##### azure\_storage\_account\_access\_key? > `optional` **azure\_storage\_account\_access\_key?**: [`UpdateAzureStorageAccountAccessKey`](#updateazurestorageaccountaccesskey) *** ### UpdateAwsAccessKeys > **UpdateAwsAccessKeys** = `object` #### Properties ##### access\_id? > `optional` **access\_id?**: `string` The access key ID to use for authentication. ##### secret\_key? > `optional` **secret\_key?**: `string` The secret key to use for authentication. *** ### UpdateAzureStorageAccountAccessKey > **UpdateAzureStorageAccountAccessKey** = `object` #### Properties ##### storage\_account\_access\_key? > `optional` **storage\_account\_access\_key?**: `string` Access key *** ### UpdateDatalakeRequest > **UpdateDatalakeRequest** = `object` #### Properties ##### datalake > **datalake**: [`DatalakeUpdateOptions`](#datalakeupdateoptions) *** ### UpdateGcpDatalakeServiceAccountKey > **UpdateGcpDatalakeServiceAccountKey** = `object` #### Properties ##### service\_account\_email? > `optional` **service\_account\_email?**: `string` The email of the GCP service account to use for authentication. ##### service\_account\_key? > `optional` **service\_account\_key?**: `unknown` The full Google-generated JSON service account key object. *** ### UpdateGcpDatalakeServiceAccountRole > **UpdateGcpDatalakeServiceAccountRole** = `object` #### Properties ##### gcp\_service\_account\_email? > `optional` **gcp\_service\_account\_email?**: `string` Email of the GCP service account. *** ### UpdateGcsDatalakeOptions > **UpdateGcsDatalakeOptions** = `object` #### Properties ##### prefix? > `optional` **prefix?**: `string` Prefix to use for the GCS bucket. ##### auth\_method? > `optional` **auth\_method?**: `"gcp_service_account_role"` | `"gcp_service_account_key"` | `"federated_gcp_service_account_role"` ##### gcp\_service\_account\_role? > `optional` **gcp\_service\_account\_role?**: [`UpdateGcpDatalakeServiceAccountRole`](#updategcpdatalakeserviceaccountrole) ##### gcp\_service\_account\_key? > `optional` **gcp\_service\_account\_key?**: [`UpdateGcpDatalakeServiceAccountKey`](#updategcpdatalakeserviceaccountkey) ##### federated\_gcp\_service\_account\_role? > `optional` **federated\_gcp\_service\_account\_role?**: [`UpdateGcpDatalakeServiceAccountRole`](#updategcpdatalakeserviceaccountrole) *** ### UpdateS3CompatibleDatalakeOptions > **UpdateS3CompatibleDatalakeOptions** = `object` #### Properties ##### prefix? > `optional` **prefix?**: `string` Prefix to use for the S3 bucket. ##### bucket\_host? > `optional` **bucket\_host?**: `string` Host for S3-compatible storage. ##### bucket\_port? > `optional` **bucket\_port?**: `number` Port for S3-compatible storage. ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateAwsAccessKeys`](#updateawsaccesskeys) *** ### UpdateS3DatalakeOptions > **UpdateS3DatalakeOptions** = `object` #### Properties ##### prefix? > `optional` **prefix?**: `string` Prefix to use for the S3 bucket. ##### auth\_method? > `optional` **auth\_method?**: `"aws_iam_role"` | `"aws_access_keys"` ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRole`](#awsiamrole) ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateAwsAccessKeys`](#updateawsaccesskeys) *** ### DatalakeQueryRequest > **DatalakeQueryRequest** = `object` #### Properties ##### dataset\_ids > **dataset\_ids**: `string`\[] ##### query > **query**: `string` *** ### DatalakeQueryResponse > **DatalakeQueryResponse** = `object` #### Properties ##### schema > **schema**: [`QueryResultSchemaField`](#queryresultschemafield)\[] ##### records > **records**: `unknown`\[] *** ### QueryResultSchemaField > **QueryResultSchemaField** = `object` #### Properties ##### name > **name**: `string` ##### database\_type\_name? > `optional` **database\_type\_name?**: `string` ##### length? > `optional` **length?**: `number` ##### precision? > `optional` **precision?**: `number` ##### scale? > `optional` **scale?**: `number` ##### nullable? > `optional` **nullable?**: `boolean` *** ### ListProvidersResponse > **ListProvidersResponse** = `object` #### Properties ##### providers > **providers**: [`ProviderResource`](#providerresource)\[] *** ### ProviderResource > **ProviderResource** = `object` #### Properties ##### name > **name**: `string` ##### id > **id**: `string` ##### is\_enabled > **is\_enabled**: `boolean` ##### datalake\_id > **datalake\_id**: `string` ##### products > **products**: `string`\[] ##### machine\_type\_id? > `optional` **machine\_type\_id?**: `string` ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### ProviderOptions > **ProviderOptions** = `object` #### Properties ##### name > **name**: `string` Name Unique name for this provider. ##### id > **id**: `string` ID Unique identifier for this provider. ##### datalake\_id > **datalake\_id**: `string` Datalake ID The ID of the datalake this provider belongs to. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Enabled Whether this provider is enabled. ##### products > **products**: `string`\[] Products The names of the products to be assigned to this provider. ##### machine\_type\_id? > `optional` **machine\_type\_id?**: `string` Machine Type ID Optional machine type for resource allocation. *** ### GetProviderResponse > **GetProviderResponse** = `object` #### Properties ##### provider > **provider**: [`ProviderResource`](#providerresource) *** ### UpdateProviderOptions > **UpdateProviderOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Name for this provider. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Whether this provider is enabled. ##### products? > `optional` **products?**: `string`\[] The names of the products to be assigned to this provider. ##### machine\_type\_id? > `optional` **machine\_type\_id?**: `string` Machine type for resource allocation. *** ### AbsSourceResource > **AbsSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### bucket\_name > **bucket\_name**: `string` ##### storage\_account\_name > **storage\_account\_name**: `string` ##### auth\_method > **auth\_method**: `string` *** ### BigQuerySourceResource > **BigQuerySourceResource** = `object` & [`BigQuerySourceResourceGcpServiceAccountRole`](#bigquerysourceresourcegcpserviceaccountrole) | `object` & [`BigQuerySourceResourceFederatedGcpServiceAccountRole`](#bigquerysourceresourcefederatedgcpserviceaccountrole) | `object` & [`BigQuerySourceResourceGcpServiceAccountKey`](#bigquerysourceresourcegcpserviceaccountkey) *** ### DeltaSharingSourceResource > **DeltaSharingSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### auth\_method > **auth\_method**: `string` ##### oauth\_client\_id? > `optional` **oauth\_client\_id?**: `string` *** ### FederatedGcpServiceAccountRoleResource > **FederatedGcpServiceAccountRoleResource** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` *** ### GcpServiceAccountKeyResource > **GcpServiceAccountKeyResource** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` *** ### GcpServiceAccountRoleResource > **GcpServiceAccountRoleResource** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` *** ### GcsAccessKeysResource > **GcsAccessKeysResource** = `object` #### Properties ##### access\_id > **access\_id**: `string` *** ### GcsSourceResource > **GcsSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### bucket\_name > **bucket\_name**: `string` ##### region > **region**: `string` ##### auth\_method > **auth\_method**: `string` ##### gcp\_service\_account\_role? > `optional` **gcp\_service\_account\_role?**: [`GcpServiceAccountRoleResource`](#gcpserviceaccountroleresource) ##### federated\_gcp\_service\_account\_role? > `optional` **federated\_gcp\_service\_account\_role?**: [`FederatedGcpServiceAccountRoleResource`](#federatedgcpserviceaccountroleresource) ##### gcs\_hmac\_keys? > `optional` **gcs\_hmac\_keys?**: [`GcsAccessKeysResource`](#gcsaccesskeysresource) ##### gcp\_service\_account\_key? > `optional` **gcp\_service\_account\_key?**: [`GcpServiceAccountKeyResource`](#gcpserviceaccountkeyresource) *** ### ListSourcesResponse > **ListSourcesResponse** = `object` #### Properties ##### sources > **sources**: [`SourceResource`](#sourceresource)\[] *** ### PostgresSourceResource > **PostgresSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### database > **database**: `string` ##### username > **username**: `string` ##### auth\_method > **auth\_method**: `string` ##### use\_ssh\_tunnel > **use\_ssh\_tunnel**: `boolean` ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelResource`](#sshtunnelresource) ##### disable\_ssl > **disable\_ssl**: `boolean` ##### connection\_timeout\_in\_seconds > **connection\_timeout\_in\_seconds**: `number` *** ### PublicKeyAuthResource > **PublicKeyAuthResource** = `object` #### Properties ##### public\_key > **public\_key**: `string` *** ### RedshiftAccessKeysResource > **RedshiftAccessKeysResource** = `object` #### Properties ##### access\_id > **access\_id**: `string` *** ### RedshiftServerlessSourceResource > **RedshiftServerlessSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### database > **database**: `string` ##### region? > `optional` **region?**: `string` ##### workgroup > **workgroup**: `string` ##### auth\_method > **auth\_method**: `string` ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRoleResource`](#awsiamroleresource) ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`RedshiftAccessKeysResource`](#redshiftaccesskeysresource) ##### use\_ssh\_tunnel > **use\_ssh\_tunnel**: `boolean` ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelResource`](#sshtunnelresource) ##### disable\_ssl > **disable\_ssl**: `boolean` ##### connection\_timeout\_in\_seconds > **connection\_timeout\_in\_seconds**: `number` *** ### RedshiftSourceResource > **RedshiftSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### database > **database**: `string` ##### cluster? > `optional` **cluster?**: `string` ##### region? > `optional` **region?**: `string` ##### workgroup? > `optional` **workgroup?**: `string` ##### username? > `optional` **username?**: `string` ##### auth\_method > **auth\_method**: `string` ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRoleResource`](#awsiamroleresource) ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`RedshiftAccessKeysResource`](#redshiftaccesskeysresource) ##### use\_ssh\_tunnel > **use\_ssh\_tunnel**: `boolean` ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelResource`](#sshtunnelresource) ##### disable\_ssl > **disable\_ssl**: `boolean` ##### connection\_timeout\_in\_seconds > **connection\_timeout\_in\_seconds**: `number` *** ### S3CompatibleSourceResource > **S3CompatibleSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### bucket\_name > **bucket\_name**: `string` ##### auth\_method > **auth\_method**: `string` ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`AwsAccessKeysResource`](#awsaccesskeysresource) ##### disable\_ssl > **disable\_ssl**: `boolean` ##### use\_ssh\_tunnel > **use\_ssh\_tunnel**: `boolean` ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelResource`](#sshtunnelresource) *** ### S3SourceResource > **S3SourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### bucket\_name > **bucket\_name**: `string` ##### region > **region**: `string` ##### auth\_method > **auth\_method**: `string` ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRoleResource`](#awsiamroleresource) ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`AwsAccessKeysResource`](#awsaccesskeysresource) ##### bucket\_host? > `optional` **bucket\_host?**: `string` ##### use\_ssh\_tunnel > **use\_ssh\_tunnel**: `boolean` ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelResource`](#sshtunnelresource) *** ### SftpSourceResource > **SftpSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### username > **username**: `string` ##### host > **host**: `string` ##### port > **port**: `number` ##### auth\_method > **auth\_method**: `string` *** ### SshTunnelResource > **SshTunnelResource** = `object` #### Properties ##### ssh\_tunnel\_host? > `optional` **ssh\_tunnel\_host?**: `string` ##### ssh\_tunnel\_port? > `optional` **ssh\_tunnel\_port?**: `number` ##### ssh\_tunnel\_username? > `optional` **ssh\_tunnel\_username?**: `string` ##### ssh\_public\_key? > `optional` **ssh\_public\_key?**: `string` *** ### SnowflakeSourceResource > **SnowflakeSourceResource** = `object` #### Properties ##### is\_valid > **is\_valid**: `boolean` ##### host > **host**: `string` ##### port > **port**: `number` ##### database > **database**: `string` ##### username > **username**: `string` ##### auth\_method > **auth\_method**: `"public_key_auth"` ##### public\_key\_auth? > `optional` **public\_key\_auth?**: [`PublicKeyAuthResource`](#publickeyauthresource) *** ### SourceResource > **SourceResource** = \{ `vendor`: `"postgres"`; `postgres`: [`PostgresSourceResource`](#postgressourceresource); } | \{ `vendor`: `"redshift"`; `redshift`: [`RedshiftSourceResource`](#redshiftsourceresource); } | \{ `vendor`: `"redshift_serverless"`; `redshift_serverless`: [`RedshiftServerlessSourceResource`](#redshiftserverlesssourceresource); } | \{ `vendor`: `"bigquery"`; `bigquery`: [`BigQuerySourceResource`](#bigquerysourceresource); } | \{ `vendor`: `"s3"`; `s3`: [`S3SourceResource`](#s3sourceresource); } | \{ `vendor`: `"abs"`; `abs`: [`AbsSourceResource`](#abssourceresource); } | \{ `vendor`: `"sftp"`; `sftp`: [`SftpSourceResource`](#sftpsourceresource); } | \{ `vendor`: `"gcs"`; `gcs`: [`GcsSourceResource`](#gcssourceresource); } | \{ `vendor`: `"s3_compatible"`; `s3_compatible`: [`S3CompatibleSourceResource`](#s3compatiblesourceresource); } | \{ `vendor`: `"snowflake"`; `snowflake`: [`SnowflakeSourceResource`](#snowflakesourceresource); } | \{ `vendor`: `"delta_sharing"`; `delta_sharing`: [`DeltaSharingSourceResource`](#deltasharingsourceresource); } & `object` #### Type Declaration ##### id > **id**: `string` ##### provider\_id > **provider\_id**: `string` ##### name > **name**: `string` ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### CreateSourceRequest > **CreateSourceRequest** = `object` #### Properties ##### source > **source**: [`SourceOptions`](#sourceoptions) *** ### GetSourceResponse > **GetSourceResponse** = `object` #### Properties ##### source > **source**: [`SourceResource`](#sourceresource) *** ### UpdateAbsSourceOptions > **UpdateAbsSourceOptions** = `object` #### Properties ##### bucket\_name? > `optional` **bucket\_name?**: `string` The name of the ABS container. ##### storage\_account\_name? > `optional` **storage\_account\_name?**: `string` The name of the Azure storage account. ##### auth\_method? > `optional` **auth\_method?**: `"azure_service_shared_access_signature"` Authentication method. ##### azure\_service\_shared\_access\_signature? > `optional` **azure\_service\_shared\_access\_signature?**: [`UpdateAzureServiceSharedAccessSignature`](#updateazureservicesharedaccesssignature) Required parameters to authenticate to Azure using a SAS token. *** ### UpdateAzureServiceSharedAccessSignature > **UpdateAzureServiceSharedAccessSignature** = `object` #### Properties ##### shared\_access\_signature\_token? > `optional` **shared\_access\_signature\_token?**: `string` Storage Account SAS Token *** ### UpdateBigQuerySourceOptions > **UpdateBigQuerySourceOptions** = `object` #### Properties ##### project\_id? > `optional` **project\_id?**: `string` Project ID ##### region? > `optional` **region?**: `string` Region ##### auth\_method? > `optional` **auth\_method?**: `"gcp_service_account_role"` | `"gcp_service_account_key"` | `"federated_gcp_service_account_role"` Auth method The method of authentication to use for this source. ##### gcp\_service\_account\_role? > `optional` **gcp\_service\_account\_role?**: [`UpdateGcpServiceAccountRole`](#updategcpserviceaccountrole) Required details if authenticating using a GCP service account role. ##### federated\_gcp\_service\_account\_role? > `optional` **federated\_gcp\_service\_account\_role?**: [`UpdateFederatedGcpServiceAccountRole`](#updatefederatedgcpserviceaccountrole) Required details if authenticating using a GCP service account role. ##### gcp\_service\_account\_key? > `optional` **gcp\_service\_account\_key?**: [`UpdateGcpSourceServiceAccountKey`](#updategcpsourceserviceaccountkey) Required details if authenticating using a GCP service account key. *** ### UpdateDeltaSharingSourceOptions > **UpdateDeltaSharingSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the Delta Sharing server. ##### port? > `optional` **port?**: `number` The port of the Delta Sharing server. ##### auth\_method? > `optional` **auth\_method?**: `"bearer_token"` | `"oauth2"` ##### bearer\_token? > `optional` **bearer\_token?**: [`BearerTokenAuth`](#bearertokenauth) Required details for bearer token authentication. ##### oauth2? > `optional` **oauth2?**: [`OAuthAuth`](#oauthauth) Required details for OAuth2 authentication. *** ### UpdateFederatedGcpServiceAccountRole > **UpdateFederatedGcpServiceAccountRole** = `object` #### Properties ##### service\_account\_email > **service\_account\_email**: `string` Service account email ##### workload\_identity\_federation\_metadata? > `optional` **workload\_identity\_federation\_metadata?**: [`GcpExternalAccountMetadata`](#gcpexternalaccountmetadata) Workload identity metadata *** ### UpdateGcpServiceAccountRole > **UpdateGcpServiceAccountRole** = `object` #### Properties ##### service\_account\_email? > `optional` **service\_account\_email?**: `string` The email of the GCP service account to use for authentication. ##### workload\_identity\_federation\_metadata? > `optional` **workload\_identity\_federation\_metadata?**: [`GcpExternalAccountMetadata`](#gcpexternalaccountmetadata) Workload identity metadata The federation metadata to use for authentication. *** ### UpdateGcpSourceServiceAccountKey > **UpdateGcpSourceServiceAccountKey** = `object` #### Properties ##### service\_account\_email? > `optional` **service\_account\_email?**: `string` The email of the GCP service account to use for authentication. ##### service\_account\_key? > `optional` **service\_account\_key?**: `unknown` The full Google-generated JSON service account key object. *** ### UpdateGcsAccessKeys > **UpdateGcsAccessKeys** = `object` #### Properties ##### access\_key? > `optional` **access\_key?**: `string` The access key to use for authentication. ##### secret? > `optional` **secret?**: `string` The secret to use for authentication. *** ### UpdateGcsSourceOptions > **UpdateGcsSourceOptions** = `object` #### Properties ##### bucket\_name? > `optional` **bucket\_name?**: `string` The name of the GCS bucket. ##### region? > `optional` **region?**: `string` The GCP region of the GCS bucket. ##### auth\_method? > `optional` **auth\_method?**: `"gcp_service_account_role"` | `"federated_gcp_service_account_role"` | `"gcs_hmac_keys"` | `"gcp_service_account_key"` Authentication method. ##### gcp\_service\_account\_role? > `optional` **gcp\_service\_account\_role?**: [`UpdateGcpServiceAccountRole`](#updategcpserviceaccountrole) Required details if authenticating using a GCP service account role. ##### federated\_gcp\_service\_account\_role? > `optional` **federated\_gcp\_service\_account\_role?**: [`UpdateFederatedGcpServiceAccountRole`](#updatefederatedgcpserviceaccountrole) Required details if authenticating using a GCP service account role. ##### gcs\_hmac\_keys? > `optional` **gcs\_hmac\_keys?**: [`UpdateGcsAccessKeys`](#updategcsaccesskeys) Required details if authenticating using GCS HMAC keys. ##### gcp\_service\_account\_key? > `optional` **gcp\_service\_account\_key?**: [`UpdateGcpSourceServiceAccountKey`](#updategcpsourceserviceaccountkey) Required details if authenticating using a GCP service account key. *** ### UpdatePasswordAuth > **UpdatePasswordAuth** = `object` #### Properties ##### username? > `optional` **username?**: `string` The username to use for authentication. ##### password? > `optional` **password?**: `string` The password to use for authentication. *** ### UpdatePostgresSourceOptions > **UpdatePostgresSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the PostgreSQL server. ##### port? > `optional` **port?**: `number` The port of the PostgreSQL server. ##### database? > `optional` **database?**: `string` The name of the database to connect to. ##### auth\_method? > `optional` **auth\_method?**: `"password_auth"` Authentication method. ##### password\_auth? > `optional` **password\_auth?**: [`UpdatePasswordAuth`](#updatepasswordauth) Required details for username/password authentication. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Whether to disable SSL for the connection. *** ### UpdatePublicKeyAuth > **UpdatePublicKeyAuth** = `object` #### Properties ##### public\_key? > `optional` **public\_key?**: `string` Public key This is the PKCS8 public key generated for keypair authentication. *** ### UpdateRedshiftAccessKeys > **UpdateRedshiftAccessKeys** = `object` #### Properties ##### password > **password**: `string` Password ##### access\_id > **access\_id**: `string` Bucket access ID ##### secret\_key > **secret\_key**: `string` Bucket secret key *** ### UpdateRedshiftServerlessSourceOptions > **UpdateRedshiftServerlessSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the Redshift Serverless server. ##### port? > `optional` **port?**: `number` The port of the Redshift Serverless server. ##### database? > `optional` **database?**: `string` The name of the database to connect to. ##### workgroup? > `optional` **workgroup?**: `string` The name of the Redshift Serverless workgroup. ##### region? > `optional` **region?**: `string` The AWS region of the Redshift Serverless workgroup. ##### auth\_method? > `optional` **auth\_method?**: `"aws_iam_role"` | `"aws_access_keys"` ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateRedshiftAccessKeys`](#updateredshiftaccesskeys) Required details for AWS access keys authentication. ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRole`](#awsiamrole) Required details for AWS IAM role authentication. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Whether to disable SSL for the connection. ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Duration to wait for successful connection. *** ### UpdateRedshiftSourceOptions > **UpdateRedshiftSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the Redshift server. ##### port? > `optional` **port?**: `number` The port of the Redshift server. ##### database? > `optional` **database?**: `string` The name of the database to connect to. ##### cluster? > `optional` **cluster?**: `string` The name of the Redshift cluster. ##### region? > `optional` **region?**: `string` The AWS region of the Redshift cluster. ##### workgroup? > `optional` **workgroup?**: `string` The name of the Redshift Serverless workgroup. ##### username? > `optional` **username?**: `string` The username for authentication. ##### auth\_method? > `optional` **auth\_method?**: `"aws_iam_role"` | `"aws_access_keys"` ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateRedshiftAccessKeys`](#updateredshiftaccesskeys) Required details for AWS access keys authentication. ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRole`](#awsiamrole) Required details for AWS IAM role authentication. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Whether to disable SSL for the connection. ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Duration to wait for successful connection. *** ### UpdateS3CompatibleSourceOptions > **UpdateS3CompatibleSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the S3-compatible server. ##### port? > `optional` **port?**: `number` The port of the S3-compatible server. ##### bucket\_name? > `optional` **bucket\_name?**: `string` The name of the S3-compatible bucket. ##### auth\_method? > `optional` **auth\_method?**: `"access_keys"` Authentication method. ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateAwsAccessKeys`](#updateawsaccesskeys) Required details for access key authentication. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Whether to disable SSL for the connection. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. *** ### UpdateS3SourceOptions > **UpdateS3SourceOptions** = `object` #### Properties ##### bucket\_name? > `optional` **bucket\_name?**: `string` The name of the S3 bucket. ##### region? > `optional` **region?**: `string` The AWS region of the S3 bucket. ##### auth\_method? > `optional` **auth\_method?**: `"aws_iam_role"` | `"aws_access_keys"` ##### aws\_iam\_role? > `optional` **aws\_iam\_role?**: [`AwsiamRole`](#awsiamrole) Required details for AWS IAM role authentication. ##### aws\_access\_keys? > `optional` **aws\_access\_keys?**: [`UpdateAwsAccessKeys`](#updateawsaccesskeys) Required details for AWS access keys authentication. ##### bucket\_host? > `optional` **bucket\_host?**: `string` The host address of the S3 bucket. ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. *** ### UpdateSftpSourceOptions > **UpdateSftpSourceOptions** = `object` #### Properties ##### username? > `optional` **username?**: `string` The username for the SFTP connection. ##### host? > `optional` **host?**: `string` The hostname of the SFTP server. ##### port? > `optional` **port?**: `number` The port of the SFTP server. ##### auth\_method? > `optional` **auth\_method?**: `"public_key_auth"` Authentication method. ##### public\_key\_auth? > `optional` **public\_key\_auth?**: [`UpdatePublicKeyAuth`](#updatepublickeyauth) Required details for public key authentication. *** ### UpdateSnowflakeSourceOptions > **UpdateSnowflakeSourceOptions** = `object` #### Properties ##### host? > `optional` **host?**: `string` The hostname of the Snowflake account. ##### port? > `optional` **port?**: `number` The port of the Snowflake server. ##### database? > `optional` **database?**: `string` The name of the database to connect to. ##### username? > `optional` **username?**: `string` The username for authentication. ##### auth\_method? > `optional` **auth\_method?**: `"public_key_auth"` ##### public\_key\_auth? > `optional` **public\_key\_auth?**: [`UpdatePublicKeyAuth`](#updatepublickeyauth) Required details for public key authentication. *** ### UpdateSourceOptions > **UpdateSourceOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Unique name for this import source. ##### vendor? > `readonly` `optional` **vendor?**: `string` ##### postgres? > `optional` **postgres?**: [`UpdatePostgresSourceOptions`](#updatepostgressourceoptions) PostgreSQL ##### redshift? > `optional` **redshift?**: [`UpdateRedshiftSourceOptions`](#updateredshiftsourceoptions) Amazon Redshift ##### redshift\_serverless? > `optional` **redshift\_serverless?**: [`UpdateRedshiftServerlessSourceOptions`](#updateredshiftserverlesssourceoptions) Amazon Redshift Serverless ##### bigquery? > `optional` **bigquery?**: [`UpdateBigQuerySourceOptions`](#updatebigquerysourceoptions) Google BigQuery ##### s3? > `optional` **s3?**: [`UpdateS3SourceOptions`](#updates3sourceoptions) Amazon S3 ##### abs? > `optional` **abs?**: [`UpdateAbsSourceOptions`](#updateabssourceoptions) Azure Blob Storage ##### sftp? > `optional` **sftp?**: [`UpdateSftpSourceOptions`](#updatesftpsourceoptions) SFTP ##### gcs? > `optional` **gcs?**: [`UpdateGcsSourceOptions`](#updategcssourceoptions) Google Cloud Storage ##### s3\_compatible? > `optional` **s3\_compatible?**: [`UpdateS3CompatibleSourceOptions`](#updates3compatiblesourceoptions) S3 Compatible ##### snowflake? > `optional` **snowflake?**: [`UpdateSnowflakeSourceOptions`](#updatesnowflakesourceoptions) Snowflake ##### delta\_sharing? > `optional` **delta\_sharing?**: [`UpdateDeltaSharingSourceOptions`](#updatedeltasharingsourceoptions) Delta Sharing *** ### UpdateSourceRequest > **UpdateSourceRequest** = `object` #### Properties ##### source > **source**: [`UpdateSourceOptions`](#updatesourceoptions) *** ### ListSourceTablesResponse > **ListSourceTablesResponse** = `object` #### Properties ##### tables > **tables**: [`SourceTable`](#sourcetable)\[] *** ### SourcePreviewSchemaField > **SourcePreviewSchemaField** = `object` #### Properties ##### name > **name**: `string` ##### raw\_type > **raw\_type**: `string` ##### prequel\_type > **prequel\_type**: `string` ##### ordinal\_position > **ordinal\_position**: `number` ##### is\_nullable? > `optional` **is\_nullable?**: `boolean` *** ### SourceTable > **SourceTable** = `object` #### Properties ##### namespace > **namespace**: `string` ##### name > **name**: `string` ##### columns > **columns**: [`SourcePreviewSchemaField`](#sourcepreviewschemafield)\[] *** ### GlobOptions > **GlobOptions** = `object` #### Properties ##### pattern > **pattern**: `string` Pattern Glob pattern for object files. ##### format > **format**: `"csv"` | `"parquet"` | `"jsonl"` | `"json"` Format Format of the object files. *** ### SQLOptions > **SQLOptions** = `object` #### Properties ##### query > **query**: `string` Query SQL query to execute. *** ### SourcePreviewOptions > **SourcePreviewOptions** = \{ `method`: `"table"`; `table`: [`TableOptions`](#tableoptions); } | \{ `method`: `"sql"`; `sql`: [`SQLOptions`](#sqloptions); } | \{ `method`: `"glob"`; `glob`: [`GlobOptions`](#globoptions); } #### Union Members ##### Type Literal \{ `method`: `"table"`; `table`: [`TableOptions`](#tableoptions); } ###### method > **method**: `"table"` ###### table > **table**: [`TableOptions`](#tableoptions) Table Configuration *** ##### Type Literal \{ `method`: `"sql"`; `sql`: [`SQLOptions`](#sqloptions); } ###### method > **method**: `"sql"` ###### sql > **sql**: [`SQLOptions`](#sqloptions) SQL Configuration *** ##### Type Literal \{ `method`: `"glob"`; `glob`: [`GlobOptions`](#globoptions); } ###### method > **method**: `"glob"` ###### glob > **glob**: [`GlobOptions`](#globoptions) Glob Configuration *** ### TableOptions > **TableOptions** = `object` #### Properties ##### source\_table\_namespace > **source\_table\_namespace**: `string` Source Table Namespace Namespace or schema of the source table. ##### source\_table\_name > **source\_table\_name**: `string` Source Table Name Name of the source table. *** ### SourceSchemaResponse > **SourceSchemaResponse** = `object` #### Properties ##### schema > **schema**: [`SourcePreviewSchemaField`](#sourcepreviewschemafield)\[] *** ### SourcePreviewResponse > **SourcePreviewResponse** = `object` #### Properties ##### schema > **schema**: [`SourcePreviewSchemaField`](#sourcepreviewschemafield)\[] ##### records > **records**: `unknown`\[] *** ### DatasetResource > **DatasetResource** = \{ `type`: `"dimension"`; `dimension`: [`DimensionResource`](#dimensionresource); } | \{ `type`: `"fact"`; `fact`: [`FactResource`](#factresource); } & \{ `method`: `"table"`; `table`: [`TableResource`](#tableresource); } | \{ `method`: `"sql"`; `sql`: [`SqlResource`](#sqlresource); } | \{ `method`: `"glob"`; `glob`: [`GlobResource`](#globresource); } & `object` #### Type Declaration ##### id > **id**: `string` ##### name > **name**: `string` ##### source\_id > **source\_id**: `string` ##### is\_enabled > **is\_enabled**: `boolean` ##### frequency\_minutes > **frequency\_minutes**: `number` ##### datalake\_schema > **datalake\_schema**: `string` ##### datalake\_table\_name > **datalake\_table\_name**: `string` ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### DimensionResource > **DimensionResource** = `object` #### Properties ##### primary\_key\_column > **primary\_key\_column**: `string` ##### last\_modified\_column? > `optional` **last\_modified\_column?**: `string` ##### is\_deleted\_column? > `optional` **is\_deleted\_column?**: `string` *** ### FactResource > **FactResource** = `object` #### Properties ##### primary\_key\_column > **primary\_key\_column**: `string` ##### created\_at\_column > **created\_at\_column**: `string` *** ### GlobResource > **GlobResource** = `object` #### Properties ##### pattern > **pattern**: `string` ##### format > **format**: `string` *** ### ListDatasetsResponse > **ListDatasetsResponse** = `object` #### Properties ##### datasets > **datasets**: [`DatasetResource`](#datasetresource)\[] *** ### SqlResource > **SqlResource** = `object` #### Properties ##### query > **query**: `string` *** ### TableResource > **TableResource** = `object` #### Properties ##### source\_table\_namespace > **source\_table\_namespace**: `string` ##### source\_table\_name > **source\_table\_name**: `string` *** ### CreateDatasetRequest > **CreateDatasetRequest** = `object` #### Properties ##### dataset > **dataset**: [`DatasetOptions`](#datasetoptions) *** ### DatasetOptions > **DatasetOptions** = \{ `type`: `"dimension"`; `dimension`: [`DimensionOptions`](#dimensionoptions); } | \{ `type`: `"fact"`; `fact`: [`FactOptions`](#factoptions); } & \{ `method`: `"table"`; `table`: [`TableOptions`](#tableoptions); } | \{ `method`: `"sql"`; `sql`: [`SQLOptions`](#sqloptions); } | \{ `method`: `"glob"`; `glob`: [`GlobOptions`](#globoptions); } & `object` #### Type Declaration ##### name? > `optional` **name?**: `string` Name Name of the dataset. ##### source\_id > **source\_id**: `string` Source ID ID of the import source this dataset belongs to. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Enabled Whether this dataset is enabled. ##### frequency\_minutes > **frequency\_minutes**: `number` Frequency Minutes Frequency in minutes for syncing this dataset. *** ### DimensionOptions > **DimensionOptions** = `object` #### Properties ##### primary\_key\_column > **primary\_key\_column**: `string` Primary Key Column Name of the primary key column. ##### last\_modified\_column? > `optional` **last\_modified\_column?**: `string` Last Modified Column Name of the last modified timestamp column (optional). ##### is\_deleted\_column? > `optional` **is\_deleted\_column?**: `string` Is Deleted Column Name of the soft delete column (optional). *** ### FactOptions > **FactOptions** = `object` #### Properties ##### primary\_key\_column > **primary\_key\_column**: `string` Primary Key Column Name of the primary key column. ##### created\_at\_column > **created\_at\_column**: `string` Created At Column Name of the created at timestamp column (required for facts). *** ### GetDatasetResponse > **GetDatasetResponse** = `object` #### Properties ##### dataset > **dataset**: [`DatasetResource`](#datasetresource) *** ### UpdateDatasetOptions > **UpdateDatasetOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Name of the dataset. ##### frequency\_minutes? > `optional` **frequency\_minutes?**: `number` Frequency in minutes for syncing this dataset. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Whether this dataset is enabled. *** ### UpdateDatasetRequest > **UpdateDatasetRequest** = `object` #### Properties ##### dataset > **dataset**: [`UpdateDatasetOptions`](#updatedatasetoptions) *** ### DatasetSchemaColumn > **DatasetSchemaColumn** = `object` #### Properties ##### column\_name > **column\_name**: `string` Column Name The name of the column in the dataset. ##### prequel\_type > **prequel\_type**: `string` Prequel Type The most recent normalized Prequel data type for this column. ##### source\_type > **source\_type**: `string` Source Type The most recent raw data type from the source for this column. ##### seen\_source\_types > **seen\_source\_types**: `string`\[] Seen Source Types All distinct raw source types seen historically for this column. ##### seen\_prequel\_types > **seen\_prequel\_types**: `string`\[] Seen Prequel Types All distinct normalized Prequel types seen historically for this column. ##### in\_latest\_extract > **in\_latest\_extract**: `boolean` In Latest Extract Indicates if this column was present in the most recent successful extract. ##### first\_seen\_at > **first\_seen\_at**: `string` First Seen At The timestamp when this column was first extracted. ##### last\_seen\_at > **last\_seen\_at**: `string` Last Seen At The timestamp when this column was most recently extracted. *** ### GetDatasetSchemaResponse > **GetDatasetSchemaResponse** = `object` #### Properties ##### columns > **columns**: [`DatasetSchemaColumn`](#datasetschemacolumn)\[] *** ### ErrorResource > **ErrorResource** = `object` #### Properties ##### error\_code > **error\_code**: `string` ##### title > **title**: `string` ##### blame > **blame**: `string` ##### documentation\_url > **documentation\_url**: `string` ##### trace > **trace**: `string` ##### message > **message**: `string` *** ### ExtractResource > **ExtractResource** = `object` #### Properties ##### id > **id**: `string` ##### dataset\_id > **dataset\_id**: `string` ##### submitted\_at > **submitted\_at**: `string` ##### started\_at? > `optional` **started\_at?**: `string` ##### ended\_at? > `optional` **ended\_at?**: `string` ##### records\_processed? > `optional` **records\_processed?**: `number` ##### records\_existing\_updated? > `optional` **records\_existing\_updated?**: `number` ##### records\_existing\_unchanged? > `optional` **records\_existing\_unchanged?**: `number` ##### records\_existing\_deleted? > `optional` **records\_existing\_deleted?**: `number` ##### records\_new\_inserted? > `optional` **records\_new\_inserted?**: `number` ##### records\_errored? > `optional` **records\_errored?**: `number` ##### error? > `optional` **error?**: [`ErrorResource`](#errorresource) *** ### DatasetRandomSampleRequest > **DatasetRandomSampleRequest** = `object` #### Properties ##### sample\_size > **sample\_size**: `number` *** ### DatasetRandomSampleResponse > **DatasetRandomSampleResponse** = `object` #### Properties ##### schema > **schema**: [`QueryResultSchemaField`](#queryresultschemafield)\[] ##### records > **records**: `unknown`\[] *** ### HttpRequestTemplate > **HttpRequestTemplate** = `object` #### Properties ##### method > **method**: `"GET"` | `"POST"` | `"PUT"` | `"PATCH"` | `"DELETE"` Method HTTP method for the request. ##### uri > **uri**: `string` URI Request URI with template variables. ##### headers? > `optional` **headers?**: `object` Headers HTTP headers. ###### Index Signature \[`key`: `string`]: `string` ##### body? > `optional` **body?**: `string` Body Request body template. *** ### WebhookBatchResource > **WebhookBatchResource** = `object` #### Properties ##### request\_template > **request\_template**: [`HttpRequestTemplate`](#httprequesttemplate) ##### format > **format**: `string` ##### max\_size\_per\_batch > **max\_size\_per\_batch**: `number` ##### max\_batches\_per\_minute > **max\_batches\_per\_minute**: `number` ##### max\_concurrency > **max\_concurrency**: `number` *** ### WebhookRecordResource > **WebhookRecordResource** = `object` #### Properties ##### request\_template > **request\_template**: [`HttpRequestTemplate`](#httprequesttemplate) ##### max\_records\_per\_minute > **max\_records\_per\_minute**: `number` ##### max\_concurrency > **max\_concurrency**: `number` *** ### WebhookBatchOptions > **WebhookBatchOptions** = `object` #### Properties ##### request\_template > **request\_template**: [`HttpRequestTemplate`](#httprequesttemplate) Request Template HTTP request template for sending batch data. ##### format > **format**: `"parquet"` | `"csv"` | `"json"` Format Batch file format. ##### max\_size\_per\_batch? > `optional` **max\_size\_per\_batch?**: `number` Max Size Per Batch Maximum records per batch. ##### max\_batches\_per\_minute? > `optional` **max\_batches\_per\_minute?**: `number` Max Batches Per Minute Rate limit for batches per minute. ##### max\_concurrency? > `optional` **max\_concurrency?**: `number` Max Concurrency Maximum concurrent request clients. *** ### WebhookRecordOptions > **WebhookRecordOptions** = `object` #### Properties ##### request\_template > **request\_template**: [`HttpRequestTemplate`](#httprequesttemplate) Request Template HTTP request template for records. ##### max\_records\_per\_minute? > `optional` **max\_records\_per\_minute?**: `number` Max Records Per Minute Rate limit for records per minute. ##### max\_concurrency? > `optional` **max\_concurrency?**: `number` Max Concurrency Maximum concurrent request clients. *** ### UpdateDestinationOptions > **UpdateDestinationOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Unique name for this destination. ##### type? > `optional` **type?**: `"webhook_record"` | `"webhook_batch"` Destination type. ##### record\_schema? > `optional` **record\_schema?**: `unknown` JSON Schema for validating records (JSON5 supported). ##### webhook\_record? > `optional` **webhook\_record?**: [`UpdateWebhookRecordOptions`](#updatewebhookrecordoptions) HTTP Record Configuration ##### webhook\_batch? > `optional` **webhook\_batch?**: [`UpdateWebhookBatchOptions`](#updatewebhookbatchoptions) HTTP Batch Configuration *** ### UpdateDestinationRequest > **UpdateDestinationRequest** = `object` #### Properties ##### destination > **destination**: [`UpdateDestinationOptions`](#updatedestinationoptions) *** ### UpdateWebhookBatchOptions > **UpdateWebhookBatchOptions** = `object` #### Properties ##### request\_template? > `optional` **request\_template?**: [`HttpRequestTemplate`](#httprequesttemplate) HTTP request template for sending batch data. ##### format? > `optional` **format?**: `"parquet"` | `"csv"` | `"json"` ##### max\_size\_per\_batch? > `optional` **max\_size\_per\_batch?**: `number` Maximum records per batch. ##### max\_batches\_per\_minute? > `optional` **max\_batches\_per\_minute?**: `number` Rate limit for batches per minute. ##### max\_concurrency? > `optional` **max\_concurrency?**: `number` Maximum concurrent request clients. *** ### UpdateWebhookRecordOptions > **UpdateWebhookRecordOptions** = `object` #### Properties ##### request\_template? > `optional` **request\_template?**: [`HttpRequestTemplate`](#httprequesttemplate) HTTP request template for records. ##### max\_records\_per\_minute? > `optional` **max\_records\_per\_minute?**: `number` Rate limit for records per minute. ##### max\_concurrency? > `optional` **max\_concurrency?**: `number` Maximum concurrent request clients. *** ### ListProductsResponse > **ListProductsResponse** = `object` #### Properties ##### products > **products**: [`ProductResource`](#productresource)\[] *** ### ProductResource > **ProductResource** = `object` #### Properties ##### id > **id**: `string` ##### name > **name**: `string` ##### description? > `optional` **description?**: `string` ##### destinations > **destinations**: `string`\[] ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### GetProductResponse > **GetProductResponse** = `object` #### Properties ##### product > **product**: [`ProductResource`](#productresource) *** ### ListStreamsResponse > **ListStreamsResponse** = `object` #### Properties ##### streams > **streams**: [`StreamResource`](#streamresource)\[] *** ### MappingResource > **MappingResource** = `object` #### Properties ##### field\_type > **field\_type**: `string` ##### column? > `optional` **column?**: `object` ###### Index Signature \[`key`: `string`]: `string` ##### expression? > `optional` **expression?**: `object` ###### Index Signature \[`key`: `string`]: `string` ##### target\_field > **target\_field**: `string` *** ### StreamResource > **StreamResource** = `object` #### Properties ##### id > **id**: `string` ##### name > **name**: `string` ##### is\_enabled > **is\_enabled**: `boolean` ##### destination\_is\_circuit\_broken > **destination\_is\_circuit\_broken**: `boolean` ##### destination\_id > **destination\_id**: `string` ##### dataset\_id > **dataset\_id**: `string` ##### mappings > **mappings**: [`MappingResource`](#mappingresource)\[] ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` *** ### MappingOptions > **MappingOptions** = `object` #### Properties ##### field\_type > **field\_type**: `string` Field Type Type of field mapping (field or expression). ##### column? > `optional` **column?**: `object` Column Column reference for field type mappings. ###### Index Signature \[`key`: `string`]: `string` ##### expression? > `optional` **expression?**: `object` Expression Configuration for expression field mappings. ###### Index Signature \[`key`: `string`]: `string` ##### target\_field > **target\_field**: `string` Target Field The target field name in the destination. *** ### StreamOptions > **StreamOptions** = `object` #### Properties ##### name > **name**: `string` Name Name for this stream. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Is Enabled Whether this stream is enabled. ##### destination\_is\_circuit\_broken? > `optional` **destination\_is\_circuit\_broken?**: `boolean` Destination Is Circuit Broken Whether the destination is failing continuously. ##### destination\_id > **destination\_id**: `string` Destination ID The ID of the destination this stream connects to. ##### dataset\_id > **dataset\_id**: `string` Dataset ID The ID of the dataset this stream uses as source. ##### mappings > **mappings**: [`MappingOptions`](#mappingoptions)\[] Mappings Field mappings for this stream. *** ### GetStreamResponse > **GetStreamResponse** = `object` #### Properties ##### stream > **stream**: [`StreamResource`](#streamresource) *** ### UpdateStreamOptions > **UpdateStreamOptions** = `object` #### Properties ##### name? > `optional` **name?**: `string` Name for this stream. ##### is\_enabled? > `optional` **is\_enabled?**: `boolean` Whether this stream is enabled. ##### destination\_is\_circuit\_broken? > `optional` **destination\_is\_circuit\_broken?**: `boolean` Whether the destination is failing continuously. ##### mappings? > `optional` **mappings?**: [`MappingOptions`](#mappingoptions)\[] Field mappings for this stream. *** ### LoadResource > **LoadResource** = `object` #### Properties ##### id > **id**: `string` ##### stream\_id > **stream\_id**: `string` ##### submitted\_at > **submitted\_at**: `string` ##### started\_at? > `optional` **started\_at?**: `string` ##### ended\_at? > `optional` **ended\_at?**: `string` ##### records\_processed? > `optional` **records\_processed?**: `number` ##### records\_transformed? > `optional` **records\_transformed?**: `number` ##### records\_valid? > `optional` **records\_valid?**: `number` ##### records\_loaded? > `optional` **records\_loaded?**: `number` ##### records\_errored? > `optional` **records\_errored?**: `number` ##### error? > `optional` **error?**: [`ErrorResource`](#errorresource) ##### record\_ids? > `optional` **record\_ids?**: `string`\[] ##### actor\_id > **actor\_id**: `string` ##### actor\_type > **actor\_type**: `string` *** ### TestStreamTransformRequest > **TestStreamTransformRequest** = `object` #### Properties ##### record\_ids > **record\_ids**: `string`\[] Record IDs List of specific record IDs to test the transformation against. ##### stream? > `optional` **stream?**: [`UpdateStreamOptions`](#updatestreamoptions) Stream Optional partial stream patch merged onto the saved stream to preview transform output without persisting. *** ### TestStreamTransformResponse > **TestStreamTransformResponse** = `object` #### Properties ##### schema > **schema**: [`QueryResultSchemaField`](#queryresultschemafield)\[] ##### records > **records**: `unknown`\[] *** ### TestNewStreamRequest > **TestNewStreamRequest** = `object` #### Properties ##### stream > **stream**: [`StreamOptions`](#streamoptions) Stream Candidate stream definition to test. ##### record\_ids > **record\_ids**: `string`\[] Record IDs List of specific record IDs to test the transformation against. *** ### TestNewSourceRequest > **TestNewSourceRequest** = `object` #### Properties ##### source > **source**: [`SourceOptions`](#sourceoptions) Source Candidate source definition to test. *** ### TestSourceResponse > **TestSourceResponse** = `object` #### Properties ##### code? > `optional` **code?**: `string` ##### message? > `optional` **message?**: `string` *** ### TestSourceRequest > **TestSourceRequest** = `object` #### Properties ##### source? > `optional` **source?**: [`UpdateSourceOptions`](#updatesourceoptions) Source Optional partial source patch merged onto the saved source to test connection without persisting. *** ### ListExtractsResponse > **ListExtractsResponse** = `object` #### Properties ##### extracts > **extracts**: [`ExtractResource`](#extractresource)\[] *** ### GetExtractResponse > **GetExtractResponse** = `object` #### Properties ##### extract > **extract**: [`ExtractResource`](#extractresource) *** ### DebugError > **DebugError** = `object` #### Properties ##### error\_code > **error\_code**: `string` ##### error\_trace > **error\_trace**: `string` *** ### ExtractDebugRecord > **ExtractDebugRecord** = `object` #### Properties ##### record\_id > **record\_id**: `string` ##### event\_timestamp > **event\_timestamp**: `string` ##### extract? > `optional` **extract?**: [`ExtractDebugStage`](#extractdebugstage) *** ### ExtractDebugResponse > **ExtractDebugResponse** = `object` #### Properties ##### records > **records**: [`ExtractDebugRecord`](#extractdebugrecord)\[] *** ### ExtractDebugStage > **ExtractDebugStage** = `object` #### Properties ##### last\_seen\_at > **last\_seen\_at**: `string` ##### last\_extracted\_at > **last\_extracted\_at**: `string` ##### last\_modified\_in\_source\_at? > `optional` **last\_modified\_in\_source\_at?**: `string` ##### error? > `optional` **error?**: [`DebugError`](#debugerror) ##### is\_deleted? > `optional` **is\_deleted?**: `boolean` *** ### ListLoadsResponse > **ListLoadsResponse** = `object` #### Properties ##### loads > **loads**: [`LoadResource`](#loadresource)\[] *** ### GetLoadResponse > **GetLoadResponse** = `object` #### Properties ##### load > **load**: [`LoadResource`](#loadresource) *** ### TestExpressionRequest > **TestExpressionRequest** = `object` #### Properties ##### data > **data**: `string` The data to use for the expression evaluation. ##### expr > **expr**: `string` The expression to evaluate. *** ### TestExpressionResponse > **TestExpressionResponse** = `object` #### Properties ##### result? > `optional` **result?**: `unknown` The result of the expression evaluation. ##### error? > `optional` **error?**: `string` The error returned by the expression evaluation. *** ### SSHKeyResponse > **SSHKeyResponse** = `object` #### Properties ##### public\_key > **public\_key**: `string` Public key used to verify Prequel-generated signatures. Formatted as a SSH-RSA public key. ##### public\_key\_pkcs8 > **public\_key\_pkcs8**: `string` Public key used to verify Prequel key pair auth. Formatted as a PKCS#8 PEM-encoded public key. *** ### SourceFormFieldAttributes > **SourceFormFieldAttributes** = `object` #### Properties ##### label > **label**: `string` ##### description? > `optional` **description?**: `string` ##### placeholder? > `optional` **placeholder?**: `string` ##### form\_element > **form\_element**: `string` ##### input\_type? > `optional` **input\_type?**: `string` ##### key\_format? > `optional` **key\_format?**: `string` *** ### BigQuerySourceOptionsGcpServiceAccountRole > **BigQuerySourceOptionsGcpServiceAccountRole** = `object` GCP Service Account #### Properties ##### project\_id > **project\_id**: `string` Project ID ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"gcp_service_account_role"` ##### gcp\_service\_account\_role > **gcp\_service\_account\_role**: [`GcpServiceAccountRole`](#gcpserviceaccountrole) GCP Service Account Required details if authenticating using a GCP service account role. *** ### BigQuerySourceOptionsFederatedGcpServiceAccountRole > **BigQuerySourceOptionsFederatedGcpServiceAccountRole** = `object` Federation #### Properties ##### project\_id > **project\_id**: `string` Project ID ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"federated_gcp_service_account_role"` ##### federated\_gcp\_service\_account\_role > **federated\_gcp\_service\_account\_role**: [`FederatedGcpServiceAccountRole`](#federatedgcpserviceaccountrole) Federation Required details if authenticating using a GCP service account role. *** ### BigQuerySourceOptionsGcpServiceAccountKey > **BigQuerySourceOptionsGcpServiceAccountKey** = `object` Direct Access #### Properties ##### project\_id > **project\_id**: `string` Project ID ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"gcp_service_account_key"` ##### gcp\_service\_account\_key > **gcp\_service\_account\_key**: [`GcpSourceServiceAccountKey`](#gcpsourceserviceaccountkey) Direct Access Required details if authenticating using a GCP service account key. *** ### DeltaSharingSourceOptionsBearerToken > **DeltaSharingSourceOptionsBearerToken** = `object` Bearer Token #### Properties ##### host > **host**: `string` Host Host address of the Delta Sharing server. ##### port > **port**: `number` Port ##### auth\_method > **auth\_method**: `"bearer_token"` ##### bearer\_token > **bearer\_token**: [`BearerTokenAuth`](#bearertokenauth) Bearer Token Required details for bearer token authentication. *** ### DeltaSharingSourceOptionsOAuth2 > **DeltaSharingSourceOptionsOAuth2** = `object` OAuth2 #### Properties ##### host > **host**: `string` Host Host address of the Delta Sharing server. ##### port > **port**: `number` Port ##### auth\_method > **auth\_method**: `"oauth2"` ##### oauth2 > **oauth2**: [`OAuthAuth`](#oauthauth) OAuth2 Required details for OAuth2 authentication. *** ### GcsSourceOptionsGcpServiceAccountRole > **GcsSourceOptionsGcpServiceAccountRole** = `object` GCP Service Account #### Properties ##### bucket\_name > **bucket\_name**: `string` GCS bucket name ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"gcp_service_account_role"` ##### gcp\_service\_account\_role > **gcp\_service\_account\_role**: [`GcpServiceAccountRole`](#gcpserviceaccountrole) GCP Service Account Required details if authenticating using a GCP service account role. *** ### GcsSourceOptionsFederatedGcpServiceAccountRole > **GcsSourceOptionsFederatedGcpServiceAccountRole** = `object` Federation #### Properties ##### bucket\_name > **bucket\_name**: `string` GCS bucket name ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"federated_gcp_service_account_role"` ##### federated\_gcp\_service\_account\_role > **federated\_gcp\_service\_account\_role**: [`FederatedGcpServiceAccountRole`](#federatedgcpserviceaccountrole) Federation Required details if authenticating using a GCP service account role. *** ### GcsSourceOptionsGcshmacKeys > **GcsSourceOptionsGcshmacKeys** = `object` GCS HMAC Keys #### Properties ##### bucket\_name > **bucket\_name**: `string` GCS bucket name ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"gcs_hmac_keys"` ##### gcs\_hmac\_keys > **gcs\_hmac\_keys**: [`GcsAccessKeys`](#gcsaccesskeys) GCS HMAC Keys Required details if authenticating using GCS HMAC keys. *** ### GcsSourceOptionsGcpServiceAccountKey > **GcsSourceOptionsGcpServiceAccountKey** = `object` Direct Access #### Properties ##### bucket\_name > **bucket\_name**: `string` GCS bucket name ##### region > **region**: `string` Region ##### auth\_method > **auth\_method**: `"gcp_service_account_key"` ##### gcp\_service\_account\_key > **gcp\_service\_account\_key**: [`GcpSourceServiceAccountKey`](#gcpsourceserviceaccountkey) Direct Access Required details if authenticating using a GCP service account key. *** ### RedshiftServerlessSourceOptionsAwsAccessKeys > **RedshiftServerlessSourceOptionsAwsAccessKeys** = `object` AWS Access Keys #### Properties ##### host > **host**: `string` Host Host address of the Redshift Serverless workgroup. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### workgroup > **workgroup**: `string` Workgroup Redshift Serverless Workgroup name ##### region > **region**: `string` Region AWS Region identifier ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Connection Timeout Duration to wait for successful connection ##### auth\_method > **auth\_method**: `"aws_access_keys"` ##### aws\_access\_keys > **aws\_access\_keys**: [`RedshiftAccessKeys`](#redshiftaccesskeys) AWS Access Keys Required details for AWS access keys authentication. *** ### RedshiftServerlessSourceOptionsAwsiamRole > **RedshiftServerlessSourceOptionsAwsiamRole** = `object` AWS IAM Role #### Properties ##### host > **host**: `string` Host Host address of the Redshift Serverless workgroup. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### workgroup > **workgroup**: `string` Workgroup Redshift Serverless Workgroup name ##### region > **region**: `string` Region AWS Region identifier ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Connection Timeout Duration to wait for successful connection ##### auth\_method > **auth\_method**: `"aws_iam_role"` ##### aws\_iam\_role > **aws\_iam\_role**: [`AwsiamRole`](#awsiamrole) AWS IAM Role Required details for AWS IAM role authentication. *** ### RedshiftSourceOptionsAwsAccessKeys > **RedshiftSourceOptionsAwsAccessKeys** = `object` AWS Access Keys #### Properties ##### host > **host**: `string` Host Host address of the Redshift cluster. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### cluster > **cluster**: `string` Cluster Redshift Cluster identifier ##### region > **region**: `string` Region AWS Region identifier ##### username > **username**: `string` Username ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Connection Timeout Duration to wait for successful connection ##### auth\_method > **auth\_method**: `"aws_access_keys"` ##### aws\_access\_keys > **aws\_access\_keys**: [`RedshiftAccessKeys`](#redshiftaccesskeys) AWS Access Keys Required details for AWS access keys authentication. *** ### RedshiftSourceOptionsAwsiamRole > **RedshiftSourceOptionsAwsiamRole** = `object` AWS IAM Role #### Properties ##### host > **host**: `string` Host Host address of the Redshift cluster. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### cluster > **cluster**: `string` Cluster Redshift Cluster identifier ##### region > **region**: `string` Region AWS Region identifier ##### username > **username**: `string` Username ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### disable\_ssl? > `optional` **disable\_ssl?**: `boolean` Disable SSL ##### connection\_timeout\_in\_seconds? > `optional` **connection\_timeout\_in\_seconds?**: `number` Connection Timeout Duration to wait for successful connection ##### auth\_method > **auth\_method**: `"aws_iam_role"` ##### aws\_iam\_role > **aws\_iam\_role**: [`AwsiamRole`](#awsiamrole) AWS IAM Role Required details for AWS IAM role authentication. *** ### S3SourceOptionsAwsiamRole > **S3SourceOptionsAwsiamRole** = `object` AWS IAM Role #### Properties ##### bucket\_name > **bucket\_name**: `string` S3 bucket name ##### region > **region**: `string` Region ##### bucket\_host? > `optional` **bucket\_host?**: `string` Bucket host ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### auth\_method > **auth\_method**: `"aws_iam_role"` ##### aws\_iam\_role > **aws\_iam\_role**: [`AwsiamRole`](#awsiamrole) AWS IAM Role Required details for AWS IAM role authentication. *** ### S3SourceOptionsAwsAccessKeys > **S3SourceOptionsAwsAccessKeys** = `object` AWS Access Keys #### Properties ##### bucket\_name > **bucket\_name**: `string` S3 bucket name ##### region > **region**: `string` Region ##### bucket\_host? > `optional` **bucket\_host?**: `string` Bucket host ##### use\_ssh\_tunnel? > `optional` **use\_ssh\_tunnel?**: `boolean` Use SSH Tunnel Whether to use an SSH tunnel for the connection. ##### ssh\_tunnel? > `optional` **ssh\_tunnel?**: [`SshTunnelParams`](#sshtunnelparams) Required details if using SSH tunneling. ##### auth\_method > **auth\_method**: `"aws_access_keys"` ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeys`](#awsaccesskeys) AWS Access Keys Required details for AWS access keys authentication. *** ### SnowflakeSourceOptionsPublicKeyAuth > **SnowflakeSourceOptionsPublicKeyAuth** = `object` Key Pair Authentication #### Properties ##### host > **host**: `string` Account host Host address of the Snowflake account. ##### port > **port**: `number` Port ##### database > **database**: `string` Database Name of the database. ##### username > **username**: `string` Username ##### auth\_method > **auth\_method**: `"public_key_auth"` ##### public\_key\_auth > **public\_key\_auth**: [`PublicKeyAuth`](#publickeyauth) Key Pair Authentication Required details for public key authentication. *** ### GcsDatalakeResourceGcpServiceAccountRole > **GcsDatalakeResourceGcpServiceAccountRole** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### auth\_method > **auth\_method**: `"gcp_service_account_role"` ##### gcp\_service\_account\_role > **gcp\_service\_account\_role**: [`GcpDatalakeServiceAccountRoleResource`](#gcpdatalakeserviceaccountroleresource) *** ### GcsDatalakeResourceGcpServiceAccountKey > **GcsDatalakeResourceGcpServiceAccountKey** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### auth\_method > **auth\_method**: `"gcp_service_account_key"` ##### gcp\_service\_account\_key > **gcp\_service\_account\_key**: [`GcpDatalakeServiceAccountKeyResource`](#gcpdatalakeserviceaccountkeyresource) *** ### GcsDatalakeResourceFederatedGcpServiceAccountRole > **GcsDatalakeResourceFederatedGcpServiceAccountRole** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### auth\_method > **auth\_method**: `"federated_gcp_service_account_role"` ##### federated\_gcp\_service\_account\_role > **federated\_gcp\_service\_account\_role**: [`FederatedGcpDatalakeServiceAccountRoleResource`](#federatedgcpdatalakeserviceaccountroleresource) *** ### S3DatalakeResourceAwsiamRole > **S3DatalakeResourceAwsiamRole** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### auth\_method > **auth\_method**: `"aws_iam_role"` ##### aws\_iam\_role > **aws\_iam\_role**: [`AwsiamRoleResource`](#awsiamroleresource) *** ### S3DatalakeResourceAwsAccessKeys > **S3DatalakeResourceAwsAccessKeys** = `object` #### Properties ##### prefix > **prefix**: `string` ##### bucket\_name > **bucket\_name**: `string` ##### bucket\_region > **bucket\_region**: `string` ##### auth\_method > **auth\_method**: `"aws_access_keys"` ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeysResource`](#awsaccesskeysresource) *** ### GcsDatalakeOptionsGcpServiceAccountRole > **GcsDatalakeOptionsGcpServiceAccountRole** = `object` #### Properties ##### prefix > **prefix**: `string` Prefix to use for the GCS bucket. ##### bucket\_name > **bucket\_name**: `string` Bucket Name ##### bucket\_region > **bucket\_region**: `string` Region GCS region (e.g. us-central1). ##### auth\_method > **auth\_method**: `"gcp_service_account_role"` ##### gcp\_service\_account\_role > **gcp\_service\_account\_role**: [`GcpDatalakeServiceAccountRole`](#gcpdatalakeserviceaccountrole) *** ### GcsDatalakeOptionsGcpServiceAccountKey > **GcsDatalakeOptionsGcpServiceAccountKey** = `object` #### Properties ##### prefix > **prefix**: `string` Prefix to use for the GCS bucket. ##### bucket\_name > **bucket\_name**: `string` Bucket Name ##### bucket\_region > **bucket\_region**: `string` Region GCS region (e.g. us-central1). ##### auth\_method > **auth\_method**: `"gcp_service_account_key"` ##### gcp\_service\_account\_key > **gcp\_service\_account\_key**: [`GcpDatalakeServiceAccountKey`](#gcpdatalakeserviceaccountkey) *** ### GcsDatalakeOptionsFederatedGcpServiceAccountRole > **GcsDatalakeOptionsFederatedGcpServiceAccountRole** = `object` #### Properties ##### prefix > **prefix**: `string` Prefix to use for the GCS bucket. ##### bucket\_name > **bucket\_name**: `string` Bucket Name ##### bucket\_region > **bucket\_region**: `string` Region GCS region (e.g. us-central1). ##### auth\_method > **auth\_method**: `"federated_gcp_service_account_role"` ##### federated\_gcp\_service\_account\_role > **federated\_gcp\_service\_account\_role**: [`FederatedGcpDatalakeServiceAccountRole`](#federatedgcpdatalakeserviceaccountrole) Required details if authenticating using Workload Identity Federation. *** ### S3DatalakeOptionsAwsiamRole > **S3DatalakeOptionsAwsiamRole** = `object` #### Properties ##### bucket\_name > **bucket\_name**: `string` Bucket Name Name of the S3 bucket. ##### prefix > **prefix**: `string` Prefix to use for the S3 bucket. ##### bucket\_region > **bucket\_region**: `string` Region AWS region where the bucket is located. ##### auth\_method > **auth\_method**: `"aws_iam_role"` ##### aws\_iam\_role > **aws\_iam\_role**: [`AwsiamRole`](#awsiamrole) *** ### S3DatalakeOptionsAwsAccessKeys > **S3DatalakeOptionsAwsAccessKeys** = `object` #### Properties ##### bucket\_name > **bucket\_name**: `string` Bucket Name Name of the S3 bucket. ##### prefix > **prefix**: `string` Prefix to use for the S3 bucket. ##### bucket\_region > **bucket\_region**: `string` Region AWS region where the bucket is located. ##### auth\_method > **auth\_method**: `"aws_access_keys"` ##### aws\_access\_keys > **aws\_access\_keys**: [`AwsAccessKeys`](#awsaccesskeys) Required details if authenticating using AWS access keys. *** ### BigQuerySourceResourceGcpServiceAccountRole > **BigQuerySourceResourceGcpServiceAccountRole** = `object` #### Properties ##### project\_id > **project\_id**: `string` ##### region > **region**: `string` ##### auth\_method > **auth\_method**: `"gcp_service_account_role"` ##### gcp\_service\_account\_role > **gcp\_service\_account\_role**: [`GcpServiceAccountRoleResource`](#gcpserviceaccountroleresource) *** ### BigQuerySourceResourceFederatedGcpServiceAccountRole > **BigQuerySourceResourceFederatedGcpServiceAccountRole** = `object` #### Properties ##### project\_id > **project\_id**: `string` ##### region > **region**: `string` ##### auth\_method > **auth\_method**: `"federated_gcp_service_account_role"` ##### federated\_gcp\_service\_account\_role > **federated\_gcp\_service\_account\_role**: [`FederatedGcpServiceAccountRoleResource`](#federatedgcpserviceaccountroleresource) *** ### BigQuerySourceResourceGcpServiceAccountKey > **BigQuerySourceResourceGcpServiceAccountKey** = `object` #### Properties ##### project\_id > **project\_id**: `string` ##### region > **region**: `string` ##### auth\_method > **auth\_method**: `"gcp_service_account_key"` ##### gcp\_service\_account\_key > **gcp\_service\_account\_key**: [`GcpServiceAccountKeyResource`](#gcpserviceaccountkeyresource) *** ### DatasetFrequencyMinutes > **DatasetFrequencyMinutes** = *typeof* [`DATASET_FREQUENCY_MINUTES`](#dataset_frequency_minutes)\[`number`] *** ### DestinationResource > **DestinationResource** = `object` #### Properties ##### id > **id**: `string` ##### name > **name**: `string` ##### type > **type**: `string` ##### created\_at > **created\_at**: `string` ##### updated\_at > **updated\_at**: `string` ##### webhook\_record? > `optional` **webhook\_record?**: [`WebhookRecordResource`](#webhookrecordresource) ##### webhook\_batch? > `optional` **webhook\_batch?**: [`WebhookBatchResource`](#webhookbatchresource) ##### record\_schema > **record\_schema**: `unknown` *** ### GetDestinationResponse > **GetDestinationResponse** = `object` #### Properties ##### destination > **destination**: [`DestinationResource`](#destinationresource) *** ### ListDestinationsResponse > **ListDestinationsResponse** = `object` #### Properties ##### destinations > **destinations**: [`DestinationResource`](#destinationresource)\[] *** ### SourceFormEnumObject > **SourceFormEnumObject** = `object` #### Properties ##### key > **key**: `unknown` ##### display > **display**: `string` ##### icon\_url? > `optional` **icon\_url?**: `string` ##### disabled? > `optional` **disabled?**: `boolean` *** ### SourceFormField > **SourceFormField** = `object` #### Properties ##### path > **path**: `string` ##### name > **name**: `string` ##### parent? > `optional` **parent?**: `unknown` ##### type > **type**: `string` ##### required > **required**: `boolean` ##### read\_only? > `optional` **read\_only?**: `boolean` ##### refetch\_on\_change > **refetch\_on\_change**: `boolean` ##### const? > `optional` **const?**: `unknown` ##### default? > `optional` **default?**: `unknown` ##### enum? > `optional` **enum?**: [`SourceFormEnumObject`](#sourceformenumobject)\[] ##### attributes > **attributes**: [`SourceFormFieldAttributes`](#sourceformfieldattributes) *** ### SourceFormResponse > **SourceFormResponse** = `object` #### Properties ##### fields > **fields**: [`SourceFormField`](#sourceformfield)\[] *** ### SourceConnectionTestResult > **SourceConnectionTestResult** = `object` #### Properties ##### status > **status**: `"success"` | `"error"` ##### code? > `optional` **code?**: `string` ##### message? > `optional` **message?**: `string` *** ### DeepPartial > **DeepPartial**\<`T`> = `T` *extends* `object` ? `{ [K in keyof T]?: DeepPartial }` : `T` #### Type Parameters | Type Parameter | | -------------- | | `T` | *** ### SourceFormSource > **SourceFormSource** = [`DeepPartial`](#deeppartial)\<[`SourceOptions`](#sourceoptions)> & `object` #### Type Declaration ##### provider\_id? > `optional` **provider\_id?**: `string` ##### name? > `optional` **name?**: `string` ##### vendor? > `optional` **vendor?**: `string` ## Variables ### DATASET\_FREQUENCY\_MINUTES > `const` **DATASET\_FREQUENCY\_MINUTES**: readonly \[`10`, `15`, `60`, `360`, `720`, `1440`]