Controls are rules that influence search results.
To get more information about Control, see:
- API documentation
- How-to Guides
Example Usage
Discoveryengine Control Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = new gcp.discoveryengine.DataStore("basic", {
location: "global",
dataStoreId: "data-store-id",
displayName: "tf-test-datastore",
industryVertical: "GENERIC",
contentConfig: "NO_CONTENT",
solutionTypes: ["SOLUTION_TYPE_SEARCH"],
createAdvancedSiteSearch: false,
});
const basicSearchEngine = new gcp.discoveryengine.SearchEngine("basic", {
engineId: "engine-id",
collectionId: "default_collection",
location: basic.location,
displayName: "tf-test-engine",
dataStoreIds: [basic.dataStoreId],
industryVertical: "GENERIC",
appType: "APP_TYPE_INTRANET",
searchEngineConfig: {},
});
const basicControl = new gcp.discoveryengine.Control("basic", {
location: basicSearchEngine.location,
engineId: basicSearchEngine.engineId,
controlId: "control-id",
displayName: "tf-test-control",
solutionType: "SOLUTION_TYPE_SEARCH",
useCases: ["SEARCH_USE_CASE_SEARCH"],
synonymsAction: {
synonyms: [
"test",
"experiment",
],
},
});
import pulumi
import pulumi_gcp as gcp
basic = gcp.discoveryengine.DataStore("basic",
location="global",
data_store_id="data-store-id",
display_name="tf-test-datastore",
industry_vertical="GENERIC",
content_config="NO_CONTENT",
solution_types=["SOLUTION_TYPE_SEARCH"],
create_advanced_site_search=False)
basic_search_engine = gcp.discoveryengine.SearchEngine("basic",
engine_id="engine-id",
collection_id="default_collection",
location=basic.location,
display_name="tf-test-engine",
data_store_ids=[basic.data_store_id],
industry_vertical="GENERIC",
app_type="APP_TYPE_INTRANET",
search_engine_config={})
basic_control = gcp.discoveryengine.Control("basic",
location=basic_search_engine.location,
engine_id=basic_search_engine.engine_id,
control_id="control-id",
display_name="tf-test-control",
solution_type="SOLUTION_TYPE_SEARCH",
use_cases=["SEARCH_USE_CASE_SEARCH"],
synonyms_action={
"synonyms": [
"test",
"experiment",
],
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
basic, err := discoveryengine.NewDataStore(ctx, "basic", &discoveryengine.DataStoreArgs{
Location: pulumi.String("global"),
DataStoreId: pulumi.String("data-store-id"),
DisplayName: pulumi.String("tf-test-datastore"),
IndustryVertical: pulumi.String("GENERIC"),
ContentConfig: pulumi.String("NO_CONTENT"),
SolutionTypes: pulumi.StringArray{
pulumi.String("SOLUTION_TYPE_SEARCH"),
},
CreateAdvancedSiteSearch: pulumi.Bool(false),
})
if err != nil {
return err
}
basicSearchEngine, err := discoveryengine.NewSearchEngine(ctx, "basic", &discoveryengine.SearchEngineArgs{
EngineId: pulumi.String("engine-id"),
CollectionId: pulumi.String("default_collection"),
Location: basic.Location,
DisplayName: pulumi.String("tf-test-engine"),
DataStoreIds: pulumi.StringArray{
basic.DataStoreId,
},
IndustryVertical: pulumi.String("GENERIC"),
AppType: pulumi.String("APP_TYPE_INTRANET"),
SearchEngineConfig: &discoveryengine.SearchEngineSearchEngineConfigArgs{},
})
if err != nil {
return err
}
_, err = discoveryengine.NewControl(ctx, "basic", &discoveryengine.ControlArgs{
Location: basicSearchEngine.Location,
EngineId: basicSearchEngine.EngineId,
ControlId: pulumi.String("control-id"),
DisplayName: pulumi.String("tf-test-control"),
SolutionType: pulumi.String("SOLUTION_TYPE_SEARCH"),
UseCases: pulumi.StringArray{
pulumi.String("SEARCH_USE_CASE_SEARCH"),
},
SynonymsAction: &discoveryengine.ControlSynonymsActionArgs{
Synonyms: pulumi.StringArray{
pulumi.String("test"),
pulumi.String("experiment"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var basic = new Gcp.DiscoveryEngine.DataStore("basic", new()
{
Location = "global",
DataStoreId = "data-store-id",
DisplayName = "tf-test-datastore",
IndustryVertical = "GENERIC",
ContentConfig = "NO_CONTENT",
SolutionTypes = new[]
{
"SOLUTION_TYPE_SEARCH",
},
CreateAdvancedSiteSearch = false,
});
var basicSearchEngine = new Gcp.DiscoveryEngine.SearchEngine("basic", new()
{
EngineId = "engine-id",
CollectionId = "default_collection",
Location = basic.Location,
DisplayName = "tf-test-engine",
DataStoreIds = new[]
{
basic.DataStoreId,
},
IndustryVertical = "GENERIC",
AppType = "APP_TYPE_INTRANET",
SearchEngineConfig = null,
});
var basicControl = new Gcp.DiscoveryEngine.Control("basic", new()
{
Location = basicSearchEngine.Location,
EngineId = basicSearchEngine.EngineId,
ControlId = "control-id",
DisplayName = "tf-test-control",
SolutionType = "SOLUTION_TYPE_SEARCH",
UseCases = new[]
{
"SEARCH_USE_CASE_SEARCH",
},
SynonymsAction = new Gcp.DiscoveryEngine.Inputs.ControlSynonymsActionArgs
{
Synonyms = new[]
{
"test",
"experiment",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.discoveryengine.DataStore;
import com.pulumi.gcp.discoveryengine.DataStoreArgs;
import com.pulumi.gcp.discoveryengine.SearchEngine;
import com.pulumi.gcp.discoveryengine.SearchEngineArgs;
import com.pulumi.gcp.discoveryengine.inputs.SearchEngineSearchEngineConfigArgs;
import com.pulumi.gcp.discoveryengine.Control;
import com.pulumi.gcp.discoveryengine.ControlArgs;
import com.pulumi.gcp.discoveryengine.inputs.ControlSynonymsActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var basic = new DataStore("basic", DataStoreArgs.builder()
.location("global")
.dataStoreId("data-store-id")
.displayName("tf-test-datastore")
.industryVertical("GENERIC")
.contentConfig("NO_CONTENT")
.solutionTypes("SOLUTION_TYPE_SEARCH")
.createAdvancedSiteSearch(false)
.build());
var basicSearchEngine = new SearchEngine("basicSearchEngine", SearchEngineArgs.builder()
.engineId("engine-id")
.collectionId("default_collection")
.location(basic.location())
.displayName("tf-test-engine")
.dataStoreIds(basic.dataStoreId())
.industryVertical("GENERIC")
.appType("APP_TYPE_INTRANET")
.searchEngineConfig(SearchEngineSearchEngineConfigArgs.builder()
.build())
.build());
var basicControl = new Control("basicControl", ControlArgs.builder()
.location(basicSearchEngine.location())
.engineId(basicSearchEngine.engineId())
.controlId("control-id")
.displayName("tf-test-control")
.solutionType("SOLUTION_TYPE_SEARCH")
.useCases("SEARCH_USE_CASE_SEARCH")
.synonymsAction(ControlSynonymsActionArgs.builder()
.synonyms(
"test",
"experiment")
.build())
.build());
}
}
resources:
basic:
type: gcp:discoveryengine:DataStore
properties:
location: global
dataStoreId: data-store-id
displayName: tf-test-datastore
industryVertical: GENERIC
contentConfig: NO_CONTENT
solutionTypes:
- SOLUTION_TYPE_SEARCH
createAdvancedSiteSearch: false
basicSearchEngine:
type: gcp:discoveryengine:SearchEngine
name: basic
properties:
engineId: engine-id
collectionId: default_collection
location: ${basic.location}
displayName: tf-test-engine
dataStoreIds:
- ${basic.dataStoreId}
industryVertical: GENERIC
appType: APP_TYPE_INTRANET
searchEngineConfig: {}
basicControl:
type: gcp:discoveryengine:Control
name: basic
properties:
location: ${basicSearchEngine.location}
engineId: ${basicSearchEngine.engineId}
controlId: control-id
displayName: tf-test-control
solutionType: SOLUTION_TYPE_SEARCH
useCases:
- SEARCH_USE_CASE_SEARCH
synonymsAction:
synonyms:
- test
- experiment
Create Control Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Control(name: string, args: ControlArgs, opts?: CustomResourceOptions);@overload
def Control(resource_name: str,
args: ControlArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Control(resource_name: str,
opts: Optional[ResourceOptions] = None,
engine_id: Optional[str] = None,
solution_type: Optional[str] = None,
location: Optional[str] = None,
control_id: Optional[str] = None,
display_name: Optional[str] = None,
filter_action: Optional[ControlFilterActionArgs] = None,
boost_action: Optional[ControlBoostActionArgs] = None,
conditions: Optional[Sequence[ControlConditionArgs]] = None,
project: Optional[str] = None,
promote_action: Optional[ControlPromoteActionArgs] = None,
redirect_action: Optional[ControlRedirectActionArgs] = None,
collection_id: Optional[str] = None,
synonyms_action: Optional[ControlSynonymsActionArgs] = None,
use_cases: Optional[Sequence[str]] = None)func NewControl(ctx *Context, name string, args ControlArgs, opts ...ResourceOption) (*Control, error)public Control(string name, ControlArgs args, CustomResourceOptions? opts = null)
public Control(String name, ControlArgs args)
public Control(String name, ControlArgs args, CustomResourceOptions options)
type: gcp:discoveryengine:Control
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ControlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ControlArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ControlArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ControlArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ControlArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var controlResource = new Gcp.DiscoveryEngine.Control("controlResource", new()
{
EngineId = "string",
SolutionType = "string",
Location = "string",
ControlId = "string",
DisplayName = "string",
FilterAction = new Gcp.DiscoveryEngine.Inputs.ControlFilterActionArgs
{
DataStore = "string",
Filter = "string",
},
BoostAction = new Gcp.DiscoveryEngine.Inputs.ControlBoostActionArgs
{
DataStore = "string",
Filter = "string",
FixedBoost = 0,
InterpolationBoostSpec = new Gcp.DiscoveryEngine.Inputs.ControlBoostActionInterpolationBoostSpecArgs
{
AttributeType = "string",
ControlPoint = new Gcp.DiscoveryEngine.Inputs.ControlBoostActionInterpolationBoostSpecControlPointArgs
{
AttributeValue = "string",
BoostAmount = 0,
},
FieldName = "string",
InterpolationType = "string",
},
},
Conditions = new[]
{
new Gcp.DiscoveryEngine.Inputs.ControlConditionArgs
{
ActiveTimeRanges = new[]
{
new Gcp.DiscoveryEngine.Inputs.ControlConditionActiveTimeRangeArgs
{
EndTime = "string",
StartTime = "string",
},
},
QueryRegex = "string",
QueryTerms = new[]
{
new Gcp.DiscoveryEngine.Inputs.ControlConditionQueryTermArgs
{
FullMatch = false,
Value = "string",
},
},
},
},
Project = "string",
PromoteAction = new Gcp.DiscoveryEngine.Inputs.ControlPromoteActionArgs
{
DataStore = "string",
SearchLinkPromotion = new Gcp.DiscoveryEngine.Inputs.ControlPromoteActionSearchLinkPromotionArgs
{
Title = "string",
Description = "string",
Document = "string",
Enabled = false,
ImageUri = "string",
Uri = "string",
},
},
RedirectAction = new Gcp.DiscoveryEngine.Inputs.ControlRedirectActionArgs
{
RedirectUri = "string",
},
CollectionId = "string",
SynonymsAction = new Gcp.DiscoveryEngine.Inputs.ControlSynonymsActionArgs
{
Synonyms = new[]
{
"string",
},
},
UseCases = new[]
{
"string",
},
});
example, err := discoveryengine.NewControl(ctx, "controlResource", &discoveryengine.ControlArgs{
EngineId: pulumi.String("string"),
SolutionType: pulumi.String("string"),
Location: pulumi.String("string"),
ControlId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FilterAction: &discoveryengine.ControlFilterActionArgs{
DataStore: pulumi.String("string"),
Filter: pulumi.String("string"),
},
BoostAction: &discoveryengine.ControlBoostActionArgs{
DataStore: pulumi.String("string"),
Filter: pulumi.String("string"),
FixedBoost: pulumi.Float64(0),
InterpolationBoostSpec: &discoveryengine.ControlBoostActionInterpolationBoostSpecArgs{
AttributeType: pulumi.String("string"),
ControlPoint: &discoveryengine.ControlBoostActionInterpolationBoostSpecControlPointArgs{
AttributeValue: pulumi.String("string"),
BoostAmount: pulumi.Float64(0),
},
FieldName: pulumi.String("string"),
InterpolationType: pulumi.String("string"),
},
},
Conditions: discoveryengine.ControlConditionArray{
&discoveryengine.ControlConditionArgs{
ActiveTimeRanges: discoveryengine.ControlConditionActiveTimeRangeArray{
&discoveryengine.ControlConditionActiveTimeRangeArgs{
EndTime: pulumi.String("string"),
StartTime: pulumi.String("string"),
},
},
QueryRegex: pulumi.String("string"),
QueryTerms: discoveryengine.ControlConditionQueryTermArray{
&discoveryengine.ControlConditionQueryTermArgs{
FullMatch: pulumi.Bool(false),
Value: pulumi.String("string"),
},
},
},
},
Project: pulumi.String("string"),
PromoteAction: &discoveryengine.ControlPromoteActionArgs{
DataStore: pulumi.String("string"),
SearchLinkPromotion: &discoveryengine.ControlPromoteActionSearchLinkPromotionArgs{
Title: pulumi.String("string"),
Description: pulumi.String("string"),
Document: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ImageUri: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
RedirectAction: &discoveryengine.ControlRedirectActionArgs{
RedirectUri: pulumi.String("string"),
},
CollectionId: pulumi.String("string"),
SynonymsAction: &discoveryengine.ControlSynonymsActionArgs{
Synonyms: pulumi.StringArray{
pulumi.String("string"),
},
},
UseCases: pulumi.StringArray{
pulumi.String("string"),
},
})
var controlResource = new Control("controlResource", ControlArgs.builder()
.engineId("string")
.solutionType("string")
.location("string")
.controlId("string")
.displayName("string")
.filterAction(ControlFilterActionArgs.builder()
.dataStore("string")
.filter("string")
.build())
.boostAction(ControlBoostActionArgs.builder()
.dataStore("string")
.filter("string")
.fixedBoost(0.0)
.interpolationBoostSpec(ControlBoostActionInterpolationBoostSpecArgs.builder()
.attributeType("string")
.controlPoint(ControlBoostActionInterpolationBoostSpecControlPointArgs.builder()
.attributeValue("string")
.boostAmount(0.0)
.build())
.fieldName("string")
.interpolationType("string")
.build())
.build())
.conditions(ControlConditionArgs.builder()
.activeTimeRanges(ControlConditionActiveTimeRangeArgs.builder()
.endTime("string")
.startTime("string")
.build())
.queryRegex("string")
.queryTerms(ControlConditionQueryTermArgs.builder()
.fullMatch(false)
.value("string")
.build())
.build())
.project("string")
.promoteAction(ControlPromoteActionArgs.builder()
.dataStore("string")
.searchLinkPromotion(ControlPromoteActionSearchLinkPromotionArgs.builder()
.title("string")
.description("string")
.document("string")
.enabled(false)
.imageUri("string")
.uri("string")
.build())
.build())
.redirectAction(ControlRedirectActionArgs.builder()
.redirectUri("string")
.build())
.collectionId("string")
.synonymsAction(ControlSynonymsActionArgs.builder()
.synonyms("string")
.build())
.useCases("string")
.build());
control_resource = gcp.discoveryengine.Control("controlResource",
engine_id="string",
solution_type="string",
location="string",
control_id="string",
display_name="string",
filter_action={
"data_store": "string",
"filter": "string",
},
boost_action={
"data_store": "string",
"filter": "string",
"fixed_boost": 0,
"interpolation_boost_spec": {
"attribute_type": "string",
"control_point": {
"attribute_value": "string",
"boost_amount": 0,
},
"field_name": "string",
"interpolation_type": "string",
},
},
conditions=[{
"active_time_ranges": [{
"end_time": "string",
"start_time": "string",
}],
"query_regex": "string",
"query_terms": [{
"full_match": False,
"value": "string",
}],
}],
project="string",
promote_action={
"data_store": "string",
"search_link_promotion": {
"title": "string",
"description": "string",
"document": "string",
"enabled": False,
"image_uri": "string",
"uri": "string",
},
},
redirect_action={
"redirect_uri": "string",
},
collection_id="string",
synonyms_action={
"synonyms": ["string"],
},
use_cases=["string"])
const controlResource = new gcp.discoveryengine.Control("controlResource", {
engineId: "string",
solutionType: "string",
location: "string",
controlId: "string",
displayName: "string",
filterAction: {
dataStore: "string",
filter: "string",
},
boostAction: {
dataStore: "string",
filter: "string",
fixedBoost: 0,
interpolationBoostSpec: {
attributeType: "string",
controlPoint: {
attributeValue: "string",
boostAmount: 0,
},
fieldName: "string",
interpolationType: "string",
},
},
conditions: [{
activeTimeRanges: [{
endTime: "string",
startTime: "string",
}],
queryRegex: "string",
queryTerms: [{
fullMatch: false,
value: "string",
}],
}],
project: "string",
promoteAction: {
dataStore: "string",
searchLinkPromotion: {
title: "string",
description: "string",
document: "string",
enabled: false,
imageUri: "string",
uri: "string",
},
},
redirectAction: {
redirectUri: "string",
},
collectionId: "string",
synonymsAction: {
synonyms: ["string"],
},
useCases: ["string"],
});
type: gcp:discoveryengine:Control
properties:
boostAction:
dataStore: string
filter: string
fixedBoost: 0
interpolationBoostSpec:
attributeType: string
controlPoint:
attributeValue: string
boostAmount: 0
fieldName: string
interpolationType: string
collectionId: string
conditions:
- activeTimeRanges:
- endTime: string
startTime: string
queryRegex: string
queryTerms:
- fullMatch: false
value: string
controlId: string
displayName: string
engineId: string
filterAction:
dataStore: string
filter: string
location: string
project: string
promoteAction:
dataStore: string
searchLinkPromotion:
description: string
document: string
enabled: false
imageUri: string
title: string
uri: string
redirectAction:
redirectUri: string
solutionType: string
synonymsAction:
synonyms:
- string
useCases:
- string
Control Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Control resource accepts the following input properties:
- Control
Id string - The unique id of the control.
- Display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Engine
Id string - The engine to add the control to.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - Boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- Collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- Conditions
List<Control
Condition> - The conditions under which the control is active. Structure is documented below.
- Filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- Redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- Synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- Use
Cases List<string> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- Control
Id string - The unique id of the control.
- Display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Engine
Id string - The engine to add the control to.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - Boost
Action ControlBoost Action Args - Changes the returned order of results. Structure is documented below.
- Collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- Conditions
[]Control
Condition Args - The conditions under which the control is active. Structure is documented below.
- Filter
Action ControlFilter Action Args - Removes entries from returned results. Structure is documented below.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Promote
Action ControlPromote Action Args - Promotes a specified link for a query. Structure is documented below.
- Redirect
Action ControlRedirect Action Args - Redirects to a specified URI. Structure is documented below.
- Synonyms
Action ControlSynonyms Action Args - Associates queries with each other. Structure is documented below.
- Use
Cases []string - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- control
Id String - The unique id of the control.
- display
Name String - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id String - The engine to add the control to.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- solution
Type String - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- collection
Id String - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
List<Control
Condition> - The conditions under which the control is active. Structure is documented below.
- filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- use
Cases List<String> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- control
Id string - The unique id of the control.
- display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id string - The engine to add the control to.
- location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
Control
Condition[] - The conditions under which the control is active. Structure is documented below.
- filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- use
Cases string[] - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- control_
id str - The unique id of the control.
- display_
name str - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine_
id str - The engine to add the control to.
- location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- solution_
type str - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - boost_
action ControlBoost Action Args - Changes the returned order of results. Structure is documented below.
- collection_
id str - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
Sequence[Control
Condition Args] - The conditions under which the control is active. Structure is documented below.
- filter_
action ControlFilter Action Args - Removes entries from returned results. Structure is documented below.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote_
action ControlPromote Action Args - Promotes a specified link for a query. Structure is documented below.
- redirect_
action ControlRedirect Action Args - Redirects to a specified URI. Structure is documented below.
- synonyms_
action ControlSynonyms Action Args - Associates queries with each other. Structure is documented below.
- use_
cases Sequence[str] - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- control
Id String - The unique id of the control.
- display
Name String - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id String - The engine to add the control to.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- solution
Type String - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - boost
Action Property Map - Changes the returned order of results. Structure is documented below.
- collection
Id String - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions List<Property Map>
- The conditions under which the control is active. Structure is documented below.
- filter
Action Property Map - Removes entries from returned results. Structure is documented below.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action Property Map - Promotes a specified link for a query. Structure is documented below.
- redirect
Action Property Map - Redirects to a specified URI. Structure is documented below.
- synonyms
Action Property Map - Associates queries with each other. Structure is documented below.
- use
Cases List<String> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
Outputs
All input properties are implicitly available as output properties. Additionally, the Control resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Look up Existing Control Resource
Get an existing Control resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ControlState, opts?: CustomResourceOptions): Control@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
boost_action: Optional[ControlBoostActionArgs] = None,
collection_id: Optional[str] = None,
conditions: Optional[Sequence[ControlConditionArgs]] = None,
control_id: Optional[str] = None,
display_name: Optional[str] = None,
engine_id: Optional[str] = None,
filter_action: Optional[ControlFilterActionArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
promote_action: Optional[ControlPromoteActionArgs] = None,
redirect_action: Optional[ControlRedirectActionArgs] = None,
solution_type: Optional[str] = None,
synonyms_action: Optional[ControlSynonymsActionArgs] = None,
use_cases: Optional[Sequence[str]] = None) -> Controlfunc GetControl(ctx *Context, name string, id IDInput, state *ControlState, opts ...ResourceOption) (*Control, error)public static Control Get(string name, Input<string> id, ControlState? state, CustomResourceOptions? opts = null)public static Control get(String name, Output<String> id, ControlState state, CustomResourceOptions options)resources: _: type: gcp:discoveryengine:Control get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- Collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- Conditions
List<Control
Condition> - The conditions under which the control is active. Structure is documented below.
- Control
Id string - The unique id of the control.
- Display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Engine
Id string - The engine to add the control to.
- Filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- Redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- Solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - Synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- Use
Cases List<string> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- Boost
Action ControlBoost Action Args - Changes the returned order of results. Structure is documented below.
- Collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- Conditions
[]Control
Condition Args - The conditions under which the control is active. Structure is documented below.
- Control
Id string - The unique id of the control.
- Display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- Engine
Id string - The engine to add the control to.
- Filter
Action ControlFilter Action Args - Removes entries from returned results. Structure is documented below.
- Location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- Name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Promote
Action ControlPromote Action Args - Promotes a specified link for a query. Structure is documented below.
- Redirect
Action ControlRedirect Action Args - Redirects to a specified URI. Structure is documented below.
- Solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - Synonyms
Action ControlSynonyms Action Args - Associates queries with each other. Structure is documented below.
- Use
Cases []string - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- collection
Id String - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
List<Control
Condition> - The conditions under which the control is active. Structure is documented below.
- control
Id String - The unique id of the control.
- display
Name String - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id String - The engine to add the control to.
- filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- solution
Type String - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- use
Cases List<String> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- boost
Action ControlBoost Action - Changes the returned order of results. Structure is documented below.
- collection
Id string - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
Control
Condition[] - The conditions under which the control is active. Structure is documented below.
- control
Id string - The unique id of the control.
- display
Name string - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id string - The engine to add the control to.
- filter
Action ControlFilter Action - Removes entries from returned results. Structure is documented below.
- location string
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name string
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action ControlPromote Action - Promotes a specified link for a query. Structure is documented below.
- redirect
Action ControlRedirect Action - Redirects to a specified URI. Structure is documented below.
- solution
Type string - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - synonyms
Action ControlSynonyms Action - Associates queries with each other. Structure is documented below.
- use
Cases string[] - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- boost_
action ControlBoost Action Args - Changes the returned order of results. Structure is documented below.
- collection_
id str - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions
Sequence[Control
Condition Args] - The conditions under which the control is active. Structure is documented below.
- control_
id str - The unique id of the control.
- display_
name str - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine_
id str - The engine to add the control to.
- filter_
action ControlFilter Action Args - Removes entries from returned results. Structure is documented below.
- location str
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name str
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote_
action ControlPromote Action Args - Promotes a specified link for a query. Structure is documented below.
- redirect_
action ControlRedirect Action Args - Redirects to a specified URI. Structure is documented below.
- solution_
type str - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - synonyms_
action ControlSynonyms Action Args - Associates queries with each other. Structure is documented below.
- use_
cases Sequence[str] - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
- boost
Action Property Map - Changes the returned order of results. Structure is documented below.
- collection
Id String - The collection ID. Currently only accepts <span pulumi-lang-nodejs=""defaultCollection"" pulumi-lang-dotnet=""DefaultCollection"" pulumi-lang-go=""defaultCollection"" pulumi-lang-python=""default_collection"" pulumi-lang-yaml=""defaultCollection"" pulumi-lang-java=""defaultCollection"">"default_collection".
- conditions List<Property Map>
- The conditions under which the control is active. Structure is documented below.
- control
Id String - The unique id of the control.
- display
Name String - The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.
- engine
Id String - The engine to add the control to.
- filter
Action Property Map - Removes entries from returned results. Structure is documented below.
- location String
- The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
- name String
- The unique full resource name of the control. Values are of the format
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/controls/{control_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- promote
Action Property Map - Promotes a specified link for a query. Structure is documented below.
- redirect
Action Property Map - Redirects to a specified URI. Structure is documented below.
- solution
Type String - The solution type that the control belongs to.
Possible values are:
SOLUTION_TYPE_RECOMMENDATION,SOLUTION_TYPE_SEARCH,SOLUTION_TYPE_CHAT,SOLUTION_TYPE_GENERATIVE_CHAT. - synonyms
Action Property Map - Associates queries with each other. Structure is documented below.
- use
Cases List<String> - The use cases that the control is used for.
Each value may be one of:
SEARCH_USE_CASE_SEARCH,SEARCH_USE_CASE_BROWSE.
Supporting Types
ControlBoostAction, ControlBoostActionArgs
- Data
Store string - The data store to boost.
- Filter string
- The filter to apply to the search results.
- Fixed
Boost double - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- Interpolation
Boost ControlSpec Boost Action Interpolation Boost Spec - The interpolation boost specification to apply to the search results. Structure is documented below.
- Data
Store string - The data store to boost.
- Filter string
- The filter to apply to the search results.
- Fixed
Boost float64 - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- Interpolation
Boost ControlSpec Boost Action Interpolation Boost Spec - The interpolation boost specification to apply to the search results. Structure is documented below.
- data
Store String - The data store to boost.
- filter String
- The filter to apply to the search results.
- fixed
Boost Double - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- interpolation
Boost ControlSpec Boost Action Interpolation Boost Spec - The interpolation boost specification to apply to the search results. Structure is documented below.
- data
Store string - The data store to boost.
- filter string
- The filter to apply to the search results.
- fixed
Boost number - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- interpolation
Boost ControlSpec Boost Action Interpolation Boost Spec - The interpolation boost specification to apply to the search results. Structure is documented below.
- data_
store str - The data store to boost.
- filter str
- The filter to apply to the search results.
- fixed_
boost float - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- interpolation_
boost_ Controlspec Boost Action Interpolation Boost Spec - The interpolation boost specification to apply to the search results. Structure is documented below.
- data
Store String - The data store to boost.
- filter String
- The filter to apply to the search results.
- fixed
Boost Number - The fixed boost value to apply to the search results. Positive values will increase the relevance of the results, while negative values will decrease the relevance. The value must be between -100 and 100.
- interpolation
Boost Property MapSpec - The interpolation boost specification to apply to the search results. Structure is documented below.
ControlBoostActionInterpolationBoostSpec, ControlBoostActionInterpolationBoostSpecArgs
- Attribute
Type string - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - Control
Point ControlBoost Action Interpolation Boost Spec Control Point - The control points used to define the curve. Structure is documented below.
- Field
Name string - The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
- Attribute
Type string - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - Control
Point ControlBoost Action Interpolation Boost Spec Control Point - The control points used to define the curve. Structure is documented below.
- Field
Name string - The name of the field whose value will be used to determine the boost amount.
- Interpolation
Type string - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
- attribute
Type String - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - control
Point ControlBoost Action Interpolation Boost Spec Control Point - The control points used to define the curve. Structure is documented below.
- field
Name String - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
- attribute
Type string - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - control
Point ControlBoost Action Interpolation Boost Spec Control Point - The control points used to define the curve. Structure is documented below.
- field
Name string - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type string - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
- attribute_
type str - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - control_
point ControlBoost Action Interpolation Boost Spec Control Point - The control points used to define the curve. Structure is documented below.
- field_
name str - The name of the field whose value will be used to determine the boost amount.
- interpolation_
type str - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
- attribute
Type String - The attribute type to be used to determine the boost amount.
Possible values are:
NUMERICAL,FRESHNESS. - control
Point Property Map - The control points used to define the curve. Structure is documented below.
- field
Name String - The name of the field whose value will be used to determine the boost amount.
- interpolation
Type String - The interpolation type to be applied to connect the control points.
Possible values are:
LINEAR.
ControlBoostActionInterpolationBoostSpecControlPoint, ControlBoostActionInterpolationBoostSpecControlPointArgs
- Attribute
Value string - The attribute value of the control point.
- Boost
Amount double - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
- Attribute
Value string - The attribute value of the control point.
- Boost
Amount float64 - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
- attribute
Value String - The attribute value of the control point.
- boost
Amount Double - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
- attribute
Value string - The attribute value of the control point.
- boost
Amount number - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
- attribute_
value str - The attribute value of the control point.
- boost_
amount float - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
- attribute
Value String - The attribute value of the control point.
- boost
Amount Number - The value between -1 to 1 by which to boost the score if the attributeValue evaluates to the value specified above.
ControlCondition, ControlConditionArgs
- Active
Time List<ControlRanges Condition Active Time Range> - The time range when the condition is active. Structure is documented below.
- Query
Regex string - The regular expression that the query must match for this condition to be met.
- Query
Terms List<ControlCondition Query Term> - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
- Active
Time []ControlRanges Condition Active Time Range - The time range when the condition is active. Structure is documented below.
- Query
Regex string - The regular expression that the query must match for this condition to be met.
- Query
Terms []ControlCondition Query Term - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
- active
Time List<ControlRanges Condition Active Time Range> - The time range when the condition is active. Structure is documented below.
- query
Regex String - The regular expression that the query must match for this condition to be met.
- query
Terms List<ControlCondition Query Term> - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
- active
Time ControlRanges Condition Active Time Range[] - The time range when the condition is active. Structure is documented below.
- query
Regex string - The regular expression that the query must match for this condition to be met.
- query
Terms ControlCondition Query Term[] - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
- active_
time_ Sequence[Controlranges Condition Active Time Range] - The time range when the condition is active. Structure is documented below.
- query_
regex str - The regular expression that the query must match for this condition to be met.
- query_
terms Sequence[ControlCondition Query Term] - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
- active
Time List<Property Map>Ranges - The time range when the condition is active. Structure is documented below.
- query
Regex String - The regular expression that the query must match for this condition to be met.
- query
Terms List<Property Map> - The query terms that must be present in the search request for this condition to be met. Structure is documented below.
ControlConditionActiveTimeRange, ControlConditionActiveTimeRangeArgs
- end_
time str - The end time of the active time range.
- start_
time str - The start time of the active time range.
ControlConditionQueryTerm, ControlConditionQueryTermArgs
- full_
match bool - If true, the query term must be an exact match. Otherwise, the query term can be a partial match.
- value str
- The value of the query term.
ControlFilterAction, ControlFilterActionArgs
- data_
store str - The data store to filter.
- filter str
- The filter to apply to the search results.
ControlPromoteAction, ControlPromoteActionArgs
- Data
Store string - The data store to promote.
- Search
Link ControlPromotion Promote Action Search Link Promotion - The search link promotion to apply to the search results. Structure is documented below.
- Data
Store string - The data store to promote.
- Search
Link ControlPromotion Promote Action Search Link Promotion - The search link promotion to apply to the search results. Structure is documented below.
- data
Store String - The data store to promote.
- search
Link ControlPromotion Promote Action Search Link Promotion - The search link promotion to apply to the search results. Structure is documented below.
- data
Store string - The data store to promote.
- search
Link ControlPromotion Promote Action Search Link Promotion - The search link promotion to apply to the search results. Structure is documented below.
- data_
store str - The data store to promote.
- search_
link_ Controlpromotion Promote Action Search Link Promotion - The search link promotion to apply to the search results. Structure is documented below.
- data
Store String - The data store to promote.
- search
Link Property MapPromotion - The search link promotion to apply to the search results. Structure is documented below.
ControlPromoteActionSearchLinkPromotion, ControlPromoteActionSearchLinkPromotionArgs
ControlRedirectAction, ControlRedirectActionArgs
- Redirect
Uri string - The URI to redirect to.
- Redirect
Uri string - The URI to redirect to.
- redirect
Uri String - The URI to redirect to.
- redirect
Uri string - The URI to redirect to.
- redirect_
uri str - The URI to redirect to.
- redirect
Uri String - The URI to redirect to.
ControlSynonymsAction, ControlSynonymsActionArgs
- Synonyms List<string>
- The synonyms to apply to the search results.
- Synonyms []string
- The synonyms to apply to the search results.
- synonyms List<String>
- The synonyms to apply to the search results.
- synonyms string[]
- The synonyms to apply to the search results.
- synonyms Sequence[str]
- The synonyms to apply to the search results.
- synonyms List<String>
- The synonyms to apply to the search results.
Import
Control can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/controls/{{control_id}}{{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{control_id}}{{location}}/{{collection_id}}/{{engine_id}}/{{control_id}}
When using the pulumi import command, Control can be imported using one of the formats above. For example:
$ pulumi import gcp:discoveryengine/control:Control default projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}/controls/{{control_id}}
$ pulumi import gcp:discoveryengine/control:Control default {{project}}/{{location}}/{{collection_id}}/{{engine_id}}/{{control_id}}
$ pulumi import gcp:discoveryengine/control:Control default {{location}}/{{collection_id}}/{{engine_id}}/{{control_id}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
