Package com.hashicorp.cdktf.providers.google.discovery_engine_search_engine

Interface DiscoveryEngineSearchEngineConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    DiscoveryEngineSearchEngineConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.057Z")
@Stability(Stable)
public interface DiscoveryEngineSearchEngineConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCollectionId

        @Stability(Stable)
@NotNull
String getCollectionId()
        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}

      • getDataStoreIds

        @Stability(Stable)
@NotNull
List<String> getDataStoreIds()
        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}

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        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}

      • getEngineId

        @Stability(Stable)
@NotNull
String getEngineId()
        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}

      • getLocation

        @Stability(Stable)
@NotNull
String getLocation()
        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}

      • getSearchEngineConfig

        @Stability(Stable)
@NotNull
DiscoveryEngineSearchEngineSearchEngineConfig getSearchEngineConfig()
        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}

      • getCommonConfig

        @Stability(Stable)
@Nullable
default DiscoveryEngineSearchEngineCommonConfig getCommonConfig()
        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}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        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.

      • getIndustryVertical

        @Stability(Stable)
@Nullable
default String getIndustryVertical()
        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}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.

      • getTimeouts

        @Stability(Stable)
@Nullable
default DiscoveryEngineSearchEngineTimeouts getTimeouts()
        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}