Class DiscoveryEngineDataStore.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.discovery_engine_data_store.DiscoveryEngineDataStore.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DiscoveryEngineDataStore>
- Enclosing class:
- DiscoveryEngineDataStore
@Stability(Stable) public static final class DiscoveryEngineDataStore.Builder extends Object implements software.amazon.jsii.Builder<DiscoveryEngineDataStore>
A fluent builder forDiscoveryEngineDataStore.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DiscoveryEngineDataStorebuild()DiscoveryEngineDataStore.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)DiscoveryEngineDataStore.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)DiscoveryEngineDataStore.BuildercontentConfig(String contentConfig)The content config of the data store.DiscoveryEngineDataStore.Buildercount(com.hashicorp.cdktf.TerraformCount count)DiscoveryEngineDataStore.Buildercount(Number count)static DiscoveryEngineDataStore.Buildercreate(software.constructs.Construct scope, String id)DiscoveryEngineDataStore.BuildercreateAdvancedSiteSearch(com.hashicorp.cdktf.IResolvable createAdvancedSiteSearch)If true, an advanced data store for site search will be created.DiscoveryEngineDataStore.BuildercreateAdvancedSiteSearch(Boolean createAdvancedSiteSearch)If true, an advanced data store for site search will be created.DiscoveryEngineDataStore.BuilderdataStoreId(String dataStoreId)The unique id of the data store.DiscoveryEngineDataStore.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)DiscoveryEngineDataStore.BuilderdisplayName(String displayName)The display name of the data store.DiscoveryEngineDataStore.BuilderdocumentProcessingConfig(DiscoveryEngineDataStoreDocumentProcessingConfig documentProcessingConfig)document_processing_config block.DiscoveryEngineDataStore.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)DiscoveryEngineDataStore.Builderid(String id)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#id DiscoveryEngineDataStore#id}.DiscoveryEngineDataStore.BuilderindustryVertical(String industryVertical)The industry vertical that the data store registers.DiscoveryEngineDataStore.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)DiscoveryEngineDataStore.Builderlocation(String location)The geographic location where the data store should reside.DiscoveryEngineDataStore.Builderproject(String project)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#project DiscoveryEngineDataStore#project}.DiscoveryEngineDataStore.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)DiscoveryEngineDataStore.Builderprovisioners(List<? extends Object> provisioners)DiscoveryEngineDataStore.BuilderskipDefaultSchemaCreation(com.hashicorp.cdktf.IResolvable skipDefaultSchemaCreation)A boolean flag indicating whether to skip the default schema creation for the data store.DiscoveryEngineDataStore.BuilderskipDefaultSchemaCreation(Boolean skipDefaultSchemaCreation)A boolean flag indicating whether to skip the default schema creation for the data store.DiscoveryEngineDataStore.BuildersolutionTypes(List<String> solutionTypes)The solutions that the data store enrolls.DiscoveryEngineDataStore.Buildertimeouts(DiscoveryEngineDataStoreTimeouts timeouts)timeouts block.
-
-
-
Method Detail
-
create
@Stability(Stable) public static DiscoveryEngineDataStore.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
DiscoveryEngineDataStore.Builder.
-
connection
@Stability(Experimental) public DiscoveryEngineDataStore.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
connection
@Stability(Experimental) public DiscoveryEngineDataStore.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public DiscoveryEngineDataStore.Builder count(Number count)
- Parameters:
count- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public DiscoveryEngineDataStore.Builder count(com.hashicorp.cdktf.TerraformCount count)
- Parameters:
count- This parameter is required.- Returns:
this
-
dependsOn
@Stability(Experimental) public DiscoveryEngineDataStore.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
- Parameters:
dependsOn- This parameter is required.- Returns:
this
-
forEach
@Stability(Experimental) public DiscoveryEngineDataStore.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
- Parameters:
forEach- This parameter is required.- Returns:
this
-
lifecycle
@Stability(Experimental) public DiscoveryEngineDataStore.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
- Parameters:
lifecycle- This parameter is required.- Returns:
this
-
provider
@Stability(Experimental) public DiscoveryEngineDataStore.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
- Parameters:
provider- This parameter is required.- Returns:
this
-
provisioners
@Stability(Experimental) public DiscoveryEngineDataStore.Builder provisioners(List<? extends Object> provisioners)
- Parameters:
provisioners- This parameter is required.- Returns:
this
-
contentConfig
@Stability(Stable) public DiscoveryEngineDataStore.Builder contentConfig(String contentConfig)
The content config of the data store. Possible values: ["NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE"].Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#content_config DiscoveryEngineDataStore#content_config}
- Parameters:
contentConfig- The content config of the data store. Possible values: ["NO_CONTENT", "CONTENT_REQUIRED", "PUBLIC_WEBSITE"]. This parameter is required.- Returns:
this
-
dataStoreId
@Stability(Stable) public DiscoveryEngineDataStore.Builder dataStoreId(String dataStoreId)
The unique id of the data store.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#data_store_id DiscoveryEngineDataStore#data_store_id}
- Parameters:
dataStoreId- The unique id of the data store. This parameter is required.- Returns:
this
-
displayName
@Stability(Stable) public DiscoveryEngineDataStore.Builder displayName(String displayName)
The display name of the data store.This field must be a UTF-8 encoded string with a length limit of 128 characters. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#display_name DiscoveryEngineDataStore#display_name}
- Parameters:
displayName- The display name of the data store. This parameter is required.- Returns:
this
-
industryVertical
@Stability(Stable) public DiscoveryEngineDataStore.Builder industryVertical(String industryVertical)
The industry vertical that the data store registers. Possible values: ["GENERIC", "MEDIA"].Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#industry_vertical DiscoveryEngineDataStore#industry_vertical}
- Parameters:
industryVertical- The industry vertical that the data store registers. Possible values: ["GENERIC", "MEDIA"]. This parameter is required.- Returns:
this
-
location
@Stability(Stable) public DiscoveryEngineDataStore.Builder location(String location)
The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#location DiscoveryEngineDataStore#location}
- Parameters:
location- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu". This parameter is required.- Returns:
this
-
createAdvancedSiteSearch
@Stability(Stable) public DiscoveryEngineDataStore.Builder createAdvancedSiteSearch(Boolean createAdvancedSiteSearch)
If true, an advanced data store for site search will be created.If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE contentConfig), this flag will be ignored. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#create_advanced_site_search DiscoveryEngineDataStore#create_advanced_site_search}
- Parameters:
createAdvancedSiteSearch- If true, an advanced data store for site search will be created. This parameter is required.- Returns:
this
-
createAdvancedSiteSearch
@Stability(Stable) public DiscoveryEngineDataStore.Builder createAdvancedSiteSearch(com.hashicorp.cdktf.IResolvable createAdvancedSiteSearch)
If true, an advanced data store for site search will be created.If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE contentConfig), this flag will be ignored. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#create_advanced_site_search DiscoveryEngineDataStore#create_advanced_site_search}
- Parameters:
createAdvancedSiteSearch- If true, an advanced data store for site search will be created. This parameter is required.- Returns:
this
-
documentProcessingConfig
@Stability(Stable) public DiscoveryEngineDataStore.Builder documentProcessingConfig(DiscoveryEngineDataStoreDocumentProcessingConfig documentProcessingConfig)
document_processing_config block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#document_processing_config DiscoveryEngineDataStore#document_processing_config}
- Parameters:
documentProcessingConfig- document_processing_config block. This parameter is required.- Returns:
this
-
id
@Stability(Stable) public DiscoveryEngineDataStore.Builder id(String id)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#id DiscoveryEngineDataStore#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_data_store#id DiscoveryEngineDataStore#id}. This parameter is required.- Returns:
this
-
project
@Stability(Stable) public DiscoveryEngineDataStore.Builder project(String project)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#project DiscoveryEngineDataStore#project}.- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#project DiscoveryEngineDataStore#project}. This parameter is required.- Returns:
this
-
skipDefaultSchemaCreation
@Stability(Stable) public DiscoveryEngineDataStore.Builder skipDefaultSchemaCreation(Boolean skipDefaultSchemaCreation)
A boolean flag indicating whether to skip the default schema creation for the data store.Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if 'data_store.starting_schema' is specified. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#skip_default_schema_creation DiscoveryEngineDataStore#skip_default_schema_creation}
- Parameters:
skipDefaultSchemaCreation- A boolean flag indicating whether to skip the default schema creation for the data store. This parameter is required.- Returns:
this
-
skipDefaultSchemaCreation
@Stability(Stable) public DiscoveryEngineDataStore.Builder skipDefaultSchemaCreation(com.hashicorp.cdktf.IResolvable skipDefaultSchemaCreation)
A boolean flag indicating whether to skip the default schema creation for the data store.Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if 'data_store.starting_schema' is specified. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#skip_default_schema_creation DiscoveryEngineDataStore#skip_default_schema_creation}
- Parameters:
skipDefaultSchemaCreation- A boolean flag indicating whether to skip the default schema creation for the data store. This parameter is required.- Returns:
this
-
solutionTypes
@Stability(Stable) public DiscoveryEngineDataStore.Builder solutionTypes(List<String> solutionTypes)
The solutions that the data store enrolls. Possible values: ["SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT"].Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#solution_types DiscoveryEngineDataStore#solution_types}
- Parameters:
solutionTypes- The solutions that the data store enrolls. Possible values: ["SOLUTION_TYPE_RECOMMENDATION", "SOLUTION_TYPE_SEARCH", "SOLUTION_TYPE_CHAT"]. This parameter is required.- Returns:
this
-
timeouts
@Stability(Stable) public DiscoveryEngineDataStore.Builder timeouts(DiscoveryEngineDataStoreTimeouts timeouts)
timeouts block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_data_store#timeouts DiscoveryEngineDataStore#timeouts}
- Parameters:
timeouts- timeouts block. This parameter is required.- Returns:
this
-
build
@Stability(Stable) public DiscoveryEngineDataStore build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DiscoveryEngineDataStore>- Returns:
- a newly built instance of
DiscoveryEngineDataStore.
-
-