Skip to content

Latest commit

 

History

History
2366 lines (1468 loc) · 113 KB

discoveryEngineSearchEngine.go.md

File metadata and controls

2366 lines (1468 loc) · 113 KB

discoveryEngineSearchEngine Submodule

Constructs

DiscoveryEngineSearchEngine

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine google_discovery_engine_search_engine}.

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.NewDiscoveryEngineSearchEngine(scope Construct, id *string, config DiscoveryEngineSearchEngineConfig) DiscoveryEngineSearchEngine
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DiscoveryEngineSearchEngineConfig No description.

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
PutCommonConfig No description.
PutSearchEngineConfig No description.
PutTimeouts No description.
ResetCommonConfig No description.
ResetId No description.
ResetIndustryVertical No description.
ResetProject No description.
ResetTimeouts No description.

ToString
func ToString() *string

Returns a string representation of this construct.

AddOverride
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string

valueRequired
  • Type: interface{}

OverrideLogicalId
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform
func ToHclTerraform() interface{}
ToMetadata
func ToMetadata() interface{}
ToTerraform
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.


GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

HasResourceMove
func HasResourceMove() interface{}
ImportFrom
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

InterpolationForAttribute
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

MoveFromId
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


MoveTo
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


MoveToId
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


PutCommonConfig
func PutCommonConfig(value DiscoveryEngineSearchEngineCommonConfig)
valueRequired

PutSearchEngineConfig
func PutSearchEngineConfig(value DiscoveryEngineSearchEngineSearchEngineConfig)
valueRequired

PutTimeouts
func PutTimeouts(value DiscoveryEngineSearchEngineTimeouts)
valueRequired

ResetCommonConfig
func ResetCommonConfig()
ResetId
func ResetId()
ResetIndustryVertical
func ResetIndustryVertical()
ResetProject
func ResetProject()
ResetTimeouts
func ResetTimeouts()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a DiscoveryEngineSearchEngine resource upon running "cdktf plan ".

IsConstruct
import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.DiscoveryEngineSearchEngine_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.


IsTerraformElement
import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.DiscoveryEngineSearchEngine_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}

IsTerraformResource
import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.DiscoveryEngineSearchEngine_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}

GenerateConfigForImport
import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.DiscoveryEngineSearchEngine_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a DiscoveryEngineSearchEngine resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: *string

The construct id used in the generated config for the DiscoveryEngineSearchEngine to import.


importFromIdRequired
  • Type: *string

The id of the existing DiscoveryEngineSearchEngine that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the DiscoveryEngineSearchEngine to import is found.


Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
CommonConfig DiscoveryEngineSearchEngineCommonConfigOutputReference No description.
CreateTime *string No description.
Name *string No description.
SearchEngineConfig DiscoveryEngineSearchEngineSearchEngineConfigOutputReference No description.
Timeouts DiscoveryEngineSearchEngineTimeoutsOutputReference No description.
UpdateTime *string No description.
CollectionIdInput *string No description.
CommonConfigInput DiscoveryEngineSearchEngineCommonConfig No description.
DataStoreIdsInput *[]*string No description.
DisplayNameInput *string No description.
EngineIdInput *string No description.
IdInput *string No description.
IndustryVerticalInput *string No description.
LocationInput *string No description.
ProjectInput *string No description.
SearchEngineConfigInput DiscoveryEngineSearchEngineSearchEngineConfig No description.
TimeoutsInput interface{} No description.
CollectionId *string No description.
DataStoreIds *[]*string No description.
DisplayName *string No description.
EngineId *string No description.
Id *string No description.
IndustryVertical *string No description.
Location *string No description.
Project *string No description.

NodeRequired
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.


CdktfStackRequired
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

FqnRequired
func Fqn() *string
  • Type: *string

FriendlyUniqueIdRequired
func FriendlyUniqueId() *string
  • Type: *string

TerraformMetaArgumentsRequired
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}

TerraformResourceTypeRequired
func TerraformResourceType() *string
  • Type: *string

TerraformGeneratorMetadataOptional
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
func Connection() interface{}
  • Type: interface{}

CountOptional
func Count() interface{}
  • Type: interface{}

DependsOnOptional
func DependsOn() *[]*string
  • Type: *[]*string

ForEachOptional
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
func Provisioners() *[]interface{}
  • Type: *[]interface{}

CommonConfigRequired
func CommonConfig() DiscoveryEngineSearchEngineCommonConfigOutputReference

CreateTimeRequired
func CreateTime() *string
  • Type: *string

NameRequired
func Name() *string
  • Type: *string

SearchEngineConfigRequired
func SearchEngineConfig() DiscoveryEngineSearchEngineSearchEngineConfigOutputReference

TimeoutsRequired
func Timeouts() DiscoveryEngineSearchEngineTimeoutsOutputReference

UpdateTimeRequired
func UpdateTime() *string
  • Type: *string

CollectionIdInputOptional
func CollectionIdInput() *string
  • Type: *string

CommonConfigInputOptional
func CommonConfigInput() DiscoveryEngineSearchEngineCommonConfig

DataStoreIdsInputOptional
func DataStoreIdsInput() *[]*string
  • Type: *[]*string

DisplayNameInputOptional
func DisplayNameInput() *string
  • Type: *string

EngineIdInputOptional
func EngineIdInput() *string
  • Type: *string

IdInputOptional
func IdInput() *string
  • Type: *string

IndustryVerticalInputOptional
func IndustryVerticalInput() *string
  • Type: *string

LocationInputOptional
func LocationInput() *string
  • Type: *string

ProjectInputOptional
func ProjectInput() *string
  • Type: *string

SearchEngineConfigInputOptional
func SearchEngineConfigInput() DiscoveryEngineSearchEngineSearchEngineConfig

TimeoutsInputOptional
func TimeoutsInput() interface{}
  • Type: interface{}

CollectionIdRequired
func CollectionId() *string
  • Type: *string

DataStoreIdsRequired
func DataStoreIds() *[]*string
  • Type: *[]*string

DisplayNameRequired
func DisplayName() *string
  • Type: *string

EngineIdRequired
func EngineId() *string
  • Type: *string

IdRequired
func Id() *string
  • Type: *string

IndustryVerticalRequired
func IndustryVertical() *string
  • Type: *string

LocationRequired
func Location() *string
  • Type: *string

ProjectRequired
func Project() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.

TfResourceTypeRequired
func TfResourceType() *string
  • Type: *string

Structs

DiscoveryEngineSearchEngineCommonConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

&discoveryenginesearchengine.DiscoveryEngineSearchEngineCommonConfig {
	CompanyName: *string,
}

Properties

Name Type Description
CompanyName *string The name of the company, business or entity that is associated with the engine.

CompanyNameOptional
CompanyName *string
  • Type: *string

The name of the company, business or entity that is associated with the engine.

Setting this may help improve LLM related features.cd

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#company_name DiscoveryEngineSearchEngine#company_name}


DiscoveryEngineSearchEngineConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

&discoveryenginesearchengine.DiscoveryEngineSearchEngineConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	CollectionId: *string,
	DataStoreIds: *[]*string,
	DisplayName: *string,
	EngineId: *string,
	Location: *string,
	SearchEngineConfig: github.com/cdktf/cdktf-provider-google-go/google/v14.discoveryEngineSearchEngine.DiscoveryEngineSearchEngineSearchEngineConfig,
	CommonConfig: github.com/cdktf/cdktf-provider-google-go/google/v14.discoveryEngineSearchEngine.DiscoveryEngineSearchEngineCommonConfig,
	Id: *string,
	IndustryVertical: *string,
	Project: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.discoveryEngineSearchEngine.DiscoveryEngineSearchEngineTimeouts,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
CollectionId *string The collection ID.
DataStoreIds *[]*string The data stores associated with this engine.
DisplayName *string Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
EngineId *string Unique ID to use for Search Engine App.
Location *string Location.
SearchEngineConfig DiscoveryEngineSearchEngineSearchEngineConfig search_engine_config block.
CommonConfig DiscoveryEngineSearchEngineCommonConfig common_config block.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#id DiscoveryEngineSearchEngine#id}.
IndustryVertical *string The industry vertical that the engine registers.
Project *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.
Timeouts DiscoveryEngineSearchEngineTimeouts timeouts block.

ConnectionOptional
Connection interface{}
  • Type: interface{}

CountOptional
Count interface{}
  • Type: interface{}

DependsOnOptional
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

ForEachOptional
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

LifecycleOptional
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

ProviderOptional
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

ProvisionersOptional
Provisioners *[]interface{}
  • Type: *[]interface{}

CollectionIdRequired
CollectionId *string
  • Type: *string

The collection ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#collection_id DiscoveryEngineSearchEngine#collection_id}


DataStoreIdsRequired
DataStoreIds *[]*string
  • Type: *[]*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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#data_store_ids DiscoveryEngineSearchEngine#data_store_ids}


DisplayNameRequired
DisplayName *string
  • Type: *string

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/6.6.0/docs/resources/discovery_engine_search_engine#display_name DiscoveryEngineSearchEngine#display_name}


EngineIdRequired
EngineId *string
  • Type: *string

Unique ID to use for Search Engine App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#engine_id DiscoveryEngineSearchEngine#engine_id}


LocationRequired
Location *string
  • Type: *string

Location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#location DiscoveryEngineSearchEngine#location}


SearchEngineConfigRequired
SearchEngineConfig DiscoveryEngineSearchEngineSearchEngineConfig

search_engine_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#search_engine_config DiscoveryEngineSearchEngine#search_engine_config}


CommonConfigOptional
CommonConfig DiscoveryEngineSearchEngineCommonConfig

common_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#common_config DiscoveryEngineSearchEngine#common_config}


IdOptional
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/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.


IndustryVerticalOptional
IndustryVertical *string
  • Type: *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: "GENERIC" Possible values: ["GENERIC", "MEDIA"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#industry_vertical DiscoveryEngineSearchEngine#industry_vertical}


ProjectOptional
Project *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.


TimeoutsOptional
Timeouts DiscoveryEngineSearchEngineTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#timeouts DiscoveryEngineSearchEngine#timeouts}


DiscoveryEngineSearchEngineSearchEngineConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

&discoveryenginesearchengine.DiscoveryEngineSearchEngineSearchEngineConfig {
	SearchAddOns: *[]*string,
	SearchTier: *string,
}

Properties

Name Type Description
SearchAddOns *[]*string The add-on that this search engine enables. Possible values: ["SEARCH_ADD_ON_LLM"].
SearchTier *string The search feature tier of this engine.

SearchAddOnsOptional
SearchAddOns *[]*string
  • Type: *[]*string

The add-on that this search engine enables. Possible values: ["SEARCH_ADD_ON_LLM"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#search_add_ons DiscoveryEngineSearchEngine#search_add_ons}


SearchTierOptional
SearchTier *string
  • Type: *string

The search feature tier of this engine.

Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value: "SEARCH_TIER_STANDARD" Possible values: ["SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#search_tier DiscoveryEngineSearchEngine#search_tier}


DiscoveryEngineSearchEngineTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

&discoveryenginesearchengine.DiscoveryEngineSearchEngineTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

Name Type Description
Create *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#create DiscoveryEngineSearchEngine#create}.
Delete *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#delete DiscoveryEngineSearchEngine#delete}.
Update *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#update DiscoveryEngineSearchEngine#update}.

CreateOptional
Create *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#create DiscoveryEngineSearchEngine#create}.


DeleteOptional
Delete *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#delete DiscoveryEngineSearchEngine#delete}.


UpdateOptional
Update *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.0/docs/resources/discovery_engine_search_engine#update DiscoveryEngineSearchEngine#update}.


Classes

DiscoveryEngineSearchEngineCommonConfigOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.NewDiscoveryEngineSearchEngineCommonConfigOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DiscoveryEngineSearchEngineCommonConfigOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCompanyName No description.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCompanyName
func ResetCompanyName()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
CompanyNameInput *string No description.
CompanyName *string No description.
InternalValue DiscoveryEngineSearchEngineCommonConfig No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
func Fqn() *string
  • Type: *string

CompanyNameInputOptional
func CompanyNameInput() *string
  • Type: *string

CompanyNameRequired
func CompanyName() *string
  • Type: *string

InternalValueOptional
func InternalValue() DiscoveryEngineSearchEngineCommonConfig

DiscoveryEngineSearchEngineSearchEngineConfigOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.NewDiscoveryEngineSearchEngineSearchEngineConfigOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DiscoveryEngineSearchEngineSearchEngineConfigOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetSearchAddOns No description.
ResetSearchTier No description.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetSearchAddOns
func ResetSearchAddOns()
ResetSearchTier
func ResetSearchTier()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
SearchAddOnsInput *[]*string No description.
SearchTierInput *string No description.
SearchAddOns *[]*string No description.
SearchTier *string No description.
InternalValue DiscoveryEngineSearchEngineSearchEngineConfig No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
func Fqn() *string
  • Type: *string

SearchAddOnsInputOptional
func SearchAddOnsInput() *[]*string
  • Type: *[]*string

SearchTierInputOptional
func SearchTierInput() *string
  • Type: *string

SearchAddOnsRequired
func SearchAddOns() *[]*string
  • Type: *[]*string

SearchTierRequired
func SearchTier() *string
  • Type: *string

InternalValueOptional
func InternalValue() DiscoveryEngineSearchEngineSearchEngineConfig

DiscoveryEngineSearchEngineTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/discoveryenginesearchengine"

discoveryenginesearchengine.NewDiscoveryEngineSearchEngineTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DiscoveryEngineSearchEngineTimeoutsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCreate No description.
ResetDelete No description.
ResetUpdate No description.

ComputeFqn
func ComputeFqn() *string
GetAnyMapAttribute
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string

GetBooleanAttribute
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string

GetBooleanMapAttribute
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string

GetListAttribute
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string

GetNumberAttribute
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string

GetNumberListAttribute
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string

GetNumberMapAttribute
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string

GetStringAttribute
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string

GetStringMapAttribute
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string

InterpolationForAttribute
func InterpolationForAttribute(property *string) IResolvable
propertyRequired
  • Type: *string

Resolve
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

ToString
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
func ResetCreate()
ResetDelete
func ResetDelete()
ResetUpdate
func ResetUpdate()

Properties

Name Type Description
CreationStack *[]*string The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn *string No description.
CreateInput *string No description.
DeleteInput *string No description.
UpdateInput *string No description.
Create *string No description.
Delete *string No description.
Update *string No description.
InternalValue interface{} No description.

CreationStackRequired
func CreationStack() *[]*string
  • Type: *[]*string

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


FqnRequired
func Fqn() *string
  • Type: *string

CreateInputOptional
func CreateInput() *string
  • Type: *string

DeleteInputOptional
func DeleteInput() *string
  • Type: *string

UpdateInputOptional
func UpdateInput() *string
  • Type: *string

CreateRequired
func Create() *string
  • Type: *string

DeleteRequired
func Delete() *string
  • Type: *string

UpdateRequired
func Update() *string
  • Type: *string

InternalValueOptional
func InternalValue() interface{}
  • Type: interface{}