discovery_engine library

Vertex AI Search (Discovery Engine): data stores, search engines, IAM, schema / serving controls, location CMEK config and third-party data connectors (apply-excluded), and Gemini Enterprise license configs (never_apply — seat subscriptions).

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.
DataGoogleDiscoveryEngineDataStore
Factory wrapper for google_discovery_engine_data_store.
DataGoogleDiscoveryEngineDataStores
Factory wrapper for google_discovery_engine_data_stores.
DataGoogleDiscoveryEngineSearchEngineIamPolicy
Factory wrapper for google_discovery_engine_search_engine_iam_policy.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DiscoveryEngineAclConfigExternalIdpConfig
Typed helper for the idp_config.external_idp_config block of google_discovery_engine_acl_config (derived from provider schema).
DiscoveryEngineAclConfigIdpConfig
Typed helper for the idp_config block of google_discovery_engine_acl_config (derived from provider schema).
DiscoveryEngineAssistantBannedPhrases
Typed helper for the customer_policy.banned_phrases block of google_discovery_engine_assistant (derived from provider schema).
DiscoveryEngineAssistantCustomerPolicy
Typed helper for the customer_policy block of google_discovery_engine_assistant (derived from provider schema).
DiscoveryEngineAssistantGenerationConfig
Typed helper for the generation_config block of google_discovery_engine_assistant (derived from provider schema).
DiscoveryEngineAssistantModelArmorConfig
Typed helper for the customer_policy.model_armor_config block of google_discovery_engine_assistant (derived from provider schema).
DiscoveryEngineAssistantSystemInstruction
Typed helper for the generation_config.system_instruction block of google_discovery_engine_assistant (derived from provider schema).
DiscoveryEngineChatEngineAgent
Exactly one of agent_creation_config, dialogflow_agent_to_link on the chat_engine_config block of google_discovery_engine_chat_engine: the provider rejects none and more than one, so each variant sets one of them.
DiscoveryEngineChatEngineAgentCreationConfig
Typed helper for the chat_engine_config.agent_creation_config block of google_discovery_engine_chat_engine (derived from provider schema).
DiscoveryEngineChatEngineAgentCreationConfigChoice
The DiscoveryEngineChatEngineAgent.agentCreationConfig choice: sets agent_creation_config.
The DiscoveryEngineChatEngineAgent.dialogflowAgentToLink choice: sets dialogflow_agent_to_link.
DiscoveryEngineChatEngineCommonConfig
Typed helper for the common_config block of google_discovery_engine_chat_engine (derived from provider schema).
DiscoveryEngineChatEngineConfig
Typed helper for the chat_engine_config block of google_discovery_engine_chat_engine (derived from provider schema).
DiscoveryEngineCmekConfigSingleRegionKeys
Typed helper for the single_region_keys block of google_discovery_engine_cmek_config (derived from provider schema).
DiscoveryEngineControlAction
Exactly one of boost_action, filter_action, redirect_action, synonyms_action, promote_action on google_discovery_engine_control: the provider rejects none and more than one, so each variant sets one of them.
DiscoveryEngineControlActiveTimeRange
Typed helper for the conditions.active_time_range block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlBoost
Exactly one of fixed_boost, interpolation_boost_spec on the boost_action block of google_discovery_engine_control: the provider rejects none and more than one, so each variant sets one of them.
DiscoveryEngineControlBoostAction
Typed helper for the boost_action block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlBoostActionChoice
The DiscoveryEngineControlAction.boostAction choice: sets boost_action.
DiscoveryEngineControlBoostInterpolationBoostSpec
The DiscoveryEngineControlBoost.interpolationBoostSpec choice: sets interpolation_boost_spec.
DiscoveryEngineControlConditions
Typed helper for the conditions block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlFilterAction
Typed helper for the filter_action block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlFilterActionChoice
The DiscoveryEngineControlAction.filterAction choice: sets filter_action.
DiscoveryEngineControlFixedBoost
The DiscoveryEngineControlBoost.fixedBoost choice: sets fixed_boost.
DiscoveryEngineControlInterpolationBoostSpec
Typed helper for the boost_action.interpolation_boost_spec block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlPoint
Typed helper for the boost_action.interpolation_boost_spec.control_point block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlPromoteAction
Typed helper for the promote_action block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlPromoteActionChoice
The DiscoveryEngineControlAction.promoteAction choice: sets promote_action.
DiscoveryEngineControlQueryTerms
Typed helper for the conditions.query_terms block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlRedirectAction
Typed helper for the redirect_action block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlRedirectActionChoice
The DiscoveryEngineControlAction.redirectAction choice: sets redirect_action.
DiscoveryEngineControlSearchLinkPromotion
Typed helper for the promote_action.search_link_promotion block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlSynonymsAction
Typed helper for the synonyms_action block of google_discovery_engine_control (derived from provider schema).
DiscoveryEngineControlSynonymsActionChoice
The DiscoveryEngineControlAction.synonymsAction choice: sets synonyms_action.
DiscoveryEngineDataConnectorActionConfig
Typed helper for the action_config block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorBapConfig
Typed helper for the bap_config block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorDestinationConfigs
Typed helper for the destination_configs block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorDestinations
Typed helper for the destination_configs.destinations block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorEntities
Typed helper for the entities block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorJsonParams
The DiscoveryEngineDataConnectorParams.jsonParams choice: sets json_params.
DiscoveryEngineDataConnectorMetadata
Typed helper for the metadata block of google_discovery_engine_data_connector (derived from provider schema).
DiscoveryEngineDataConnectorParams
Exactly one of params, json_params on google_discovery_engine_data_connector: the provider rejects none and more than one, so each variant sets one of them.
DiscoveryEngineDataConnectorParamsChoice
The DiscoveryEngineDataConnectorParams.params choice: sets params.
DiscoveryEngineDataStoreAdvancedSiteSearchConfig
Typed helper for the advanced_site_search_config block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineDataStoreChunkingConfig
Typed helper for the document_processing_config.chunking_config block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineDataStoreDefaultParsingConfig
Typed helper for the document_processing_config.default_parsing_config block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineDataStoreDigitalParsingConfig
Typed helper for the document_processing_config.default_parsing_config.digital_parsing_config block of google_discovery_engine_data_store (derived from provider schema). Shared by every block of this shape in the resource.
DiscoveryEngineDataStoreDocumentProcessingConfig
Typed helper for the document_processing_config block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineDataStoreLayoutBasedChunkingConfig
Typed helper for the document_processing_config.chunking_config.layout_based_chunking_config block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineDataStoreLayoutParsingConfig
Typed helper for the document_processing_config.default_parsing_config.layout_parsing_config block of google_discovery_engine_data_store (derived from provider schema). Shared by every block of this shape in the resource.
DiscoveryEngineDataStoreOcrParsingConfig
Typed helper for the document_processing_config.default_parsing_config.ocr_parsing_config block of google_discovery_engine_data_store (derived from provider schema). Shared by every block of this shape in the resource.
DiscoveryEngineDataStoreParsingConfigOverrides
Typed helper for the document_processing_config.parsing_config_overrides block of google_discovery_engine_data_store (derived from provider schema).
DiscoveryEngineLicenseConfigEndDate
Typed helper for the end_date block of google_discovery_engine_license_config (derived from provider schema).
DiscoveryEngineLicenseConfigStartDate
Typed helper for the start_date block of google_discovery_engine_license_config (derived from provider schema).
DiscoveryEngineRecommendationEngineCommonConfig
Typed helper for the common_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineRecommendationEngineFeaturesConfig
Typed helper for the media_recommendation_engine_config.engine_features_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineRecommendationEngineMediaRecommendationEngineConfig
Typed helper for the media_recommendation_engine_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineRecommendationEngineMostPopularConfig
Typed helper for the media_recommendation_engine_config.engine_features_config.most_popular_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineRecommendationEngineOptimizationObjectiveConfig
Typed helper for the media_recommendation_engine_config.optimization_objective_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineRecommendationEngineRecommendedForYouConfig
Typed helper for the media_recommendation_engine_config.engine_features_config.recommended_for_you_config block of google_discovery_engine_recommendation_engine (derived from provider schema).
DiscoveryEngineSearchEngineCommonConfig
Typed helper for the common_config block of google_discovery_engine_search_engine (derived from provider schema).
DiscoveryEngineSearchEngineConfig
Typed helper for the search_engine_config block of google_discovery_engine_search_engine (derived from provider schema).
DiscoveryEngineSearchEngineFeatureConfig
Typed helper for the knowledge_graph_config.feature_config block of google_discovery_engine_search_engine (derived from provider schema).
DiscoveryEngineSearchEngineIamBindingCondition
Typed helper for the condition block of google_discovery_engine_search_engine_iam_binding (derived from provider schema).
DiscoveryEngineSearchEngineIamMemberCondition
Typed helper for the condition block of google_discovery_engine_search_engine_iam_member (derived from provider schema).
DiscoveryEngineSearchEngineKnowledgeGraphConfig
Typed helper for the knowledge_graph_config block of google_discovery_engine_search_engine (derived from provider schema).
DiscoveryEngineWidgetConfigAccessSettings
Typed helper for the access_settings block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigDataStoreUiConfigs
Typed helper for the ui_settings.data_store_ui_configs block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigFacetField
Typed helper for the ui_settings.data_store_ui_configs.facet_field block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigFieldsUiComponentsMap
Typed helper for the ui_settings.data_store_ui_configs.fields_ui_components_map block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigGenerativeAnswerConfig
Typed helper for the ui_settings.generative_answer_config block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigHomepageSetting
Typed helper for the homepage_setting block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigIcon
Typed helper for the homepage_setting.shortcuts.icon block of google_discovery_engine_widget_config (derived from provider schema).
Typed helper for the ui_branding.logo block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigSearchAddonSpec
Typed helper for the ui_settings.search_addon_spec block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigShortcuts
Typed helper for the homepage_setting.shortcuts block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigUiBranding
Typed helper for the ui_branding block of google_discovery_engine_widget_config (derived from provider schema).
DiscoveryEngineWidgetConfigUiSettings
Typed helper for the ui_settings block of google_discovery_engine_widget_config (derived from provider schema).
EnvironmentConstant
The AppConstant.fromEnvironment choice.
GcsBackend
terraform { backend "gcs" { ... } } configuration.
GoogleDiscoveryEngineAclConfig
Factory wrapper for google_discovery_engine_acl_config.
GoogleDiscoveryEngineAssistant
Factory wrapper for google_discovery_engine_assistant.
GoogleDiscoveryEngineChatEngine
Factory wrapper for google_discovery_engine_chat_engine.
GoogleDiscoveryEngineCmekConfig
Factory wrapper for google_discovery_engine_cmek_config.
GoogleDiscoveryEngineControl
Factory wrapper for google_discovery_engine_control.
GoogleDiscoveryEngineDataConnector
Factory wrapper for google_discovery_engine_data_connector.
GoogleDiscoveryEngineDataStore
Factory wrapper for google_discovery_engine_data_store.
GoogleDiscoveryEngineLicenseConfig
Factory wrapper for google_discovery_engine_license_config.
GoogleDiscoveryEngineRecommendationEngine
Factory wrapper for google_discovery_engine_recommendation_engine.
GoogleDiscoveryEngineSchema
Factory wrapper for google_discovery_engine_schema.
GoogleDiscoveryEngineSearchEngine
Factory wrapper for google_discovery_engine_search_engine.
GoogleDiscoveryEngineSearchEngineIamBinding
Factory wrapper for google_discovery_engine_search_engine_iam_binding.
GoogleDiscoveryEngineSearchEngineIamMember
Factory wrapper for google_discovery_engine_search_engine_iam_member.
GoogleDiscoveryEngineSearchEngineIamPolicy
Factory wrapper for google_discovery_engine_search_engine_iam_policy.
GoogleDiscoveryEngineServingConfig
Factory wrapper for google_discovery_engine_serving_config.
GoogleDiscoveryEngineSitemap
Factory wrapper for google_discovery_engine_sitemap.
GoogleDiscoveryEngineTargetSite
Factory wrapper for google_discovery_engine_target_site.
GoogleDiscoveryEngineUserStore
Factory wrapper for google_discovery_engine_user_store.
GoogleDiscoveryEngineWidgetConfig
Factory wrapper for google_discovery_engine_widget_config.
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

DiscoveryEngineAclConfigIdpType
idp_type — derived from the provider schema description.
DiscoveryEngineChatEngineIndustryVertical
Discovery Engine Chat Engine Industry enum for industry_vertical.
DiscoveryEngineControlAttributeType
attribute_type — derived from the provider schema description.
DiscoveryEngineControlSolutionType
Discovery Engine Control Solution enum for solution_type.
DiscoveryEngineDataStoreContentConfig
Discovery Engine Data Store Content enum for content_config.
DiscoveryEngineDataStoreIndustryVertical
Discovery Engine Data Store Industry enum for industry_vertical.
DiscoveryEngineLicenseConfigSubscriptionTerm
Discovery Engine License Config Subscription enum for subscription_term.
DiscoveryEngineLicenseConfigSubscriptionTier
Discovery Engine License Config Subscription enum for subscription_tier.
DiscoveryEngineRecommendationEngineIndustryVertical
Discovery Engine Recommendation Engine Industry enum for industry_vertical.
DiscoveryEngineRecommendationEngineTrainingState
training_state — derived from the provider schema description.
DiscoveryEngineSearchEngineIndustryVertical
Discovery Engine Search Engine Industry enum for industry_vertical.
DiscoveryEngineSearchEngineRequiredSubscriptionTier
required_subscription_tier — derived from the provider schema description.
DiscoveryEngineSearchEngineTier
search_engine_config.search_tier.
DiscoveryEngineTargetSiteIndexingStatus
Discovery Engine Target Site Indexing enum for indexing_status.
DiscoveryEngineTargetSiteType
Discovery Engine Target Site enum for type.
DiscoveryEngineWidgetConfigDeviceVisibility
device_visibility — derived from the provider schema description.
DiscoveryEngineWidgetConfigImageSource
image_source — derived from the provider schema description.
DiscoveryEngineWidgetConfigInteractionType
interaction_type — derived from the provider schema description.
DiscoveryEngineWidgetConfigResultDescriptionType
result_description_type — derived from the provider schema description.
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.