SearchEngineArgs class - discoveryengine library

Constructors

SearchEngineArgs({Input<String?>? appType, required Input<String> collectionId, Input<SearchEngineCommonConfig?>? commonConfig, required Input<List<String>> dataStoreIds, Input<String?>? deletionPolicy, Input<bool?>? disableAnalytics, required Input<String> displayName, required Input<String> engineId, Input<Map<String, String>?>? features, Input<String?>? industryVertical, Input<String?>? kmsKeyName, Input<SearchEngineKnowledgeGraphConfig?>? knowledgeGraphConfig, required Input<String> location, Input<String?>? project, required Input<SearchEngineSearchEngineConfig> searchEngineConfig}): Creates a new SearchEngineArgs. appType This is the application type this engine resource represents. collectionId The collection ID. commonConfig Common config spec that specifies the metadata of the engine. dataStoreIds The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. disableAnalytics Whether to disable analytics for searches performed on this engine. displayName Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. engineId Unique ID to use for Search Engine App. features A map of the feature config for the engine to opt in or opt out of features. industryVertical The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. kmsKeyName The KMS key to be used to protect this Engine at creation time. knowledgeGraphConfig Configurations for the Knowledge Graph. location Location. project The ID of the project in which the resource belongs. searchEngineConfig Configurations for a Search Engine.
const
SearchEngineArgs.fromMap(Map<String, dynamic> map): factory

Properties

appType → Input<String?>?: This is the application type this engine resource represents. The supported values: 'APP_TYPE_UNSPECIFIED', 'APP_TYPE_INTRANET'.
final
collectionId → Input<String>: The collection ID.
final
commonConfig → Input<SearchEngineCommonConfig?>?: Common config spec that specifies the metadata of the engine. Structure is documented below.
final
dataStoreIds → Input<List<String>>: The data stores associated with this engine. For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.
final
deletionPolicy → Input<String?>?: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
disableAnalytics → Input<bool?>?: Whether to disable analytics for searches performed on this engine.
final
displayName → Input<String>: Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
final
engineId → Input<String>: Unique ID to use for Search Engine App.
final
features → Input<Map<String, String>?>?: A map of the feature config for the engine to opt in or opt out of features.
final
hashCode → int: The hash code for this object.
no setterinherited
industryVertical → Input<String?>?: The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. Default value is GENERIC. Possible values are: GENERIC, MEDIA, HEALTHCARE_FHIR.
final
kmsKeyName → Input<String?>?: The KMS key to be used to protect this Engine at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Engine will be protected by the KMS key, as indicated in the cmekConfig field.
final
knowledgeGraphConfig → Input<SearchEngineKnowledgeGraphConfig?>?: Configurations for the Knowledge Graph. Structure is documented below.
final
location → Input<String>: Location.
final
project → Input<String?>?: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
searchEngineConfig → Input<SearchEngineSearchEngineConfig>: Configurations for a Search Engine. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited