Class DiscoveryEngineSearchEngine.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.discovery_engine_search_engine.DiscoveryEngineSearchEngine.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DiscoveryEngineSearchEngine>
- Enclosing class:
- DiscoveryEngineSearchEngine
@Stability(Stable) public static final class DiscoveryEngineSearchEngine.Builder extends Object implements software.amazon.jsii.Builder<DiscoveryEngineSearchEngine>
A fluent builder forDiscoveryEngineSearchEngine.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DiscoveryEngineSearchEnginebuild()DiscoveryEngineSearchEngine.BuildercollectionId(String collectionId)The collection ID.DiscoveryEngineSearchEngine.BuildercommonConfig(DiscoveryEngineSearchEngineCommonConfig commonConfig)common_config block.DiscoveryEngineSearchEngine.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)DiscoveryEngineSearchEngine.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)DiscoveryEngineSearchEngine.Buildercount(com.hashicorp.cdktf.TerraformCount count)DiscoveryEngineSearchEngine.Buildercount(Number count)static DiscoveryEngineSearchEngine.Buildercreate(software.constructs.Construct scope, String id)DiscoveryEngineSearchEngine.BuilderdataStoreIds(List<String> dataStoreIds)The data stores associated with this engine.DiscoveryEngineSearchEngine.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)DiscoveryEngineSearchEngine.BuilderdisplayName(String displayName)Required.DiscoveryEngineSearchEngine.BuilderengineId(String engineId)Unique ID to use for Search Engine App.DiscoveryEngineSearchEngine.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)DiscoveryEngineSearchEngine.Builderid(String id)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#id DiscoveryEngineSearchEngine#id}.DiscoveryEngineSearchEngine.BuilderindustryVertical(String industryVertical)The industry vertical that the engine registers.DiscoveryEngineSearchEngine.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)DiscoveryEngineSearchEngine.Builderlocation(String location)Location.DiscoveryEngineSearchEngine.Builderproject(String project)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.DiscoveryEngineSearchEngine.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)DiscoveryEngineSearchEngine.Builderprovisioners(List<? extends Object> provisioners)DiscoveryEngineSearchEngine.BuildersearchEngineConfig(DiscoveryEngineSearchEngineSearchEngineConfig searchEngineConfig)search_engine_config block.DiscoveryEngineSearchEngine.Buildertimeouts(DiscoveryEngineSearchEngineTimeouts timeouts)timeouts block.
-
-
-
Method Detail
-
create
@Stability(Stable) public static DiscoveryEngineSearchEngine.Builder create(software.constructs.Construct scope, String id)
- Parameters:
scope- The scope in which to define this construct. This parameter is required.id- The scoped construct ID. This parameter is required.- Returns:
- a new instance of
DiscoveryEngineSearchEngine.Builder.
-
connection
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
connection
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder count(Number count)
- Parameters:
count- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder count(com.hashicorp.cdktf.TerraformCount count)
- Parameters:
count- This parameter is required.- Returns:
this
-
dependsOn
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
- Parameters:
dependsOn- This parameter is required.- Returns:
this
-
forEach
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
- Parameters:
forEach- This parameter is required.- Returns:
this
-
lifecycle
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
- Parameters:
lifecycle- This parameter is required.- Returns:
this
-
provider
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
- Parameters:
provider- This parameter is required.- Returns:
this
-
provisioners
@Stability(Experimental) public DiscoveryEngineSearchEngine.Builder provisioners(List<? extends Object> provisioners)
- Parameters:
provisioners- This parameter is required.- Returns:
this
-
collectionId
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder collectionId(String collectionId)
The collection ID.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#collection_id DiscoveryEngineSearchEngine#collection_id}
- Parameters:
collectionId- The collection ID. This parameter is required.- Returns:
this
-
dataStoreIds
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder dataStoreIds(List<String> 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#data_store_ids DiscoveryEngineSearchEngine#data_store_ids}
- Parameters:
dataStoreIds- The data stores associated with this engine. This parameter is required.- Returns:
this
-
displayName
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder displayName(String displayName)
Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#display_name DiscoveryEngineSearchEngine#display_name}
- Parameters:
displayName- Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. This parameter is required.- Returns:
this
-
engineId
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder engineId(String engineId)
Unique ID to use for Search Engine App.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#engine_id DiscoveryEngineSearchEngine#engine_id}
- Parameters:
engineId- Unique ID to use for Search Engine App. This parameter is required.- Returns:
this
-
location
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder location(String location)
Location.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#location DiscoveryEngineSearchEngine#location}
- Parameters:
location- Location. This parameter is required.- Returns:
this
-
searchEngineConfig
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder searchEngineConfig(DiscoveryEngineSearchEngineSearchEngineConfig searchEngineConfig)
search_engine_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#search_engine_config DiscoveryEngineSearchEngine#search_engine_config}
- Parameters:
searchEngineConfig- search_engine_config block. This parameter is required.- Returns:
this
-
commonConfig
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder commonConfig(DiscoveryEngineSearchEngineCommonConfig commonConfig)
common_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#common_config DiscoveryEngineSearchEngine#common_config}
- Parameters:
commonConfig- common_config block. This parameter is required.- Returns:
this
-
id
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder id(String id)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#id DiscoveryEngineSearchEngine#id}.Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#id DiscoveryEngineSearchEngine#id}. This parameter is required.- Returns:
this
-
industryVertical
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder industryVertical(String 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. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#industry_vertical DiscoveryEngineSearchEngine#industry_vertical}
- Parameters:
industryVertical- The industry vertical that the engine registers. This parameter is required.- Returns:
this
-
project
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder project(String project)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}. This parameter is required.- Returns:
this
-
timeouts
@Stability(Stable) public DiscoveryEngineSearchEngine.Builder timeouts(DiscoveryEngineSearchEngineTimeouts timeouts)
timeouts block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#timeouts DiscoveryEngineSearchEngine#timeouts}
- Parameters:
timeouts- timeouts block. This parameter is required.- Returns:
this
-
build
@Stability(Stable) public DiscoveryEngineSearchEngine build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DiscoveryEngineSearchEngine>- Returns:
- a newly built instance of
DiscoveryEngineSearchEngine.
-
-