dataplex library

Dataplex: governed data products, Universal Catalog metadata (entry groups / entry types / aspect types), Data Lineage project config, and their IAM adjuncts.

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.
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.
DataGoogleDataLineageConfig: Factory wrapper for google_data_lineage_config.
DataGoogleDataplexAspectTypeIamPolicy: Factory wrapper for google_dataplex_aspect_type_iam_policy.
DataGoogleDataplexAssetIamPolicy: Factory wrapper for google_dataplex_asset_iam_policy.
DataGoogleDataplexDataProductIamPolicy: Factory wrapper for google_dataplex_data_product_iam_policy.
DataGoogleDataplexDataQualityRules: Factory wrapper for google_dataplex_data_quality_rules.
DataGoogleDataplexDatascanIamPolicy: Factory wrapper for google_dataplex_datascan_iam_policy.
DataGoogleDataplexEntryGroupIamPolicy: Factory wrapper for google_dataplex_entry_group_iam_policy.
DataGoogleDataplexEntryTypeIamPolicy: Factory wrapper for google_dataplex_entry_type_iam_policy.
DataGoogleDataplexGlossaryIamPolicy: Factory wrapper for google_dataplex_glossary_iam_policy.
DataGoogleDataplexLakeIamPolicy: Factory wrapper for google_dataplex_lake_iam_policy.
DataGoogleDataplexTaskIamPolicy: Factory wrapper for google_dataplex_task_iam_policy.
DataGoogleDataplexZoneIamPolicy: Factory wrapper for google_dataplex_zone_iam_policy.
DataLineageConfigIngestion: Typed helper for the ingestion block of google_data_lineage_config (derived from provider schema).
DataLineageConfigIntegrationSelector: Typed helper for the ingestion.rule.integration_selector block of google_data_lineage_config (derived from provider schema).
DataLineageConfigLineageEnablement: Typed helper for the ingestion.rule.lineage_enablement block of google_data_lineage_config (derived from provider schema).
DataLineageConfigRule: Typed helper for the ingestion.rule block of google_data_lineage_config (derived from provider schema).
DataplexAspectTypeIamBindingCondition: Typed helper for the condition block of google_dataplex_aspect_type_iam_binding (derived from provider schema).
DataplexAspectTypeIamMemberCondition: Typed helper for the condition block of google_dataplex_aspect_type_iam_member (derived from provider schema).
DataplexAssetCsvOptions: Typed helper for the discovery_spec.csv_options block of google_dataplex_asset (derived from provider schema).
DataplexAssetDiscoverySpec: Typed helper for the discovery_spec block of google_dataplex_asset (derived from provider schema).
DataplexAssetIamBindingCondition: Typed helper for the condition block of google_dataplex_asset_iam_binding (derived from provider schema).
DataplexAssetIamMemberCondition: Typed helper for the condition block of google_dataplex_asset_iam_member (derived from provider schema).
DataplexAssetJsonOptions: Typed helper for the discovery_spec.json_options block of google_dataplex_asset (derived from provider schema).
DataplexAssetResourceSpec: Typed helper for the resource_spec block of google_dataplex_asset (derived from provider schema).
DataplexDataProductAccessApprovalConfig: Typed helper for the access_approval_config block of google_dataplex_data_product (derived from provider schema).
DataplexDataProductAccessGroups: Typed helper for the access_groups block of google_dataplex_data_product (derived from provider schema).
DataplexDataProductDataAssetAccessGroupConfigs: Typed helper for the access_group_configs block of google_dataplex_data_product_data_asset (derived from provider schema).
DataplexDataProductIamBindingCondition: Typed helper for the condition block of google_dataplex_data_product_iam_binding (derived from provider schema).
DataplexDataProductIamMemberCondition: Typed helper for the condition block of google_dataplex_data_product_iam_member (derived from provider schema).
DataplexDataProductPrincipal: Typed helper for the access_groups.principal block of google_dataplex_data_product (derived from provider schema).
DataplexDatascanBigqueryExport: Typed helper for the data_profile_spec.post_scan_actions.bigquery_export block of google_dataplex_datascan (derived from provider schema). Shared by every block of this shape in the resource.
DataplexDatascanBigqueryPublishingConfig: Typed helper for the data_discovery_spec.bigquery_publishing_config block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanCsvOptions: Typed helper for the data_discovery_spec.storage_config.csv_options block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanData: Exactly one of entity, resource on the data block of google_dataplex_datascan: the provider rejects none and more than one, so each variant sets one of them.
DataplexDatascanDataDiscoverySpec: Typed helper for the data_discovery_spec block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataDocumentationSpec: Typed helper for the data_documentation_spec block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataEntity: The DataplexDatascanData.entity choice: sets entity.
DataplexDatascanDataplexServiceAgent: Typed helper for the execution_identity.dataplex_service_agent block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataProfileSpec: Typed helper for the data_profile_spec block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataProfileSpecPostScanActions: Typed helper for the data_profile_spec.post_scan_actions block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataQualitySpec: Typed helper for the data_quality_spec block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataQualitySpecPostScanActions: Typed helper for the data_quality_spec.post_scan_actions block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanDataResource: The DataplexDatascanData.resource choice: sets resource.
DataplexDatascanExcludeFields: Typed helper for the data_profile_spec.exclude_fields block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanExecutionIdentity: Exactly one of dataplex_service_agent, user_credential, service_account on the execution_identity block of google_dataplex_datascan: the provider rejects none and more than one, so each variant sets one of them.
DataplexDatascanExecutionIdentityDataplexServiceAgent: The DataplexDatascanExecutionIdentity.dataplexServiceAgent choice: sets dataplex_service_agent.
DataplexDatascanExecutionIdentityServiceAccount: The DataplexDatascanExecutionIdentity.serviceAccount choice: sets service_account.
DataplexDatascanExecutionIdentityUserCredential: The DataplexDatascanExecutionIdentity.userCredential choice: sets user_credential.
DataplexDatascanExecutionSpec: Typed helper for the execution_spec block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanIamBindingCondition: Typed helper for the condition block of google_dataplex_datascan_iam_binding (derived from provider schema).
DataplexDatascanIamMemberCondition: Typed helper for the condition block of google_dataplex_datascan_iam_member (derived from provider schema).
DataplexDatascanIncludeFields: Typed helper for the data_profile_spec.include_fields block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanJobEndTrigger: Typed helper for the data_quality_spec.post_scan_actions.notification_report.job_end_trigger block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanJobFailureTrigger: Typed helper for the data_quality_spec.post_scan_actions.notification_report.job_failure_trigger block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanJsonOptions: Typed helper for the data_discovery_spec.storage_config.json_options block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanNonNullExpectation: Typed helper for the data_quality_spec.rules.non_null_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanNotificationReport: Typed helper for the data_quality_spec.post_scan_actions.notification_report block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanOnDemand: Typed helper for the execution_spec.trigger.on_demand block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanOneTime: Typed helper for the execution_spec.trigger.one_time block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanRangeExpectation: Typed helper for the data_quality_spec.rules.range_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanRecipients: Typed helper for the data_quality_spec.post_scan_actions.notification_report.recipients block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanRegexExpectation: Typed helper for the data_quality_spec.rules.regex_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanRowConditionExpectation: Typed helper for the data_quality_spec.rules.row_condition_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanRules: Typed helper for the data_quality_spec.rules block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanScanSpec: Exactly one of data_quality_spec, data_profile_spec, data_discovery_spec, data_documentation_spec on google_dataplex_datascan: the provider rejects none and more than one, so each variant sets one of them.
DataplexDatascanScanSpecDataDiscoverySpec: The DataplexDatascanScanSpec.dataDiscoverySpec choice: sets data_discovery_spec.
DataplexDatascanScanSpecDataDocumentationSpec: The DataplexDatascanScanSpec.dataDocumentationSpec choice: sets data_documentation_spec.
DataplexDatascanScanSpecDataProfileSpec: The DataplexDatascanScanSpec.dataProfileSpec choice: sets data_profile_spec.
DataplexDatascanScanSpecDataQualitySpec: The DataplexDatascanScanSpec.dataQualitySpec choice: sets data_quality_spec.
DataplexDatascanSchedule: Typed helper for the execution_spec.trigger.schedule block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanScoreThresholdTrigger: Typed helper for the data_quality_spec.post_scan_actions.notification_report.score_threshold_trigger block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanServiceAccount: Typed helper for the execution_identity.service_account block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanSetExpectation: Typed helper for the data_quality_spec.rules.set_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanSqlAssertion: Typed helper for the data_quality_spec.rules.sql_assertion block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanStatisticRangeExpectation: Typed helper for the data_quality_spec.rules.statistic_range_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanStorageConfig: Typed helper for the data_discovery_spec.storage_config block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanTableConditionExpectation: Typed helper for the data_quality_spec.rules.table_condition_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanTemplateReference: Typed helper for the data_quality_spec.rules.template_reference block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanTrigger: Exactly one of on_demand, schedule, one_time on the execution_spec.trigger block of google_dataplex_datascan: the provider rejects none and more than one, so each variant sets one of them.
DataplexDatascanTriggerOnDemand: The DataplexDatascanTrigger.onDemand choice: sets on_demand.
DataplexDatascanTriggerOneTime: The DataplexDatascanTrigger.oneTime choice: sets one_time.
DataplexDatascanTriggerSchedule: The DataplexDatascanTrigger.schedule choice: sets schedule.
DataplexDatascanUniquenessExpectation: Typed helper for the data_quality_spec.rules.uniqueness_expectation block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanUserCredential: Typed helper for the execution_identity.user_credential block of google_dataplex_datascan (derived from provider schema).
DataplexDatascanValues: Typed helper for the data_quality_spec.rules.template_reference.values block of google_dataplex_datascan (derived from provider schema).
DataplexEntryAncestors: Typed helper for the entry_source.ancestors block of google_dataplex_entry (derived from provider schema).
DataplexEntryAspect: Typed helper for the aspects.aspect block of google_dataplex_entry (derived from provider schema).
DataplexEntryAspects: Typed helper for the aspects block of google_dataplex_entry (derived from provider schema).
DataplexEntryGroupIamBindingCondition: Typed helper for the condition block of google_dataplex_entry_group_iam_binding (derived from provider schema).
DataplexEntryGroupIamMemberCondition: Typed helper for the condition block of google_dataplex_entry_group_iam_member (derived from provider schema).
DataplexEntryLinkAspect: Typed helper for the aspects.aspect block of google_dataplex_entry_link (derived from provider schema).
DataplexEntryLinkAspects: Typed helper for the aspects block of google_dataplex_entry_link (derived from provider schema).
DataplexEntryLinkEntryReferences: Typed helper for the entry_references block of google_dataplex_entry_link (derived from provider schema).
DataplexEntrySource: Typed helper for the entry_source block of google_dataplex_entry (derived from provider schema).
DataplexEntryTypeIamBindingCondition: Typed helper for the condition block of google_dataplex_entry_type_iam_binding (derived from provider schema).
DataplexEntryTypeIamMemberCondition: Typed helper for the condition block of google_dataplex_entry_type_iam_member (derived from provider schema).
DataplexEntryTypeRequiredAspects: Typed helper for the required_aspects block of google_dataplex_entry_type (derived from provider schema).
DataplexGlossaryIamBindingCondition: Typed helper for the condition block of google_dataplex_glossary_iam_binding (derived from provider schema).
DataplexGlossaryIamMemberCondition: Typed helper for the condition block of google_dataplex_glossary_iam_member (derived from provider schema).
DataplexLakeIamBindingCondition: Typed helper for the condition block of google_dataplex_lake_iam_binding (derived from provider schema).
DataplexLakeIamMemberCondition: Typed helper for the condition block of google_dataplex_lake_iam_member (derived from provider schema).
DataplexLakeMetastore: Typed helper for the metastore block of google_dataplex_lake (derived from provider schema).
DataplexMetadataFeedFilters: Typed helper for the filters block of google_dataplex_metadata_feed (derived from provider schema).
DataplexMetadataFeedScope: Typed helper for the scope block of google_dataplex_metadata_feed (derived from provider schema).
DataplexTaskBatch: Typed helper for the notebook.infrastructure_spec.batch block of google_dataplex_task (derived from provider schema). Shared by every block of this shape in the resource.
DataplexTaskContainerImage: Typed helper for the notebook.infrastructure_spec.container_image block of google_dataplex_task (derived from provider schema). Shared by every block of this shape in the resource.
DataplexTaskDriver: Exactly one of main_jar_file_uri, main_class, python_script_file, sql_script_file, sql_script on the spark block of google_dataplex_task: the provider rejects none and more than one, so each variant sets one of them.
DataplexTaskDriverMainClass: The DataplexTaskDriver.mainClass choice: sets main_class.
DataplexTaskDriverMainJarFileUri: The DataplexTaskDriver.mainJarFileUri choice: sets main_jar_file_uri.
DataplexTaskDriverPythonScriptFile: The DataplexTaskDriver.pythonScriptFile choice: sets python_script_file.
DataplexTaskDriverSqlScript: The DataplexTaskDriver.sqlScript choice: sets sql_script.
DataplexTaskDriverSqlScriptFile: The DataplexTaskDriver.sqlScriptFile choice: sets sql_script_file.
DataplexTaskExecutionSpec: Typed helper for the execution_spec block of google_dataplex_task (derived from provider schema).
DataplexTaskIamBindingCondition: Typed helper for the condition block of google_dataplex_task_iam_binding (derived from provider schema).
DataplexTaskIamMemberCondition: Typed helper for the condition block of google_dataplex_task_iam_member (derived from provider schema).
DataplexTaskInfrastructureSpec: Typed helper for the notebook.infrastructure_spec block of google_dataplex_task (derived from provider schema). Shared by every block of this shape in the resource.
DataplexTaskNotebook: Typed helper for the notebook block of google_dataplex_task (derived from provider schema).
DataplexTaskSpark: Typed helper for the spark block of google_dataplex_task (derived from provider schema).
DataplexTaskTarget: Exactly one of network, sub_network on the notebook.infrastructure_spec.vpc_network block of google_dataplex_task: the provider rejects none and more than one, so each variant sets one of them.
DataplexTaskTargetNetwork: The DataplexTaskTarget.network choice: sets network.
DataplexTaskTargetSubNetwork: The DataplexTaskTarget.subNetwork choice: sets sub_network.
DataplexTaskTriggerSpec: Typed helper for the trigger_spec block of google_dataplex_task (derived from provider schema).
DataplexTaskVpcNetwork: Typed helper for the notebook.infrastructure_spec.vpc_network block of google_dataplex_task (derived from provider schema). Shared by every block of this shape in the resource.
DataplexTaskWorkload: Exactly one of spark, notebook on google_dataplex_task: the provider rejects none and more than one, so each variant sets one of them.
DataplexTaskWorkloadNotebook: The DataplexTaskWorkload.notebook choice: sets notebook.
DataplexTaskWorkloadSpark: The DataplexTaskWorkload.spark choice: sets spark.
DataplexZoneCsvOptions: Typed helper for the discovery_spec.csv_options block of google_dataplex_zone (derived from provider schema).
DataplexZoneDiscoverySpec: Typed helper for the discovery_spec block of google_dataplex_zone (derived from provider schema).
DataplexZoneIamBindingCondition: Typed helper for the condition block of google_dataplex_zone_iam_binding (derived from provider schema).
DataplexZoneIamMemberCondition: Typed helper for the condition block of google_dataplex_zone_iam_member (derived from provider schema).
DataplexZoneJsonOptions: Typed helper for the discovery_spec.json_options block of google_dataplex_zone (derived from provider schema).
DataplexZoneResourceSpec: Typed helper for the resource_spec block of google_dataplex_zone (derived from provider schema).
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.
GoogleDataLineageConfig: Factory wrapper for google_data_lineage_config.
GoogleDataplexAspectType: Factory wrapper for google_dataplex_aspect_type.
GoogleDataplexAspectTypeIamBinding: Factory wrapper for google_dataplex_aspect_type_iam_binding.
GoogleDataplexAspectTypeIamMember: Factory wrapper for google_dataplex_aspect_type_iam_member.
GoogleDataplexAspectTypeIamPolicy: Factory wrapper for google_dataplex_aspect_type_iam_policy.
GoogleDataplexAsset: Factory wrapper for google_dataplex_asset.
GoogleDataplexAssetIamBinding: Factory wrapper for google_dataplex_asset_iam_binding.
GoogleDataplexAssetIamMember: Factory wrapper for google_dataplex_asset_iam_member.
GoogleDataplexAssetIamPolicy: Factory wrapper for google_dataplex_asset_iam_policy.
GoogleDataplexDataProduct: Factory wrapper for google_dataplex_data_product.
GoogleDataplexDataProductDataAsset: Factory wrapper for google_dataplex_data_product_data_asset.
GoogleDataplexDataProductIamBinding: Factory wrapper for google_dataplex_data_product_iam_binding.
GoogleDataplexDataProductIamMember: Factory wrapper for google_dataplex_data_product_iam_member.
GoogleDataplexDataProductIamPolicy: Factory wrapper for google_dataplex_data_product_iam_policy.
GoogleDataplexDatascan: Factory wrapper for google_dataplex_datascan.
GoogleDataplexDatascanIamBinding: Factory wrapper for google_dataplex_datascan_iam_binding.
GoogleDataplexDatascanIamMember: Factory wrapper for google_dataplex_datascan_iam_member.
GoogleDataplexDatascanIamPolicy: Factory wrapper for google_dataplex_datascan_iam_policy.
GoogleDataplexEntry: Factory wrapper for google_dataplex_entry.
GoogleDataplexEntryGroup: Factory wrapper for google_dataplex_entry_group.
GoogleDataplexEntryGroupIamBinding: Factory wrapper for google_dataplex_entry_group_iam_binding.
GoogleDataplexEntryGroupIamMember: Factory wrapper for google_dataplex_entry_group_iam_member.
GoogleDataplexEntryGroupIamPolicy: Factory wrapper for google_dataplex_entry_group_iam_policy.
GoogleDataplexEntryLink: Factory wrapper for google_dataplex_entry_link.
GoogleDataplexEntryType: Factory wrapper for google_dataplex_entry_type.
GoogleDataplexEntryTypeIamBinding: Factory wrapper for google_dataplex_entry_type_iam_binding.
GoogleDataplexEntryTypeIamMember: Factory wrapper for google_dataplex_entry_type_iam_member.
GoogleDataplexEntryTypeIamPolicy: Factory wrapper for google_dataplex_entry_type_iam_policy.
GoogleDataplexGlossary: Factory wrapper for google_dataplex_glossary.
GoogleDataplexGlossaryCategory: Factory wrapper for google_dataplex_glossary_category.
GoogleDataplexGlossaryIamBinding: Factory wrapper for google_dataplex_glossary_iam_binding.
GoogleDataplexGlossaryIamMember: Factory wrapper for google_dataplex_glossary_iam_member.
GoogleDataplexGlossaryIamPolicy: Factory wrapper for google_dataplex_glossary_iam_policy.
GoogleDataplexGlossaryTerm: Factory wrapper for google_dataplex_glossary_term.
GoogleDataplexLake: Factory wrapper for google_dataplex_lake.
GoogleDataplexLakeIamBinding: Factory wrapper for google_dataplex_lake_iam_binding.
GoogleDataplexLakeIamMember: Factory wrapper for google_dataplex_lake_iam_member.
GoogleDataplexLakeIamPolicy: Factory wrapper for google_dataplex_lake_iam_policy.
GoogleDataplexMetadataFeed: Factory wrapper for google_dataplex_metadata_feed.
GoogleDataplexTask: Factory wrapper for google_dataplex_task.
GoogleDataplexTaskIamBinding: Factory wrapper for google_dataplex_task_iam_binding.
GoogleDataplexTaskIamMember: Factory wrapper for google_dataplex_task_iam_member.
GoogleDataplexTaskIamPolicy: Factory wrapper for google_dataplex_task_iam_policy.
GoogleDataplexZone: Factory wrapper for google_dataplex_zone.
GoogleDataplexZoneIamBinding: Factory wrapper for google_dataplex_zone_iam_binding.
GoogleDataplexZoneIamMember: Factory wrapper for google_dataplex_zone_iam_member.
GoogleDataplexZoneIamPolicy: Factory wrapper for google_dataplex_zone_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

DataLineageConfigIntegration: integration — derived from the provider schema description.
DataplexAspectTypeDataClassification: Data-classification level a GoogleDataplexAspectType applies to the aspects (metadata) it governs.
DataplexAssetReadAccessMode: read_access_mode — derived from the provider schema description.
DataplexAssetType: type — derived from the provider schema description.
DataplexDatascanSqlDialect: sql_dialect — derived from the provider schema description.
DataplexDatascanState: Dataplex Datascan enum for state.
DataplexDatascanStatistic: statistic — derived from the provider schema description.
DataplexDatascanTableType: table_type — derived from the provider schema description.
DataplexDatascanType: Dataplex Datascan enum for type.
DataplexEntryLinkEntryReferencesType: type — derived from the provider schema description.
DataplexTaskType: type — derived from the provider schema description.
DataplexZoneLocationType: location_type — derived from the provider schema description.
DataplexZoneType: type on google_dataplex_zone.
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, ...).

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.

dataplex library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_google package

dataplex library