bigquery library

BigQuery datasets, tables, jobs, routines, transfers, reservations, capacity commitments, external connections, and per-resource IAM bindings.

Classes

AppConstant<T>: A value the Stack hands to application code as a static const in the generated AppExports file — known when synth runs, so the app compiles against it.
AppExports: Where synth writes the Dart file application code imports: the Stack's constants, as the static const members of <name>Constants, and a typed reader of its Terraform outputs, <name>Outputs.
AttributeRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.attribute() may construct instances.
BigqueryAnalyticsHubDataExchangeDcrExchangeConfig: Typed helper for the sharing_environment_config.dcr_exchange_config block of google_bigquery_analytics_hub_data_exchange (derived from provider schema).
BigqueryAnalyticsHubDataExchangeDefaultExchangeConfig: Typed helper for the sharing_environment_config.default_exchange_config block of google_bigquery_analytics_hub_data_exchange (derived from provider schema).
BigqueryAnalyticsHubDataExchangeIamBindingCondition: Typed helper for the condition block of google_bigquery_analytics_hub_data_exchange_iam_binding (derived from provider schema).
BigqueryAnalyticsHubDataExchangeIamMemberCondition: Typed helper for the condition block of google_bigquery_analytics_hub_data_exchange_iam_member (derived from provider schema).
BigqueryAnalyticsHubDataExchangeSharingEnvironmentConfig: Exactly one of default_exchange_config, dcr_exchange_config on the sharing_environment_config block of google_bigquery_analytics_hub_data_exchange: the provider rejects none and more than one, so each variant sets one of them.
BigqueryAnalyticsHubDataExchangeSharingEnvironmentConfigDcrExchangeConfig: The BigqueryAnalyticsHubDataExchangeSharingEnvironmentConfig.dcrExchangeConfig choice: sets dcr_exchange_config.
BigqueryAnalyticsHubDataExchangeSharingEnvironmentConfigDefaultExchangeConfig: The BigqueryAnalyticsHubDataExchangeSharingEnvironmentConfig.defaultExchangeConfig choice: sets default_exchange_config.
BigqueryAnalyticsHubListingBigqueryDataset: Typed helper for the bigquery_dataset block of google_bigquery_analytics_hub_listing (derived from provider schema).
BigqueryAnalyticsHubListingDataProvider: Typed helper for the data_provider block of google_bigquery_analytics_hub_listing (derived from provider schema).
BigqueryAnalyticsHubListingIamBindingCondition: Typed helper for the condition block of google_bigquery_analytics_hub_listing_iam_binding (derived from provider schema).
BigqueryAnalyticsHubListingIamMemberCondition: Typed helper for the condition block of google_bigquery_analytics_hub_listing_iam_member (derived from provider schema).
BigqueryAnalyticsHubListingPublisher: Typed helper for the publisher block of google_bigquery_analytics_hub_listing (derived from provider schema).
BigqueryAnalyticsHubListingPubsubTopic: Typed helper for the pubsub_topic block of google_bigquery_analytics_hub_listing (derived from provider schema).
BigqueryAnalyticsHubListingRestrictedExportConfig: Typed helper for the restricted_export_config block of google_bigquery_analytics_hub_listing (derived from provider schema).
BigqueryAnalyticsHubListingSelectedResources: Exactly one of table, routine on the bigquery_dataset.selected_resources block of google_bigquery_analytics_hub_listing: the provider rejects none and more than one, so each variant sets one of them.
BigqueryAnalyticsHubListingSelectedResourcesRoutine: The BigqueryAnalyticsHubListingSelectedResources.routine choice: sets routine.
BigqueryAnalyticsHubListingSelectedResourcesTable: The BigqueryAnalyticsHubListingSelectedResources.table choice: sets table.
BigqueryAnalyticsHubListingSource: Exactly one of pubsub_topic, bigquery_dataset on google_bigquery_analytics_hub_listing: the provider rejects none and more than one, so each variant sets one of them.
BigqueryAnalyticsHubListingSourceBigqueryDataset: The BigqueryAnalyticsHubListingSource.bigqueryDataset choice: sets bigquery_dataset.
BigqueryAnalyticsHubListingSourcePubsubTopic: The BigqueryAnalyticsHubListingSource.pubsubTopic choice: sets pubsub_topic.
BigqueryAnalyticsHubListingSubscriptionAvroConfig: Typed helper for the destination_pubsub_subscription.pubsub_subscription.cloud_storage_config.avro_config block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionBigqueryConfig: Typed helper for the destination_pubsub_subscription.pubsub_subscription.bigquery_config block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionCloudStorageConfig: Typed helper for the destination_pubsub_subscription.pubsub_subscription.cloud_storage_config block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionDatasetReference: Typed helper for the destination_dataset.dataset_reference block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionDeadLetterPolicy: Typed helper for the destination_pubsub_subscription.pubsub_subscription.dead_letter_policy block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionDestination: Exactly one of destination_dataset, destination_pubsub_subscription on google_bigquery_analytics_hub_listing_subscription: the provider rejects none and more than one, so each variant sets one of them.
BigqueryAnalyticsHubListingSubscriptionDestinationDataset: Typed helper for the destination_dataset block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionDestinationDatasetChoice: The BigqueryAnalyticsHubListingSubscriptionDestination.destinationDataset choice: sets destination_dataset.
BigqueryAnalyticsHubListingSubscriptionDestinationPubsubSubscription: Typed helper for the destination_pubsub_subscription block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionDestinationPubsubSubscriptionChoice: The BigqueryAnalyticsHubListingSubscriptionDestination.destinationPubsubSubscription choice: sets destination_pubsub_subscription.
BigqueryAnalyticsHubListingSubscriptionExpirationPolicy: Typed helper for the destination_pubsub_subscription.pubsub_subscription.expiration_policy block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionNoWrapper: Typed helper for the destination_pubsub_subscription.pubsub_subscription.push_config.no_wrapper block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionOidcToken: Typed helper for the destination_pubsub_subscription.pubsub_subscription.push_config.oidc_token block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionPubsubSubscription: Typed helper for the destination_pubsub_subscription.pubsub_subscription block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionPushConfig: Typed helper for the destination_pubsub_subscription.pubsub_subscription.push_config block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubListingSubscriptionRetryPolicy: Typed helper for the destination_pubsub_subscription.pubsub_subscription.retry_policy block of google_bigquery_analytics_hub_listing_subscription (derived from provider schema).
BigqueryAnalyticsHubQueryTemplateRoutine: Typed helper for the routine block of google_bigquery_analytics_hub_query_template (derived from provider schema).
BigqueryBiReservationPreferredTables: Typed helper for the preferred_tables block of google_bigquery_bi_reservation (derived from provider schema).
BigqueryConnectionAws: aws block — BigQuery Omni federation into AWS (S3 / Glue, BigLake- on-AWS). The BigQuery location must be aws-us-east-1.
BigqueryConnectionAwsAccessRole: aws.access_role block — IAM role the Google-owned AWS identity assumes when reading from S3 / Glue on behalf of BigQuery.
BigqueryConnectionAzure: azure block — BigQuery Omni federation into Azure Data Lake Storage. The BigQuery location must be azure-eastus2. Most fields are computed and consumed by the Azure side of the federation bridge; only customerTenantId is required input.
BigqueryConnectionBackend
BigqueryConnectionCloudResource: cloud_resource block — generic delegation for cross-project reads (BigLake tables over Cloud Storage in a different project, etc.). The block is empty on input; after apply, cloud_resource.service_account_id surfaces the connection's Google-managed service account, which the consuming project must grant access to.
BigqueryConnectionCloudSpanner: cloud_spanner block — federated reads against a Cloud Spanner database. The connection's BigQuery region must match the Spanner region.
BigqueryConnectionCloudSql: cloud_sql block — federated queries against a Cloud SQL Postgres or MySQL instance.
BigqueryConnectionCloudSqlCredential: cloud_sql.credential block — username / password the BigQuery federation layer presents to the Cloud SQL instance. The password is schema-flagged sensitive: true and is masked on synth.
BigqueryConnectionConfiguration: configuration block — BigQuery Connector framework. Picks an upstream engine via connectorId (google-alloydb, google-cloudsql-mysql, google-cloudsql-postgres, and other ids supported by the framework) and wires it through asset / authentication / endpoint / network blocks.
BigqueryConnectionConfigurationAsset: configuration.asset block — points the connector at a Google Cloud resource (AlloyDB cluster / instance, etc.).
BigqueryConnectionConfigurationAuthentication: configuration.authentication block — authentication configuration for the connector. Output-only service_account is consumed via the generated factory state, not a constructor input.
BigqueryConnectionConfigurationAuthenticationPassword: configuration.authentication.username_password.password block — holds the plaintext password the connector forwards to the upstream engine. plaintext is schema-flagged sensitive and masked on synth.
BigqueryConnectionConfigurationAuthenticationUsernamePassword: configuration.authentication.username_password block — username / password authentication for the connector framework.
BigqueryConnectionConfigurationEndpoint: configuration.endpoint block — host:port override for the connector's upstream endpoint (when the default endpoint derived from BigqueryConnectionConfigurationAsset is not appropriate).
BigqueryConnectionConfigurationNetwork: configuration.network block — network configuration for the connector. The schema only exposes private_service_connect today.
BigqueryConnectionConfigurationNetworkPrivateServiceConnect: configuration.network.private_service_connect block — Private Service Connect network attachment for connector traffic.
BigqueryConnectionIamBindingCondition: Typed helper for the condition block of google_bigquery_connection_iam_binding (derived from provider schema).
BigqueryConnectionIamMemberCondition: Typed helper for the condition block of google_bigquery_connection_iam_member (derived from provider schema).
BigqueryConnectionSpark: spark block — stored procedures for Apache Spark on BigQuery. The block is empty-by-default on input; provide nested metastoreServiceConfig / sparkHistoryServerConfig only when the procedures need to read Hive tables or surface history-server logs.
BigqueryConnectionSparkMetastoreServiceConfig: spark.metastore_service_config block — optional binding to a Dataproc Metastore service so Spark stored procedures see Hive tables.
BigqueryConnectionSparkSparkHistoryServerConfig: spark.spark_history_server_config block — optional binding to a Dataproc Cluster acting as Spark History Server for the connection.
BigqueryDatapolicyDataPolicyDataMaskingPolicy: Exactly one of predefined_expression, routine on the data_masking_policy block of google_bigquery_datapolicy_data_policy: the provider rejects none and more than one, so each variant sets one of them.
BigqueryDatapolicyDataPolicyDataMaskingPolicyPredefinedExpression: The BigqueryDatapolicyDataPolicyDataMaskingPolicy.predefinedExpression choice: sets predefined_expression.
BigqueryDatapolicyDataPolicyDataMaskingPolicyRoutine: The BigqueryDatapolicyDataPolicyDataMaskingPolicy.routine choice: sets routine.
BigqueryDatapolicyDataPolicyIamBindingCondition: Typed helper for the condition block of google_bigquery_datapolicy_data_policy_iam_binding (derived from provider schema).
BigqueryDatapolicyDataPolicyIamMemberCondition: Typed helper for the condition block of google_bigquery_datapolicy_data_policy_iam_member (derived from provider schema).
BigqueryDatapolicyv2DataPolicyDataGovernanceTag: data_governance_tag — optional org/project tag binding on the policy.
BigqueryDatapolicyv2DataPolicyDataMaskingPolicy: data_masking_policy — predefined expression or custom routine.
BigqueryDatapolicyv2DataPolicyIamBindingCondition: Typed helper for the condition block of google_bigquery_datapolicyv2_data_policy_iam_binding (derived from provider schema).
BigqueryDatapolicyv2DataPolicyIamMemberCondition: Typed helper for the condition block of google_bigquery_datapolicyv2_data_policy_iam_member (derived from provider schema).
BigqueryDatasetAccess: Discriminated-union base for one access block entry.
BigqueryDatasetAccessAuthDatasetReference: A reference to a BigQuery dataset (project_id + dataset_id).
BigqueryDatasetAccessAuthorizedDataset: dataset access block — grants another dataset's resources access to this dataset (an "authorized dataset").
BigqueryDatasetAccessAuthorizedRoutine: routine access block — an authorized routine that may access this dataset.
BigqueryDatasetAccessAuthorizedView: view access block — an authorized view that may query this dataset.
BigqueryDatasetAccessChild: access.dataset sub-block — pairs a dataset reference with the targetTypes this binding applies to (currently only VIEWS).
BigqueryDatasetAccessCondition: access.condition — CEL binding restricting when an access entry applies. expression is the CEL source; the other three fields are metadata for debugging / UI surfaces.
BigqueryDatasetAccessDataset: access entry referring to a dataset (transitive read for resource types listed in targetTypes).
BigqueryDatasetAccessDomain: access entry granting role to all members of domain.
BigqueryDatasetAccessGrantee: Exactly one of user_by_email, group_by_email, domain, special_group, iam_member, view, dataset, routine on google_bigquery_dataset_access: the provider rejects none and more than one, so each variant sets one of them.
BigqueryDatasetAccessGranteeDataset: The BigqueryDatasetAccessGrantee.authorizedDataset choice: sets dataset.
BigqueryDatasetAccessGranteeDomain: The BigqueryDatasetAccessGrantee.domain choice: sets domain.
BigqueryDatasetAccessGranteeGroupByEmail: The BigqueryDatasetAccessGrantee.groupByEmail choice: sets group_by_email.
BigqueryDatasetAccessGranteeIamMember: The BigqueryDatasetAccessGrantee.iamMember choice: sets iam_member.
BigqueryDatasetAccessGranteeRoutine: The BigqueryDatasetAccessGrantee.routine choice: sets routine.
BigqueryDatasetAccessGranteeSpecialGroup: The BigqueryDatasetAccessGrantee.specialGroup choice: sets special_group.
BigqueryDatasetAccessGranteeUserByEmail: The BigqueryDatasetAccessGrantee.userByEmail choice: sets user_by_email.
BigqueryDatasetAccessGranteeView: The BigqueryDatasetAccessGrantee.view choice: sets view.
BigqueryDatasetAccessGroupByEmail: access entry granting role to groupByEmail.
BigqueryDatasetAccessIamMember: access entry granting role to an arbitrary IAM principal (e.g. allUsers, service identities) via iamMember.
BigqueryDatasetAccessRoutine: access entry referring to a BigQuery routine. Role is not required.
BigqueryDatasetAccessSpecialGroup: access entry granting role to specialGroup. Documented values include projectOwners, projectReaders, projectWriters, allAuthenticatedUsers (BigQuery treats these as case-sensitive).
BigqueryDatasetAccessUserByEmail: access entry granting role to userByEmail.
BigqueryDatasetAccessView: access entry referring to a BigQuery view. Granting view access lets queries against the view read tables in this dataset. Role is not required for view bindings.
BigqueryDatasetDefaultEncryptionConfiguration: Typed helper for the default_encryption_configuration block of google_bigquery_dataset (derived from provider schema).
BigqueryDatasetExternalCatalogDatasetOptions: Typed helper for the external_catalog_dataset_options block of google_bigquery_dataset (derived from provider schema).
BigqueryDatasetExternalDatasetReference: Typed helper for the external_dataset_reference block of google_bigquery_dataset (derived from provider schema).
BigqueryDatasetIamBindingCondition: Typed helper for the condition block of google_bigquery_dataset_iam_binding (derived from provider schema).
BigqueryDatasetIamMemberCondition: Typed helper for the condition block of google_bigquery_dataset_iam_member (derived from provider schema).
BigqueryDatasetReference: access.dataset.dataset and access.routine projectId+datasetId pair.
BigqueryDatasetRoutineRef: access.routine sub-block — fully qualified BigQuery routine reference.
BigqueryDatasetView: access.view sub-block — fully qualified BigQuery view reference.
BigqueryDataTransferConfigEmailPreferences: Typed helper for the email_preferences block of google_bigquery_data_transfer_config (derived from provider schema).
BigqueryDataTransferConfigEncryptionConfiguration: Typed helper for the encryption_configuration block of google_bigquery_data_transfer_config (derived from provider schema).
BigqueryDataTransferConfigScheduleOptions: Typed helper for the schedule_options block of google_bigquery_data_transfer_config (derived from provider schema).
BigqueryDataTransferConfigSecretAccessKey: Exactly one of secret_access_key, secret_access_key_wo on the sensitive_params block of google_bigquery_data_transfer_config: the provider rejects none and more than one, so each variant sets one of them.
BigqueryDataTransferConfigSecretAccessKeyChoice: The BigqueryDataTransferConfigSecretAccessKey.secretAccessKey choice: sets secret_access_key.
BigqueryDataTransferConfigSecretAccessKeyWo: The BigqueryDataTransferConfigSecretAccessKey.secretAccessKeyWo choice: sets secret_access_key_wo.
BigqueryDataTransferConfigSensitiveParams: Typed helper for the sensitive_params block of google_bigquery_data_transfer_config (derived from provider schema).
BigqueryJobConfiguration: Exactly one of query, load, copy, extract on google_bigquery_job: the provider rejects none and more than one, so each variant sets one of them.
BigqueryJobConfigurationCopy: The BigqueryJobConfiguration.copy choice: sets copy.
BigqueryJobConfigurationExtract: The BigqueryJobConfiguration.extract choice: sets extract.
BigqueryJobConfigurationLoad: The BigqueryJobConfiguration.load choice: sets load.
BigqueryJobConfigurationQuery: The BigqueryJobConfiguration.query choice: sets query.
BigqueryJobConnectionProperties: Typed helper for the query.connection_properties block of google_bigquery_job (derived from provider schema).
BigqueryJobCopy: Typed helper for the copy block of google_bigquery_job (derived from provider schema).
BigqueryJobDefaultDataset: Typed helper for the query.default_dataset block of google_bigquery_job (derived from provider schema).
BigqueryJobDestinationEncryptionConfiguration: Typed helper for the copy.destination_encryption_configuration block of google_bigquery_job (derived from provider schema). Shared by every block of this shape in the resource.
BigqueryJobDestinationTable: Typed helper for the copy.destination_table block of google_bigquery_job (derived from provider schema). Shared by every block of this shape in the resource.
BigqueryJobExtract: Typed helper for the extract block of google_bigquery_job (derived from provider schema).
BigqueryJobLoad: Typed helper for the load block of google_bigquery_job (derived from provider schema).
BigqueryJobParquetOptions: Typed helper for the load.parquet_options block of google_bigquery_job (derived from provider schema).
BigqueryJobQuery: Typed helper for the query block of google_bigquery_job (derived from provider schema).
BigqueryJobScriptOptions: Typed helper for the query.script_options block of google_bigquery_job (derived from provider schema).
BigqueryJobSource: Exactly one of source_table, source_model on the extract block of google_bigquery_job: the provider rejects none and more than one, so each variant sets one of them.
BigqueryJobSourceModel: Typed helper for the extract.source_model block of google_bigquery_job (derived from provider schema).
BigqueryJobSourceModelChoice: The BigqueryJobSource.sourceModel choice: sets source_model.
BigqueryJobSourceTable: Typed helper for the extract.source_table block of google_bigquery_job (derived from provider schema).
BigqueryJobSourceTableChoice: The BigqueryJobSource.sourceTable choice: sets source_table.
BigqueryJobSourceTables: Typed helper for the copy.source_tables block of google_bigquery_job (derived from provider schema).
BigqueryJobTimePartitioning: Typed helper for the load.time_partitioning block of google_bigquery_job (derived from provider schema).
BigqueryJobUserDefinedFunctionResources: Typed helper for the query.user_defined_function_resources block of google_bigquery_job (derived from provider schema).
BigqueryReservationAutoscale: autoscale block — enables pay-as-you-go slot scaling on top of the slotCapacity floor. maxSlots caps the dynamic upper bound; the API reports the live current_slots value back through the autoscale.current_slots computed attribute (not surfaced here — read via the underlying state if needed).
BigqueryRoutineArgument: One entry of the arguments block (repeatable list). dataType is a JSON-encoded BigQuery type string; omit it only when argumentKind = BigqueryRoutineArgumentKind.anyType. mode is procedure-only; leave it null for scalar / TVF functions.
BigqueryRoutineIamBindingCondition: Typed helper for the condition block of google_bigquery_routine_iam_binding (derived from provider schema).
BigqueryRoutineIamMemberCondition: Typed helper for the condition block of google_bigquery_routine_iam_member (derived from provider schema).
BigqueryRoutineRemoteFunctionOptions: remote_function_options block (max=1). Required when BigqueryRoutineType.scalarFunction is backed by a remote service (Cloud Functions / Cloud Run). endpoint points at the HTTPS URL of the function; connection is the fully-qualified BigQuery connection (projects/{p}/locations/{l}/connections/{c}) holding the credential.
BigqueryRoutineSparkOptions: spark_options block (max=1). Required when language is PYTHON, JAVA, or SCALA. connection points at a BigQuery Spark connection. The remaining fields configure the Spark application — exactly one of mainClass / mainFileUri must be set for Java / Scala; PySpark uses mainFileUri or definitionBody.
BigqueryTableAvroOptions: Typed helper for the external_data_configuration.avro_options block of google_bigquery_table (derived from provider schema).
BigqueryTableBiglakeConfiguration: Typed helper for the biglake_configuration block of google_bigquery_table (derived from provider schema).
BigqueryTableBigtableOptions: Typed helper for the external_data_configuration.bigtable_options block of google_bigquery_table (derived from provider schema).
BigqueryTableColumn: Typed helper for the external_data_configuration.bigtable_options.column_family.column block of google_bigquery_table (derived from provider schema).
BigqueryTableColumnFamily: Typed helper for the external_data_configuration.bigtable_options.column_family block of google_bigquery_table (derived from provider schema).
BigqueryTableColumnReferences: Typed helper for the table_constraints.foreign_keys.column_references block of google_bigquery_table (derived from provider schema).
BigqueryTableConstraints: Typed helper for the table_constraints block of google_bigquery_table (derived from provider schema).
BigqueryTableCsvOptions: Typed helper for the external_data_configuration.csv_options block of google_bigquery_table (derived from provider schema).
BigqueryTableEncryptionConfiguration: Typed helper for the encryption_configuration block of google_bigquery_table (derived from provider schema).
BigqueryTableExternalCatalogTableOptions: Typed helper for the external_catalog_table_options block of google_bigquery_table (derived from provider schema).
BigqueryTableExternalDataConfiguration: Typed helper for the external_data_configuration block of google_bigquery_table (derived from provider schema).
BigqueryTableForeignKeys: Typed helper for the table_constraints.foreign_keys block of google_bigquery_table (derived from provider schema).
BigqueryTableGoogleSheetsOptions: Typed helper for the external_data_configuration.google_sheets_options block of google_bigquery_table (derived from provider schema).
BigqueryTableHivePartitioningOptions: Typed helper for the external_data_configuration.hive_partitioning_options block of google_bigquery_table (derived from provider schema).
BigqueryTableIamBindingCondition: Typed helper for the condition block of google_bigquery_table_iam_binding (derived from provider schema).
BigqueryTableIamMemberCondition: Typed helper for the condition block of google_bigquery_table_iam_member (derived from provider schema).
BigqueryTableJsonOptions: Typed helper for the external_data_configuration.json_options block of google_bigquery_table (derived from provider schema).
BigqueryTableMaterializedView: Typed helper for the materialized_view block of google_bigquery_table (derived from provider schema).
BigqueryTableParquetOptions: Typed helper for the external_data_configuration.parquet_options block of google_bigquery_table (derived from provider schema).
BigqueryTablePrimaryKey: Typed helper for the table_constraints.primary_key block of google_bigquery_table (derived from provider schema).
BigqueryTableRange: Typed helper for the range_partitioning.range block of google_bigquery_table (derived from provider schema).
BigqueryTableRangePartitioning: Typed helper for the range_partitioning block of google_bigquery_table (derived from provider schema).
BigqueryTableReferencedTable: Typed helper for the table_constraints.foreign_keys.referenced_table block of google_bigquery_table (derived from provider schema).
BigqueryTableReplicationInfo: Typed helper for the table_replication_info block of google_bigquery_table (derived from provider schema).
BigqueryTableSchemaForeignTypeInfo: Typed helper for the schema_foreign_type_info block of google_bigquery_table (derived from provider schema).
BigqueryTableSerdeInfo: Typed helper for the external_catalog_table_options.storage_descriptor.serde_info block of google_bigquery_table (derived from provider schema).
BigqueryTableStorageDescriptor: Typed helper for the external_catalog_table_options.storage_descriptor block of google_bigquery_table (derived from provider schema).
BigqueryTableTimePartitioning: Typed helper for the time_partitioning block of google_bigquery_table (derived from provider schema).
BigqueryTableView: Typed helper for the view block of google_bigquery_table (derived from provider schema).
DartDefineOutput: An output whose value is the client build's --dart-define file, registered with Stack.addDartDefineOutput.
Data: Base of every user-instantiable Terraform data block.
DataGoogleBigqueryAnalyticsHubDataExchangeIamPolicy: Factory wrapper for google_bigquery_analytics_hub_data_exchange_iam_policy.
DataGoogleBigqueryAnalyticsHubListingIamPolicy: Factory wrapper for google_bigquery_analytics_hub_listing_iam_policy.
DataGoogleBigqueryConnectionIamPolicy: Factory wrapper for google_bigquery_connection_iam_policy.
DataGoogleBigqueryDatapolicyDataPolicyIamPolicy: Factory wrapper for google_bigquery_datapolicy_data_policy_iam_policy.
DataGoogleBigqueryDatapolicyv2DataPolicyIamPolicy: Factory wrapper for google_bigquery_datapolicyv2_data_policy_iam_policy.
DataGoogleBigqueryDataset: Factory wrapper for google_bigquery_dataset.
DataGoogleBigqueryDatasetIamPolicy: Factory wrapper for google_bigquery_dataset_iam_policy.
DataGoogleBigqueryDatasets: Factory wrapper for google_bigquery_datasets.
DataGoogleBigqueryDefaultServiceAccount: Factory wrapper for google_bigquery_default_service_account.
DataGoogleBigqueryRoutineIamPolicy: Factory wrapper for google_bigquery_routine_iam_policy.
DataGoogleBigqueryTable: Factory wrapper for google_bigquery_table.
DataGoogleBigqueryTableIamPolicy: Factory wrapper for google_bigquery_table_iam_policy.
DataGoogleBigqueryTables: Factory wrapper for google_bigquery_tables.
DataRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant: The AppConstant.fromEnvironment choice.
GcsBackend: terraform { backend "gcs" { ... } } configuration.
GoogleBigqueryAnalyticsHubDataExchange: Factory wrapper for google_bigquery_analytics_hub_data_exchange.
GoogleBigqueryAnalyticsHubDataExchangeIamBinding: Factory wrapper for google_bigquery_analytics_hub_data_exchange_iam_binding.
GoogleBigqueryAnalyticsHubDataExchangeIamMember: Factory wrapper for google_bigquery_analytics_hub_data_exchange_iam_member.
GoogleBigqueryAnalyticsHubDataExchangeIamPolicy: Factory wrapper for google_bigquery_analytics_hub_data_exchange_iam_policy.
GoogleBigqueryAnalyticsHubListing: Factory wrapper for google_bigquery_analytics_hub_listing.
GoogleBigqueryAnalyticsHubListingIamBinding: Factory wrapper for google_bigquery_analytics_hub_listing_iam_binding.
GoogleBigqueryAnalyticsHubListingIamMember: Factory wrapper for google_bigquery_analytics_hub_listing_iam_member.
GoogleBigqueryAnalyticsHubListingIamPolicy: Factory wrapper for google_bigquery_analytics_hub_listing_iam_policy.
GoogleBigqueryAnalyticsHubListingSubscription: Factory wrapper for google_bigquery_analytics_hub_listing_subscription.
GoogleBigqueryAnalyticsHubQueryTemplate: Factory wrapper for google_bigquery_analytics_hub_query_template.
GoogleBigqueryBiReservation: Factory wrapper for google_bigquery_bi_reservation.
GoogleBigqueryCapacityCommitment: Factory wrapper for google_bigquery_capacity_commitment.
GoogleBigqueryConnection: Factory wrapper for google_bigquery_connection.
GoogleBigqueryConnectionIamBinding: Factory wrapper for google_bigquery_connection_iam_binding.
GoogleBigqueryConnectionIamMember: Factory wrapper for google_bigquery_connection_iam_member.
GoogleBigqueryConnectionIamPolicy: Factory wrapper for google_bigquery_connection_iam_policy.
GoogleBigqueryDatapolicyDataPolicy: Factory wrapper for google_bigquery_datapolicy_data_policy.
GoogleBigqueryDatapolicyDataPolicyIamBinding: Factory wrapper for google_bigquery_datapolicy_data_policy_iam_binding.
GoogleBigqueryDatapolicyDataPolicyIamMember: Factory wrapper for google_bigquery_datapolicy_data_policy_iam_member.
GoogleBigqueryDatapolicyDataPolicyIamPolicy: Factory wrapper for google_bigquery_datapolicy_data_policy_iam_policy.
GoogleBigqueryDatapolicyv2DataPolicy: Factory wrapper for google_bigquery_datapolicyv2_data_policy.
GoogleBigqueryDatapolicyv2DataPolicyIamBinding: Factory wrapper for google_bigquery_datapolicyv2_data_policy_iam_binding.
GoogleBigqueryDatapolicyv2DataPolicyIamMember: Factory wrapper for google_bigquery_datapolicyv2_data_policy_iam_member.
GoogleBigqueryDatapolicyv2DataPolicyIamPolicy: Factory wrapper for google_bigquery_datapolicyv2_data_policy_iam_policy.
GoogleBigqueryDataset: Factory wrapper for google_bigquery_dataset.
GoogleBigqueryDatasetAccess: Factory wrapper for google_bigquery_dataset_access.
GoogleBigqueryDatasetIamBinding: Factory wrapper for google_bigquery_dataset_iam_binding.
GoogleBigqueryDatasetIamMember: Factory wrapper for google_bigquery_dataset_iam_member.
GoogleBigqueryDatasetIamPolicy: Factory wrapper for google_bigquery_dataset_iam_policy.
GoogleBigqueryDataTransferConfig: Factory wrapper for google_bigquery_data_transfer_config.
GoogleBigqueryDataTransferDataSourceEnrollment: Factory wrapper for google_bigquery_data_transfer_data_source_enrollment.
GoogleBigqueryJob: Factory wrapper for google_bigquery_job.
GoogleBigqueryReservation: Factory wrapper for google_bigquery_reservation.
GoogleBigqueryReservationAssignment: Factory wrapper for google_bigquery_reservation_assignment.
GoogleBigqueryReservationGroup: Factory wrapper for google_bigquery_reservation_group.
GoogleBigqueryRoutine: Factory wrapper for google_bigquery_routine.
GoogleBigqueryRoutineIamBinding: Factory wrapper for google_bigquery_routine_iam_binding.
GoogleBigqueryRoutineIamMember: Factory wrapper for google_bigquery_routine_iam_member.
GoogleBigqueryRoutineIamPolicy: Factory wrapper for google_bigquery_routine_iam_policy.
GoogleBigqueryRowAccessPolicy: Factory wrapper for google_bigquery_row_access_policy.
GoogleBigqueryTable: Factory wrapper for google_bigquery_table.
GoogleBigqueryTableIamBinding: Factory wrapper for google_bigquery_table_iam_binding.
GoogleBigqueryTableIamMember: Factory wrapper for google_bigquery_table_iam_member.
GoogleBigqueryTableIamPolicy: Factory wrapper for google_bigquery_table_iam_policy.
IgnoreAllChanges: IgnoreChanges.all.
IgnoreAttributes: IgnoreChanges.of.
IgnoreChanges: What ignore_changes covers: every attribute, or the listed ones.
InvalidDartDefineOutput: An output of Stack.addDartDefineOutput that cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all.
InvalidLifecycle: A lifecycle block Terraform rejects: a data source (or one of its attributes) in replaceTriggeredBy, all inside IgnoreChanges.of, or a condition with an empty error message.
InvalidMoveTarget: A moved block whose to names no resource of the Stack.
InvalidTimeout: A negative timeouts duration.
LifecycleCondition: A precondition or postcondition block: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false.
LifecycleOptions: lifecycle { ... } block on a resource.
LocalBackend: terraform { backend "local" { ... } } configuration.
MissingProvider: A block needs a provider configuration the Stack does not register: the provider its type implies (google for google_pubsub_topic), the one its provider meta-argument names, or one a module call passes on.
ModuleCall: A module "<localName>" { ... } call as a Dart value.
NoProviders: The Stack registers no provider, but declares resources or data sources.
ProviderConflict: Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
RefConstant<T>: The AppConstant.ref choice.
ReplaceTrigger: What lifecycle.replaceTriggeredBy lists: a resource of the Stack or an attribute getter of one. Resource and TfRef implement it; synth reports a data source or a data-source attribute as an InvalidLifecycle.
Resource: Base of every user-instantiable Terraform resource.
ResourceRef: Public for sealed pattern matching, but constructor is private — only TfRef.resource() may construct instances.
S3Backend: terraform { backend "s3" { ... } } configuration.
Sensitive<T>: What an argument Terraform marks sensitive takes: a variable, an expression or an attribute getter — a value Terraform resolves, never a Dart literal that would be written into main.tf.json.
SensitiveLiteral: A sensitive field is set to a literal, which would write the secret in plain text into main.tf.json.
Stack: User-extended IaC composition root.
StackBackend: Lightweight backend hook. Core ships GcsBackend, S3Backend, and LocalBackend; anything else implements this interface in the caller. The Stack only stores the value and exposes a discriminator for synth's terraform { backend ... } emitter.
StackProvider: Coordination interface between Stack (in this package) and concrete providers (e.g. GoogleProvider in terradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen.
SynthIssue: One reason a Stack cannot be synthesized.
SynthResult: Bundle returned by StackSynth.synth.
TfAddressed: Anything that exposes a Terraform address, e.g. google_pubsub_topic.orders.
TfArg<T>: A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
TfArgExpression<T>: A raw Terraform expression — the tf.json template string, verbatim.
TfArgLiteral<T>
TfArgVariable<T>
TfCollectionType: list(...), set(...) or map(...).
TfMoved: One moved { from = ... to = ... } block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create.
TfObjectType: object({ ... }).
TfOptionalType: optional(<type>[, <default>]).
TfOutput<T>: An output "<name>" { value = ... } block, registered with Stack.addOutput.
TfPrimitiveType: string, number, bool or any.
TfRef<T>: A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
TfTimeouts: timeouts { ... } on a resource or data source: how long Terraform waits for each operation before giving up.
TfTupleType: tuple([...]).
TfType: A Terraform type constraint: string, list(number), object({ name = string }).
TfVariable: One variable "<name>" { ... } declaration.
UndeclaredVariable: A TfArg.variable or var.<name> in an expression names a variable the Stack does not declare.
UnregisteredReference: A block references another block that was never registered on the Stack: built, but not passed to add(...) / addModule(...).
UnresolvableConstant: An AppConstant.ref whose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered.
ValueConstant<T>: The AppConstant.value choice.

Enums

ResourceKind: Whether a Stack entry is a resource block or a data block in Terraform JSON.

Extension Types

BigqueryAnalyticsHubDataExchangeDiscoveryType
BigqueryAnalyticsHubListingDiscoveryType
BigqueryCapacityCommitmentEdition: BigQuery edition for google_bigquery_capacity_commitment.edition. Determines feature set and per-slot pricing. Documented values: STANDARD, ENTERPRISE, ENTERPRISE_PLUS. Distinct Dart type from BigqueryReservationEdition even though both wrap the same GCP enum — keeping resource-scoped naming avoids cross-resource coupling.
BigqueryCapacityCommitmentPlan: Commitment plan for google_bigquery_capacity_commitment.plan. Pinned to the values documented by the BigQuery Reservations API (CommitmentPlan): FLEX, TRIAL, MONTHLY, ANNUAL, THREE_YEAR. Schema does not enumerate explicitly — see the field description for the authoritative link.
BigqueryCapacityCommitmentRenewalPlan: Renewal plan applied when the current commitment term ends. Documented values: NONE (no renewal — commitment lapses), FLEX, MONTHLY, ANNUAL, THREE_YEAR. (TRIAL is a commitment-creation-only plan and is not a valid renewal target.)
BigqueryConnectionCloudSqlType: cloud_sql.type — Cloud SQL database engine. The schema includes DATABASE_TYPE_UNSPECIFIED as a sentinel; do not pick it for new connections. SQL_SERVER is not exposed by the GA provider schema as of this curation.
BigqueryDatapolicyDataPolicyPredefinedExpression
BigqueryDatapolicyDataPolicyType: Enrollment level for google_bigquery_datapolicy_data_policy.data_policy_type.
BigqueryDatapolicyv2DataPolicyPredefinedExpression: Predefined masking expression for V2 BigqueryDatapolicyv2DataPolicyDataMaskingPolicy.
BigqueryDatapolicyv2DataPolicyType: Enrollment level for google_bigquery_datapolicyv2_data_policy.data_policy_type.
BigqueryDatasetAccessDatasetTargetType: Target resource types an authorized BigqueryDatasetAccessAuthorizedDataset applies to. Currently only views are supported.
BigqueryDatasetAccessPredefinedGroup: Predefined BigQuery special group for GoogleBigqueryDatasetAccess.
BigqueryJobCreateDisposition: create_disposition — derived from the provider schema description.
BigqueryJobExtractCompression: extract.compression. Schema description: "Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro." The schema doesn't expose a formal enum_values array — values transcribed from the description prose.
BigqueryJobExtractDestinationFormat: extract.destination_format. Schema description: "Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO for tables and SAVED_MODEL for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is SAVED_MODEL." Values transcribed from the description prose (no formal enum_values array on this attribute).
BigqueryJobKeyResultStatement: key_result_statement — derived from the provider schema description.
BigqueryJobLoadSourceFormat: load.source_format. From the schema description: for CSV specify CSV; for datastore backups DATASTORE_BACKUP; for newline-delimited JSON NEWLINE_DELIMITED_JSON; for Avro AVRO; for Parquet PARQUET; for ORC ORC; Beta for Bigtable BIGTABLE. Default is CSV. The schema doesn't expose a formal enum_values array, so this list is sourced from the attribute's description prose.
BigqueryJobParameterMode: query.parameter_mode. Standard SQL only. POSITIONAL uses ? placeholders; NAMED uses @param syntax. The provider description does not expose a formal Possible values array; the BigQuery API documents these two as the supported modes.
BigqueryJobPriority: priority — derived from the provider schema description.
BigqueryJobWriteDisposition: write_disposition — derived from the provider schema description.
BigqueryReservationAssignmentJobType
BigqueryReservationEdition: BigQuery reservation edition for google_bigquery_reservation.edition. Determines feature set and billing tier. Documented values (per the field description): STANDARD, ENTERPRISE, ENTERPRISE_PLUS. The provider schema does not enumerate values explicitly; new editions ship as the BigQuery product evolves. Distinct from BigqueryCapacityCommitmentEdition by design (the two resources reference the same GCP enum but are kept separate at the Dart type level to preserve resource-scoped naming).
BigqueryRoutineArgumentKind: Argument kind for arguments.argument_kind. FIXED_TYPE (the default) requires dataType to be set; ANY_TYPE lets BigQuery infer the type at call site.
BigqueryRoutineArgumentMode: Argument direction for arguments.mode. Procedures use this to mark each argument as input (IN), output (OUT), or bidirectional (INOUT); functions leave it null.
BigqueryRoutineDataGovernanceType: Data governance type for data_governance_type. The provider only accepts DATA_MASKING today — set this to register the routine as a custom masking function consumable by BigQuery column-level policies.
BigqueryRoutineDeterminismLevel: Determinism level for determinism_level. Applies to JavaScript UDFs — declaring DETERMINISTIC lets BigQuery cache results across query invocations with identical inputs.
BigqueryRoutineLanguage: Routine source language for language. SQL is the default for pure-SQL UDFs and TVFs; JAVASCRIPT runs inline JS bodies; PYTHON / JAVA / SCALA require an accompanying BigqueryRoutineSparkOptions block.
BigqueryRoutineSecurityMode: Security mode for security_mode. DEFINER runs the routine with the privileges of its owner; INVOKER runs with the caller's privileges. Defaults to BigQuery's auto-detect when omitted.
BigqueryRoutineType: Type of routine for routine_type. BigQuery currently supports three shapes at this provider version: scalar UDFs, stored procedures, and table-valued functions.
DatasetStorageBillingModel: Storage billing model for google_bigquery_dataset.storage_billing_model. LOGICAL (default per BigQuery API) bills by logical bytes; PHYSICAL bills by compressed on-disk bytes (typically cheaper for high-compression data with infrequent reads).
ExternalDataCompression: Compression for external_data_configuration.compression. BigQuery only accepts these two values; format-specific compression (Snappy for Parquet, Deflate for Avro, etc.) is inferred from the file.
ExternalDataSourceFormat: Source format for external_data_configuration.source_format. The googleSheets variant additionally requires https://www.googleapis.com/auth/drive.readonly on the service account performing the read.
FileSetSpecType: File-set spec for external_data_configuration.file_set_spec_type. fileSystemMatch (default) glob-expands source_uris against the underlying object store; newLineDelimitedManifest treats each source URI as a manifest file containing one object URI per line.
MetadataCacheMode: Metadata cache mode for external_data_configuration.metadata_cache_mode. automatic lets BigQuery refresh the cache on a service-controlled cadence; manual requires explicit BQ.REFRESH_EXTERNAL_METADATA_CACHE calls.
ObjectMetadata: Object metadata for external_data_configuration.object_metadata. Set this to create an Object Table (a listing of objects + their metadata) rather than a regular external table; when set, sourceFormat must be omitted.
OutputEnvironment: The environment Stack.outputEnvironment returns: each variable and its value, in registration order.
RefTo: A reference to a resource of type R, for an argument that names another resource (network, vpc_id, role_arn, ...).
TableMetadataView: View for table_metadata_view. Controls how much detail BigQuery returns when reading the table — basic (default) skips storage stats, storageStats adds size counters, full includes all optional fields. unspecified is the no-op default.
TimePartitioningType: Partition unit for time_partitioning.type. Maps to BigQuery's supported partition granularities.

Extensions

RefToList on TfArg<List<RefTo<R>>>: A list-valued reference argument (security_group_ids, subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'), TfArg.expression(...)).
TerraformDurationExt on Duration: Converts a Dart Duration into a Terraform duration string ("604800s").

Constants

terradartManifestVariable → const String: The environment variable the terradart command sets to the file runStack and runEnvironments describe what they wrote in.

Functions

runEnvironments<E extends Enum>(List<String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void>: The entry point of a project with one Stack per environment. The environments are the members of an enum of the project's own — any names, each carrying its values — so the Stack takes a typed env and derives everything per environment from it, its backend included:
runStack(List<String> args, Stack build(), {String out = 'tf-out'}) → Future<void>: The entry point of a project with one Stack: writes it to out.

Exceptions / Errors

DuplicateModuleError: A ModuleCall registered twice under one name.
DuplicateResourceError: Thrown by Stack.add when an entry with the same (kind, terraformType, localName) triple is registered twice.
SynthException: Thrown by Stack.synth() and Stack.writeTo() when the Stack has one or more SynthIssues. Nothing is written.

bigquery library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_google package

bigquery library