colab library

Colab Enterprise — runtimes, runtime templates, template IAM, paused notebook execution schedules, and one-shot notebook executions (Vertex AI notebook runtimes; runtime/execution compute is never_apply).

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.
ColabNotebookExecutionCompute: Exactly one of notebook_runtime_template_resource_name, custom_environment_spec on google_colab_notebook_execution: the provider rejects none and more than one, so each variant sets one of them.
ColabNotebookExecutionComputeCustomEnvironmentSpec: The ColabNotebookExecutionCompute.customEnvironmentSpec choice: sets custom_environment_spec.
ColabNotebookExecutionComputeNotebookRuntimeTemplateResourceName: The ColabNotebookExecutionCompute.notebookRuntimeTemplateResourceName choice: sets notebook_runtime_template_resource_name.
ColabNotebookExecutionCustomEnvironmentSpec: Typed helper for the custom_environment_spec block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionDataformRepositorySource: Typed helper for the dataform_repository_source block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionDataformRepositorySourceChoice: The ColabNotebookExecutionSource.dataformRepositorySource choice: sets dataform_repository_source.
ColabNotebookExecutionDirectNotebookSource: Typed helper for the direct_notebook_source block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionDirectNotebookSourceChoice: The ColabNotebookExecutionSource.directNotebookSource choice: sets direct_notebook_source.
ColabNotebookExecutionGcsNotebookSource: Typed helper for the gcs_notebook_source block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionGcsNotebookSourceChoice: The ColabNotebookExecutionSource.gcsNotebookSource choice: sets gcs_notebook_source.
ColabNotebookExecutionIdentity: Exactly one of execution_user, service_account on google_colab_notebook_execution: the provider rejects none and more than one, so each variant sets one of them.
ColabNotebookExecutionIdentityExecutionUser: The ColabNotebookExecutionIdentity.executionUser choice: sets execution_user.
ColabNotebookExecutionIdentityServiceAccount: The ColabNotebookExecutionIdentity.serviceAccount choice: sets service_account.
ColabNotebookExecutionMachineSpec: Typed helper for the custom_environment_spec.machine_spec block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionNetworkSpec: Typed helper for the custom_environment_spec.network_spec block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionPersistentDiskSpec: Typed helper for the custom_environment_spec.persistent_disk_spec block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionSelector: Exactly one of family, name on the workbench_runtime.vm_image block of google_colab_notebook_execution: the provider rejects none and more than one, so each variant sets one of them.
ColabNotebookExecutionSelectorFamily: The ColabNotebookExecutionSelector.family choice: sets family.
ColabNotebookExecutionSelectorName: The ColabNotebookExecutionSelector.name choice: sets name.
ColabNotebookExecutionShieldedInstanceConfig: Typed helper for the custom_environment_spec.shielded_instance_config block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionSource: Exactly one of dataform_repository_source, gcs_notebook_source, direct_notebook_source on google_colab_notebook_execution: the provider rejects none and more than one, so each variant sets one of them.
ColabNotebookExecutionVmImage: Typed helper for the workbench_runtime.vm_image block of google_colab_notebook_execution (derived from provider schema).
ColabNotebookExecutionWorkbenchRuntime: Typed helper for the workbench_runtime block of google_colab_notebook_execution (derived from provider schema).
ColabRuntimeNotebookRuntimeTemplateRef: Typed helper for the notebook_runtime_template_ref block of google_colab_runtime (derived from provider schema).
ColabRuntimeTemplateColabImage: Typed helper for the software_config.colab_image block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateDataPersistentDiskSpec: Typed helper for the data_persistent_disk_spec block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateEncryptionSpec: Typed helper for the encryption_spec block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateEnv: Typed helper for the software_config.env block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateEucConfig: Typed helper for the euc_config block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateIamBindingCondition: Typed helper for the condition block of google_colab_runtime_template_iam_binding (derived from provider schema).
ColabRuntimeTemplateIamMemberCondition: Typed helper for the condition block of google_colab_runtime_template_iam_member (derived from provider schema).
ColabRuntimeTemplateIdleShutdownConfig: Typed helper for the idle_shutdown_config block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateMachineSpec: Typed helper for the machine_spec block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateNetworkSpec: Typed helper for the network_spec block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplatePostStartupScriptConfig: Typed helper for the software_config.post_startup_script_config block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateShieldedVmConfig: Typed helper for the shielded_vm_config block of google_colab_runtime_template (derived from provider schema).
ColabRuntimeTemplateSoftwareConfig: Typed helper for the software_config block of google_colab_runtime_template (derived from provider schema).
ColabScheduleCompute: Exactly one of notebook_runtime_template_resource_name, custom_environment_spec on the create_notebook_execution_job_request.notebook_execution_job block of google_colab_schedule: the provider rejects none and more than one, so each variant sets one of them.
ColabScheduleComputeCustomEnvironmentSpec: The ColabScheduleCompute.customEnvironmentSpec choice: sets custom_environment_spec.
ColabScheduleComputeNotebookRuntimeTemplateResourceName: The ColabScheduleCompute.notebookRuntimeTemplateResourceName choice: sets notebook_runtime_template_resource_name.
ColabScheduleCreateNotebookExecutionJobRequest: Typed helper for the create_notebook_execution_job_request block of google_colab_schedule (derived from provider schema).
ColabScheduleCreateNotebookExecutionJobRequestChoice: The ColabScheduleRequest.createNotebookExecutionJobRequest choice: sets create_notebook_execution_job_request.
ColabScheduleCreatePipelineJobRequest: Typed helper for the create_pipeline_job_request block of google_colab_schedule (derived from provider schema).
ColabScheduleCreatePipelineJobRequestChoice: The ColabScheduleRequest.createPipelineJobRequest choice: sets create_pipeline_job_request.
ColabScheduleCustomEnvironmentSpec: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.custom_environment_spec block of google_colab_schedule (derived from provider schema).
ColabScheduleDataformRepositorySource: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.dataform_repository_source block of google_colab_schedule (derived from provider schema).
ColabScheduleDataformRepositorySourceChoice: The ColabScheduleSource.dataformRepositorySource choice: sets dataform_repository_source.
ColabScheduleDnsPeeringConfigs: Typed helper for the create_pipeline_job_request.pipeline_job.psc_interface_config.dns_peering_configs block of google_colab_schedule (derived from provider schema).
ColabScheduleEncryptionSpec: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.encryption_spec block of google_colab_schedule (derived from provider schema). Shared by every block of this shape in the resource.
ColabScheduleGcsNotebookSource: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.gcs_notebook_source block of google_colab_schedule (derived from provider schema).
ColabScheduleGcsNotebookSourceChoice: The ColabScheduleSource.gcsNotebookSource choice: sets gcs_notebook_source.
ColabScheduleIdentity: Exactly one of execution_user, service_account on the create_notebook_execution_job_request.notebook_execution_job block of google_colab_schedule: the provider rejects none and more than one, so each variant sets one of them.
ColabScheduleIdentityExecutionUser: The ColabScheduleIdentity.executionUser choice: sets execution_user.
ColabScheduleIdentityServiceAccount: The ColabScheduleIdentity.serviceAccount choice: sets service_account.
ColabScheduleMachineSpec: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.custom_environment_spec.machine_spec block of google_colab_schedule (derived from provider schema).
ColabScheduleNetworkSpec: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.custom_environment_spec.network_spec block of google_colab_schedule (derived from provider schema).
ColabScheduleNotebookExecutionJob: Typed helper for the create_notebook_execution_job_request.notebook_execution_job block of google_colab_schedule (derived from provider schema).
ColabSchedulePersistentDiskSpec: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.custom_environment_spec.persistent_disk_spec block of google_colab_schedule (derived from provider schema).
ColabSchedulePipelineJob: Typed helper for the create_pipeline_job_request.pipeline_job block of google_colab_schedule (derived from provider schema).
ColabSchedulePscInterfaceConfig: Typed helper for the create_pipeline_job_request.pipeline_job.psc_interface_config block of google_colab_schedule (derived from provider schema).
ColabScheduleRequest: Exactly one of create_notebook_execution_job_request, create_pipeline_job_request on google_colab_schedule: the provider rejects none and more than one, so each variant sets one of them.
ColabScheduleReservationAffinity: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.custom_environment_spec.machine_spec.reservation_affinity block of google_colab_schedule (derived from provider schema).
ColabScheduleRuntimeConfig: Typed helper for the create_pipeline_job_request.pipeline_job.runtime_config block of google_colab_schedule (derived from provider schema).
ColabScheduleSource: Exactly one of dataform_repository_source, gcs_notebook_source on the create_notebook_execution_job_request.notebook_execution_job block of google_colab_schedule: the provider rejects none and more than one, so each variant sets one of them.
ColabScheduleWorkbenchRuntime: Typed helper for the create_notebook_execution_job_request.notebook_execution_job.workbench_runtime block of google_colab_schedule (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.
DataGoogleColabRuntimeTemplateIamPolicy: Factory wrapper for google_colab_runtime_template_iam_policy.
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.
GoogleColabNotebookExecution: Factory wrapper for google_colab_notebook_execution.
GoogleColabRuntime: Factory wrapper for google_colab_runtime.
GoogleColabRuntimeTemplate: Factory wrapper for google_colab_runtime_template.
GoogleColabRuntimeTemplateIamBinding: Factory wrapper for google_colab_runtime_template_iam_binding.
GoogleColabRuntimeTemplateIamMember: Factory wrapper for google_colab_runtime_template_iam_member.
GoogleColabRuntimeTemplateIamPolicy: Factory wrapper for google_colab_runtime_template_iam_policy.
GoogleColabSchedule: Factory wrapper for google_colab_schedule.
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

ColabRuntimeDesiredState: Terraform desired_state for GoogleColabRuntime.
ColabRuntimeTemplatePostStartupScriptBehavior: post_startup_script_behavior — derived from the provider schema description.
ColabScheduleDesiredState: Terraform desired_state for GoogleColabSchedule.
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.

colab library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_google package

colab library