Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. retail
  5. retail/v2
  6. Control

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.retail/v2.Control

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.

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,
            catalog_id: Optional[str] = None,
            control_id: Optional[str] = None,
            display_name: Optional[str] = None,
            solution_types: Optional[Sequence[ControlSolutionTypesItem]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            rule: Optional[GoogleCloudRetailV2RuleArgs] = None,
            search_solution_use_case: Optional[Sequence[ControlSearchSolutionUseCaseItem]] = 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: google-native:retail/v2:Control
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ControlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ControlArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ControlArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 GoogleNative.Retail.V2.Control("controlResource", new()
{
    CatalogId = "string",
    ControlId = "string",
    DisplayName = "string",
    SolutionTypes = new[]
    {
        GoogleNative.Retail.V2.ControlSolutionTypesItem.SolutionTypeUnspecified,
    },
    Location = "string",
    Name = "string",
    Project = "string",
    Rule = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleArgs
    {
        Condition = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionArgs
        {
            ActiveTimeRange = new[]
            {
                new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionTimeRangeArgs
                {
                    EndTime = "string",
                    StartTime = "string",
                },
            },
            PageCategories = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionQueryTermArgs
                {
                    FullMatch = false,
                    Value = "string",
                },
            },
        },
        BoostAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleBoostActionArgs
        {
            Boost = 0,
            ProductsFilter = "string",
        },
        DoNotAssociateAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleDoNotAssociateActionArgs
        {
            DoNotAssociateTerms = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                "string",
            },
            Terms = new[]
            {
                "string",
            },
        },
        FilterAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleFilterActionArgs
        {
            Filter = "string",
        },
        ForceReturnFacetAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetActionArgs
        {
            FacetPositionAdjustments = new[]
            {
                new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentArgs
                {
                    AttributeName = "string",
                    Position = 0,
                },
            },
        },
        IgnoreAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleIgnoreActionArgs
        {
            IgnoreTerms = new[]
            {
                "string",
            },
        },
        OnewaySynonymsAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleOnewaySynonymsActionArgs
        {
            OnewayTerms = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                "string",
            },
            Synonyms = new[]
            {
                "string",
            },
        },
        RedirectAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRedirectActionArgs
        {
            RedirectUri = "string",
        },
        RemoveFacetAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRemoveFacetActionArgs
        {
            AttributeNames = new[]
            {
                "string",
            },
        },
        ReplacementAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleReplacementActionArgs
        {
            QueryTerms = new[]
            {
                "string",
            },
            ReplacementTerm = "string",
            Term = "string",
        },
        TwowaySynonymsAction = new GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleTwowaySynonymsActionArgs
        {
            Synonyms = new[]
            {
                "string",
            },
        },
    },
    SearchSolutionUseCase = new[]
    {
        GoogleNative.Retail.V2.ControlSearchSolutionUseCaseItem.SearchSolutionUseCaseUnspecified,
    },
});
Copy
example, err := retail.NewControl(ctx, "controlResource", &retail.ControlArgs{
	CatalogId:   pulumi.String("string"),
	ControlId:   pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	SolutionTypes: retail.ControlSolutionTypesItemArray{
		retail.ControlSolutionTypesItemSolutionTypeUnspecified,
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	Rule: &retail.GoogleCloudRetailV2RuleArgs{
		Condition: &retail.GoogleCloudRetailV2ConditionArgs{
			ActiveTimeRange: retail.GoogleCloudRetailV2ConditionTimeRangeArray{
				&retail.GoogleCloudRetailV2ConditionTimeRangeArgs{
					EndTime:   pulumi.String("string"),
					StartTime: pulumi.String("string"),
				},
			},
			PageCategories: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: retail.GoogleCloudRetailV2ConditionQueryTermArray{
				&retail.GoogleCloudRetailV2ConditionQueryTermArgs{
					FullMatch: pulumi.Bool(false),
					Value:     pulumi.String("string"),
				},
			},
		},
		BoostAction: &retail.GoogleCloudRetailV2RuleBoostActionArgs{
			Boost:          pulumi.Float64(0),
			ProductsFilter: pulumi.String("string"),
		},
		DoNotAssociateAction: &retail.GoogleCloudRetailV2RuleDoNotAssociateActionArgs{
			DoNotAssociateTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			Terms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		FilterAction: &retail.GoogleCloudRetailV2RuleFilterActionArgs{
			Filter: pulumi.String("string"),
		},
		ForceReturnFacetAction: &retail.GoogleCloudRetailV2RuleForceReturnFacetActionArgs{
			FacetPositionAdjustments: retail.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentArray{
				&retail.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentArgs{
					AttributeName: pulumi.String("string"),
					Position:      pulumi.Int(0),
				},
			},
		},
		IgnoreAction: &retail.GoogleCloudRetailV2RuleIgnoreActionArgs{
			IgnoreTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		OnewaySynonymsAction: &retail.GoogleCloudRetailV2RuleOnewaySynonymsActionArgs{
			OnewayTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			Synonyms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		RedirectAction: &retail.GoogleCloudRetailV2RuleRedirectActionArgs{
			RedirectUri: pulumi.String("string"),
		},
		RemoveFacetAction: &retail.GoogleCloudRetailV2RuleRemoveFacetActionArgs{
			AttributeNames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ReplacementAction: &retail.GoogleCloudRetailV2RuleReplacementActionArgs{
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			ReplacementTerm: pulumi.String("string"),
			Term:            pulumi.String("string"),
		},
		TwowaySynonymsAction: &retail.GoogleCloudRetailV2RuleTwowaySynonymsActionArgs{
			Synonyms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	SearchSolutionUseCase: retail.ControlSearchSolutionUseCaseItemArray{
		retail.ControlSearchSolutionUseCaseItemSearchSolutionUseCaseUnspecified,
	},
})
Copy
var controlResource = new Control("controlResource", ControlArgs.builder()
    .catalogId("string")
    .controlId("string")
    .displayName("string")
    .solutionTypes("SOLUTION_TYPE_UNSPECIFIED")
    .location("string")
    .name("string")
    .project("string")
    .rule(GoogleCloudRetailV2RuleArgs.builder()
        .condition(GoogleCloudRetailV2ConditionArgs.builder()
            .activeTimeRange(GoogleCloudRetailV2ConditionTimeRangeArgs.builder()
                .endTime("string")
                .startTime("string")
                .build())
            .pageCategories("string")
            .queryTerms(GoogleCloudRetailV2ConditionQueryTermArgs.builder()
                .fullMatch(false)
                .value("string")
                .build())
            .build())
        .boostAction(GoogleCloudRetailV2RuleBoostActionArgs.builder()
            .boost(0)
            .productsFilter("string")
            .build())
        .doNotAssociateAction(GoogleCloudRetailV2RuleDoNotAssociateActionArgs.builder()
            .doNotAssociateTerms("string")
            .queryTerms("string")
            .terms("string")
            .build())
        .filterAction(GoogleCloudRetailV2RuleFilterActionArgs.builder()
            .filter("string")
            .build())
        .forceReturnFacetAction(GoogleCloudRetailV2RuleForceReturnFacetActionArgs.builder()
            .facetPositionAdjustments(GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentArgs.builder()
                .attributeName("string")
                .position(0)
                .build())
            .build())
        .ignoreAction(GoogleCloudRetailV2RuleIgnoreActionArgs.builder()
            .ignoreTerms("string")
            .build())
        .onewaySynonymsAction(GoogleCloudRetailV2RuleOnewaySynonymsActionArgs.builder()
            .onewayTerms("string")
            .queryTerms("string")
            .synonyms("string")
            .build())
        .redirectAction(GoogleCloudRetailV2RuleRedirectActionArgs.builder()
            .redirectUri("string")
            .build())
        .removeFacetAction(GoogleCloudRetailV2RuleRemoveFacetActionArgs.builder()
            .attributeNames("string")
            .build())
        .replacementAction(GoogleCloudRetailV2RuleReplacementActionArgs.builder()
            .queryTerms("string")
            .replacementTerm("string")
            .term("string")
            .build())
        .twowaySynonymsAction(GoogleCloudRetailV2RuleTwowaySynonymsActionArgs.builder()
            .synonyms("string")
            .build())
        .build())
    .searchSolutionUseCase("SEARCH_SOLUTION_USE_CASE_UNSPECIFIED")
    .build());
Copy
control_resource = google_native.retail.v2.Control("controlResource",
    catalog_id="string",
    control_id="string",
    display_name="string",
    solution_types=[google_native.retail.v2.ControlSolutionTypesItem.SOLUTION_TYPE_UNSPECIFIED],
    location="string",
    name="string",
    project="string",
    rule={
        "condition": {
            "active_time_range": [{
                "end_time": "string",
                "start_time": "string",
            }],
            "page_categories": ["string"],
            "query_terms": [{
                "full_match": False,
                "value": "string",
            }],
        },
        "boost_action": {
            "boost": 0,
            "products_filter": "string",
        },
        "do_not_associate_action": {
            "do_not_associate_terms": ["string"],
            "query_terms": ["string"],
            "terms": ["string"],
        },
        "filter_action": {
            "filter": "string",
        },
        "force_return_facet_action": {
            "facet_position_adjustments": [{
                "attribute_name": "string",
                "position": 0,
            }],
        },
        "ignore_action": {
            "ignore_terms": ["string"],
        },
        "oneway_synonyms_action": {
            "oneway_terms": ["string"],
            "query_terms": ["string"],
            "synonyms": ["string"],
        },
        "redirect_action": {
            "redirect_uri": "string",
        },
        "remove_facet_action": {
            "attribute_names": ["string"],
        },
        "replacement_action": {
            "query_terms": ["string"],
            "replacement_term": "string",
            "term": "string",
        },
        "twoway_synonyms_action": {
            "synonyms": ["string"],
        },
    },
    search_solution_use_case=[google_native.retail.v2.ControlSearchSolutionUseCaseItem.SEARCH_SOLUTION_USE_CASE_UNSPECIFIED])
Copy
const controlResource = new google_native.retail.v2.Control("controlResource", {
    catalogId: "string",
    controlId: "string",
    displayName: "string",
    solutionTypes: [google_native.retail.v2.ControlSolutionTypesItem.SolutionTypeUnspecified],
    location: "string",
    name: "string",
    project: "string",
    rule: {
        condition: {
            activeTimeRange: [{
                endTime: "string",
                startTime: "string",
            }],
            pageCategories: ["string"],
            queryTerms: [{
                fullMatch: false,
                value: "string",
            }],
        },
        boostAction: {
            boost: 0,
            productsFilter: "string",
        },
        doNotAssociateAction: {
            doNotAssociateTerms: ["string"],
            queryTerms: ["string"],
            terms: ["string"],
        },
        filterAction: {
            filter: "string",
        },
        forceReturnFacetAction: {
            facetPositionAdjustments: [{
                attributeName: "string",
                position: 0,
            }],
        },
        ignoreAction: {
            ignoreTerms: ["string"],
        },
        onewaySynonymsAction: {
            onewayTerms: ["string"],
            queryTerms: ["string"],
            synonyms: ["string"],
        },
        redirectAction: {
            redirectUri: "string",
        },
        removeFacetAction: {
            attributeNames: ["string"],
        },
        replacementAction: {
            queryTerms: ["string"],
            replacementTerm: "string",
            term: "string",
        },
        twowaySynonymsAction: {
            synonyms: ["string"],
        },
    },
    searchSolutionUseCase: [google_native.retail.v2.ControlSearchSolutionUseCaseItem.SearchSolutionUseCaseUnspecified],
});
Copy
type: google-native:retail/v2:Control
properties:
    catalogId: string
    controlId: string
    displayName: string
    location: string
    name: string
    project: string
    rule:
        boostAction:
            boost: 0
            productsFilter: string
        condition:
            activeTimeRange:
                - endTime: string
                  startTime: string
            pageCategories:
                - string
            queryTerms:
                - fullMatch: false
                  value: string
        doNotAssociateAction:
            doNotAssociateTerms:
                - string
            queryTerms:
                - string
            terms:
                - string
        filterAction:
            filter: string
        forceReturnFacetAction:
            facetPositionAdjustments:
                - attributeName: string
                  position: 0
        ignoreAction:
            ignoreTerms:
                - string
        onewaySynonymsAction:
            onewayTerms:
                - string
            queryTerms:
                - string
            synonyms:
                - string
        redirectAction:
            redirectUri: string
        removeFacetAction:
            attributeNames:
                - string
        replacementAction:
            queryTerms:
                - string
            replacementTerm: string
            term: string
        twowaySynonymsAction:
            synonyms:
                - string
    searchSolutionUseCase:
        - SEARCH_SOLUTION_USE_CASE_UNSPECIFIED
    solutionTypes:
        - SOLUTION_TYPE_UNSPECIFIED
Copy

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:

CatalogId
This property is required.
Changes to this property will trigger replacement.
string
ControlId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
DisplayName This property is required. string
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
SolutionTypes This property is required. List<Pulumi.GoogleNative.Retail.V2.ControlSolutionTypesItem>
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
Location Changes to this property will trigger replacement. string
Name string
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
Project Changes to this property will trigger replacement. string
Rule Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2Rule
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
SearchSolutionUseCase List<Pulumi.GoogleNative.Retail.V2.ControlSearchSolutionUseCaseItem>
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
CatalogId
This property is required.
Changes to this property will trigger replacement.
string
ControlId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
DisplayName This property is required. string
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
SolutionTypes This property is required. []ControlSolutionTypesItem
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
Location Changes to this property will trigger replacement. string
Name string
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
Project Changes to this property will trigger replacement. string
Rule GoogleCloudRetailV2RuleArgs
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
SearchSolutionUseCase []ControlSearchSolutionUseCaseItem
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
catalogId
This property is required.
Changes to this property will trigger replacement.
String
controlId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
displayName This property is required. String
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
solutionTypes This property is required. List<ControlSolutionTypesItem>
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
location Changes to this property will trigger replacement. String
name String
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
project Changes to this property will trigger replacement. String
rule GoogleCloudRetailV2Rule
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
searchSolutionUseCase List<ControlSearchSolutionUseCaseItem>
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
catalogId
This property is required.
Changes to this property will trigger replacement.
string
controlId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
displayName This property is required. string
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
solutionTypes This property is required. ControlSolutionTypesItem[]
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
location Changes to this property will trigger replacement. string
name string
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
project Changes to this property will trigger replacement. string
rule GoogleCloudRetailV2Rule
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
searchSolutionUseCase ControlSearchSolutionUseCaseItem[]
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
catalog_id
This property is required.
Changes to this property will trigger replacement.
str
control_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
display_name This property is required. str
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
solution_types This property is required. Sequence[ControlSolutionTypesItem]
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
location Changes to this property will trigger replacement. str
name str
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
project Changes to this property will trigger replacement. str
rule GoogleCloudRetailV2RuleArgs
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
search_solution_use_case Sequence[ControlSearchSolutionUseCaseItem]
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
catalogId
This property is required.
Changes to this property will trigger replacement.
String
controlId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.
displayName This property is required. String
The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
solutionTypes This property is required. List<"SOLUTION_TYPE_UNSPECIFIED" | "SOLUTION_TYPE_RECOMMENDATION" | "SOLUTION_TYPE_SEARCH">
Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
location Changes to this property will trigger replacement. String
name String
Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
project Changes to this property will trigger replacement. String
rule Property Map
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
searchSolutionUseCase List<"SEARCH_SOLUTION_USE_CASE_UNSPECIFIED" | "SEARCH_SOLUTION_USE_CASE_SEARCH" | "SEARCH_SOLUTION_USE_CASE_BROWSE">
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

Outputs

All input properties are implicitly available as output properties. Additionally, the Control resource produces the following output properties:

AssociatedServingConfigIds List<string>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
Id string
The provider-assigned unique ID for this managed resource.
AssociatedServingConfigIds []string
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
Id string
The provider-assigned unique ID for this managed resource.
associatedServingConfigIds List<String>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
id String
The provider-assigned unique ID for this managed resource.
associatedServingConfigIds string[]
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
id string
The provider-assigned unique ID for this managed resource.
associated_serving_config_ids Sequence[str]
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
id str
The provider-assigned unique ID for this managed resource.
associatedServingConfigIds List<String>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ControlSearchSolutionUseCaseItem
, ControlSearchSolutionUseCaseItemArgs

SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.
ControlSearchSolutionUseCaseItemSearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
ControlSearchSolutionUseCaseItemSearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
ControlSearchSolutionUseCaseItemSearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.
SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.
SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
SEARCH_SOLUTION_USE_CASE_SEARCH
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
SEARCH_SOLUTION_USE_CASE_BROWSE
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.
"SEARCH_SOLUTION_USE_CASE_UNSPECIFIED"
SEARCH_SOLUTION_USE_CASE_UNSPECIFIEDThe value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.
"SEARCH_SOLUTION_USE_CASE_SEARCH"
SEARCH_SOLUTION_USE_CASE_SEARCHSearch use case. Expects the traffic has a non-empty query.
"SEARCH_SOLUTION_USE_CASE_BROWSE"
SEARCH_SOLUTION_USE_CASE_BROWSEBrowse use case. Expects the traffic has an empty query.

ControlSolutionTypesItem
, ControlSolutionTypesItemArgs

SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIEDDefault value.
SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
SolutionTypeSearch
SOLUTION_TYPE_SEARCHUsed for Retail Search.
ControlSolutionTypesItemSolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIEDDefault value.
ControlSolutionTypesItemSolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
ControlSolutionTypesItemSolutionTypeSearch
SOLUTION_TYPE_SEARCHUsed for Retail Search.
SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIEDDefault value.
SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
SolutionTypeSearch
SOLUTION_TYPE_SEARCHUsed for Retail Search.
SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIEDDefault value.
SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
SolutionTypeSearch
SOLUTION_TYPE_SEARCHUsed for Retail Search.
SOLUTION_TYPE_UNSPECIFIED
SOLUTION_TYPE_UNSPECIFIEDDefault value.
SOLUTION_TYPE_RECOMMENDATION
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
SOLUTION_TYPE_SEARCH
SOLUTION_TYPE_SEARCHUsed for Retail Search.
"SOLUTION_TYPE_UNSPECIFIED"
SOLUTION_TYPE_UNSPECIFIEDDefault value.
"SOLUTION_TYPE_RECOMMENDATION"
SOLUTION_TYPE_RECOMMENDATIONUsed for Recommendations AI.
"SOLUTION_TYPE_SEARCH"
SOLUTION_TYPE_SEARCHUsed for Retail Search.

GoogleCloudRetailV2Condition
, GoogleCloudRetailV2ConditionArgs

ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionTimeRange>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
PageCategories List<string>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
QueryTerms List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionQueryTerm>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
ActiveTimeRange []GoogleCloudRetailV2ConditionTimeRange
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
PageCategories []string
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
QueryTerms []GoogleCloudRetailV2ConditionQueryTerm
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange List<GoogleCloudRetailV2ConditionTimeRange>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories List<String>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms List<GoogleCloudRetailV2ConditionQueryTerm>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange GoogleCloudRetailV2ConditionTimeRange[]
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories string[]
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms GoogleCloudRetailV2ConditionQueryTerm[]
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
active_time_range Sequence[GoogleCloudRetailV2ConditionTimeRange]
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
page_categories Sequence[str]
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
query_terms Sequence[GoogleCloudRetailV2ConditionQueryTerm]
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange List<Property Map>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories List<String>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms List<Property Map>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

GoogleCloudRetailV2ConditionQueryTerm
, GoogleCloudRetailV2ConditionQueryTermArgs

FullMatch bool
Whether this is supposed to be a full or partial match.
Value string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
FullMatch bool
Whether this is supposed to be a full or partial match.
Value string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch Boolean
Whether this is supposed to be a full or partial match.
value String
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch boolean
Whether this is supposed to be a full or partial match.
value string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
full_match bool
Whether this is supposed to be a full or partial match.
value str
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch Boolean
Whether this is supposed to be a full or partial match.
value String
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

GoogleCloudRetailV2ConditionQueryTermResponse
, GoogleCloudRetailV2ConditionQueryTermResponseArgs

FullMatch This property is required. bool
Whether this is supposed to be a full or partial match.
Value This property is required. string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
FullMatch This property is required. bool
Whether this is supposed to be a full or partial match.
Value This property is required. string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch This property is required. Boolean
Whether this is supposed to be a full or partial match.
value This property is required. String
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch This property is required. boolean
Whether this is supposed to be a full or partial match.
value This property is required. string
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
full_match This property is required. bool
Whether this is supposed to be a full or partial match.
value This property is required. str
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
fullMatch This property is required. Boolean
Whether this is supposed to be a full or partial match.
value This property is required. String
The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

GoogleCloudRetailV2ConditionResponse
, GoogleCloudRetailV2ConditionResponseArgs

ActiveTimeRange This property is required. List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionTimeRangeResponse>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
PageCategories This property is required. List<string>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
QueryTerms This property is required. List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionQueryTermResponse>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
ActiveTimeRange This property is required. []GoogleCloudRetailV2ConditionTimeRangeResponse
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
PageCategories This property is required. []string
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
QueryTerms This property is required. []GoogleCloudRetailV2ConditionQueryTermResponse
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange This property is required. List<GoogleCloudRetailV2ConditionTimeRangeResponse>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories This property is required. List<String>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms This property is required. List<GoogleCloudRetailV2ConditionQueryTermResponse>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange This property is required. GoogleCloudRetailV2ConditionTimeRangeResponse[]
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories This property is required. string[]
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms This property is required. GoogleCloudRetailV2ConditionQueryTermResponse[]
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
active_time_range This property is required. Sequence[GoogleCloudRetailV2ConditionTimeRangeResponse]
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
page_categories This property is required. Sequence[str]
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
query_terms This property is required. Sequence[GoogleCloudRetailV2ConditionQueryTermResponse]
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
activeTimeRange This property is required. List<Property Map>
Range of time(s) specifying when Condition is active. Condition true if any time range matches.
pageCategories This property is required. List<String>
Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
queryTerms This property is required. List<Property Map>
A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

GoogleCloudRetailV2ConditionTimeRange
, GoogleCloudRetailV2ConditionTimeRangeArgs

EndTime string
End of time range. Range is inclusive.
StartTime string
Start of time range. Range is inclusive.
EndTime string
End of time range. Range is inclusive.
StartTime string
Start of time range. Range is inclusive.
endTime String
End of time range. Range is inclusive.
startTime String
Start of time range. Range is inclusive.
endTime string
End of time range. Range is inclusive.
startTime string
Start of time range. Range is inclusive.
end_time str
End of time range. Range is inclusive.
start_time str
Start of time range. Range is inclusive.
endTime String
End of time range. Range is inclusive.
startTime String
Start of time range. Range is inclusive.

GoogleCloudRetailV2ConditionTimeRangeResponse
, GoogleCloudRetailV2ConditionTimeRangeResponseArgs

EndTime This property is required. string
End of time range. Range is inclusive.
StartTime This property is required. string
Start of time range. Range is inclusive.
EndTime This property is required. string
End of time range. Range is inclusive.
StartTime This property is required. string
Start of time range. Range is inclusive.
endTime This property is required. String
End of time range. Range is inclusive.
startTime This property is required. String
Start of time range. Range is inclusive.
endTime This property is required. string
End of time range. Range is inclusive.
startTime This property is required. string
Start of time range. Range is inclusive.
end_time This property is required. str
End of time range. Range is inclusive.
start_time This property is required. str
Start of time range. Range is inclusive.
endTime This property is required. String
End of time range. Range is inclusive.
startTime This property is required. String
Start of time range. Range is inclusive.

GoogleCloudRetailV2Rule
, GoogleCloudRetailV2RuleArgs

Condition This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2Condition
The condition that triggers the rule. If the condition is empty, the rule will always apply.
BoostAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleBoostAction
A boost action.
DoNotAssociateAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleDoNotAssociateAction
Prevents term from being associated with other terms.
FilterAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleFilterAction
Filters results.
ForceReturnFacetAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetAction
Force returns an attribute as a facet in the request.
IgnoreAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleIgnoreAction
Ignores specific terms from query during search.
OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleOnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
RedirectAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRedirectAction
Redirects a shopper to a specific page.
RemoveFacetAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRemoveFacetAction
Remove an attribute as a facet in the request (if present).
ReplacementAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleReplacementAction
Replaces specific terms in the query.
TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
Condition This property is required. GoogleCloudRetailV2Condition
The condition that triggers the rule. If the condition is empty, the rule will always apply.
BoostAction GoogleCloudRetailV2RuleBoostAction
A boost action.
DoNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction
Prevents term from being associated with other terms.
FilterAction GoogleCloudRetailV2RuleFilterAction
Filters results.
ForceReturnFacetAction GoogleCloudRetailV2RuleForceReturnFacetAction
Force returns an attribute as a facet in the request.
IgnoreAction GoogleCloudRetailV2RuleIgnoreAction
Ignores specific terms from query during search.
OnewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
RedirectAction GoogleCloudRetailV2RuleRedirectAction
Redirects a shopper to a specific page.
RemoveFacetAction GoogleCloudRetailV2RuleRemoveFacetAction
Remove an attribute as a facet in the request (if present).
ReplacementAction GoogleCloudRetailV2RuleReplacementAction
Replaces specific terms in the query.
TwowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
condition This property is required. GoogleCloudRetailV2Condition
The condition that triggers the rule. If the condition is empty, the rule will always apply.
boostAction GoogleCloudRetailV2RuleBoostAction
A boost action.
doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction
Prevents term from being associated with other terms.
filterAction GoogleCloudRetailV2RuleFilterAction
Filters results.
forceReturnFacetAction GoogleCloudRetailV2RuleForceReturnFacetAction
Force returns an attribute as a facet in the request.
ignoreAction GoogleCloudRetailV2RuleIgnoreAction
Ignores specific terms from query during search.
onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction GoogleCloudRetailV2RuleRedirectAction
Redirects a shopper to a specific page.
removeFacetAction GoogleCloudRetailV2RuleRemoveFacetAction
Remove an attribute as a facet in the request (if present).
replacementAction GoogleCloudRetailV2RuleReplacementAction
Replaces specific terms in the query.
twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
condition This property is required. GoogleCloudRetailV2Condition
The condition that triggers the rule. If the condition is empty, the rule will always apply.
boostAction GoogleCloudRetailV2RuleBoostAction
A boost action.
doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction
Prevents term from being associated with other terms.
filterAction GoogleCloudRetailV2RuleFilterAction
Filters results.
forceReturnFacetAction GoogleCloudRetailV2RuleForceReturnFacetAction
Force returns an attribute as a facet in the request.
ignoreAction GoogleCloudRetailV2RuleIgnoreAction
Ignores specific terms from query during search.
onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction GoogleCloudRetailV2RuleRedirectAction
Redirects a shopper to a specific page.
removeFacetAction GoogleCloudRetailV2RuleRemoveFacetAction
Remove an attribute as a facet in the request (if present).
replacementAction GoogleCloudRetailV2RuleReplacementAction
Replaces specific terms in the query.
twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
condition This property is required. GoogleCloudRetailV2Condition
The condition that triggers the rule. If the condition is empty, the rule will always apply.
boost_action GoogleCloudRetailV2RuleBoostAction
A boost action.
do_not_associate_action GoogleCloudRetailV2RuleDoNotAssociateAction
Prevents term from being associated with other terms.
filter_action GoogleCloudRetailV2RuleFilterAction
Filters results.
force_return_facet_action GoogleCloudRetailV2RuleForceReturnFacetAction
Force returns an attribute as a facet in the request.
ignore_action GoogleCloudRetailV2RuleIgnoreAction
Ignores specific terms from query during search.
oneway_synonyms_action GoogleCloudRetailV2RuleOnewaySynonymsAction
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirect_action GoogleCloudRetailV2RuleRedirectAction
Redirects a shopper to a specific page.
remove_facet_action GoogleCloudRetailV2RuleRemoveFacetAction
Remove an attribute as a facet in the request (if present).
replacement_action GoogleCloudRetailV2RuleReplacementAction
Replaces specific terms in the query.
twoway_synonyms_action GoogleCloudRetailV2RuleTwowaySynonymsAction
Treats a set of terms as synonyms of one another.
condition This property is required. Property Map
The condition that triggers the rule. If the condition is empty, the rule will always apply.
boostAction Property Map
A boost action.
doNotAssociateAction Property Map
Prevents term from being associated with other terms.
filterAction Property Map
Filters results.
forceReturnFacetAction Property Map
Force returns an attribute as a facet in the request.
ignoreAction Property Map
Ignores specific terms from query during search.
onewaySynonymsAction Property Map
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction Property Map
Redirects a shopper to a specific page.
removeFacetAction Property Map
Remove an attribute as a facet in the request (if present).
replacementAction Property Map
Replaces specific terms in the query.
twowaySynonymsAction Property Map
Treats a set of terms as synonyms of one another.

GoogleCloudRetailV2RuleBoostAction
, GoogleCloudRetailV2RuleBoostActionArgs

Boost double
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
ProductsFilter string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
Boost float64
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
ProductsFilter string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost Double
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter String
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost number
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost float
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
products_filter str
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost Number
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter String
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleBoostActionResponse
, GoogleCloudRetailV2RuleBoostActionResponseArgs

Boost This property is required. double
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
ProductsFilter This property is required. string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
Boost This property is required. float64
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
ProductsFilter This property is required. string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost This property is required. Double
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter This property is required. String
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost This property is required. number
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter This property is required. string
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost This property is required. float
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
products_filter This property is required. str
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
boost This property is required. Number
Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
productsFilter This property is required. String
The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleDoNotAssociateAction
, GoogleCloudRetailV2RuleDoNotAssociateActionArgs

DoNotAssociateTerms List<string>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
QueryTerms List<string>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
Terms List<string>
Will be [deprecated = true] post migration;
DoNotAssociateTerms []string
Cannot contain duplicates or the query term. Can specify up to 100 terms.
QueryTerms []string
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
Terms []string
Will be [deprecated = true] post migration;
doNotAssociateTerms List<String>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms List<String>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms List<String>
Will be [deprecated = true] post migration;
doNotAssociateTerms string[]
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms string[]
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms string[]
Will be [deprecated = true] post migration;
do_not_associate_terms Sequence[str]
Cannot contain duplicates or the query term. Can specify up to 100 terms.
query_terms Sequence[str]
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms Sequence[str]
Will be [deprecated = true] post migration;
doNotAssociateTerms List<String>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms List<String>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms List<String>
Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleDoNotAssociateActionResponse
, GoogleCloudRetailV2RuleDoNotAssociateActionResponseArgs

DoNotAssociateTerms This property is required. List<string>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
QueryTerms This property is required. List<string>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
Terms This property is required. List<string>
Will be [deprecated = true] post migration;
DoNotAssociateTerms This property is required. []string
Cannot contain duplicates or the query term. Can specify up to 100 terms.
QueryTerms This property is required. []string
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
Terms This property is required. []string
Will be [deprecated = true] post migration;
doNotAssociateTerms This property is required. List<String>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms This property is required. List<String>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms This property is required. List<String>
Will be [deprecated = true] post migration;
doNotAssociateTerms This property is required. string[]
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms This property is required. string[]
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms This property is required. string[]
Will be [deprecated = true] post migration;
do_not_associate_terms This property is required. Sequence[str]
Cannot contain duplicates or the query term. Can specify up to 100 terms.
query_terms This property is required. Sequence[str]
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms This property is required. Sequence[str]
Will be [deprecated = true] post migration;
doNotAssociateTerms This property is required. List<String>
Cannot contain duplicates or the query term. Can specify up to 100 terms.
queryTerms This property is required. List<String>
Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
terms This property is required. List<String>
Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleFilterAction
, GoogleCloudRetailV2RuleFilterActionArgs

Filter string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
Filter string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter String
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter str
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter String
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleFilterActionResponse
, GoogleCloudRetailV2RuleFilterActionResponseArgs

Filter This property is required. string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
Filter This property is required. string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter This property is required. String
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter This property is required. string
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter This property is required. str
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
filter This property is required. String
A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleForceReturnFacetAction
, GoogleCloudRetailV2RuleForceReturnFacetActionArgs

FacetPositionAdjustments List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
FacetPositionAdjustments []GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments List<GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment[]
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facet_position_adjustments Sequence[GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment]
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments List<Property Map>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.

GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment
, GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentArgs

AttributeName string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
Position int
This is the position in the request as explained above. It should be strictly positive be at most 100.
AttributeName string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
Position int
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName String
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position Integer
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position number
This is the position in the request as explained above. It should be strictly positive be at most 100.
attribute_name str
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position int
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName String
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position Number
This is the position in the request as explained above. It should be strictly positive be at most 100.

GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse
, GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponseArgs

AttributeName This property is required. string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
Position This property is required. int
This is the position in the request as explained above. It should be strictly positive be at most 100.
AttributeName This property is required. string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
Position This property is required. int
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName This property is required. String
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position This property is required. Integer
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName This property is required. string
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position This property is required. number
This is the position in the request as explained above. It should be strictly positive be at most 100.
attribute_name This property is required. str
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position This property is required. int
This is the position in the request as explained above. It should be strictly positive be at most 100.
attributeName This property is required. String
The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
position This property is required. Number
This is the position in the request as explained above. It should be strictly positive be at most 100.

GoogleCloudRetailV2RuleForceReturnFacetActionResponse
, GoogleCloudRetailV2RuleForceReturnFacetActionResponseArgs

FacetPositionAdjustments This property is required. List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
FacetPositionAdjustments This property is required. []GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments This property is required. List<GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments This property is required. GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse[]
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facet_position_adjustments This property is required. Sequence[GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse]
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
facetPositionAdjustments This property is required. List<Property Map>
Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.

GoogleCloudRetailV2RuleIgnoreAction
, GoogleCloudRetailV2RuleIgnoreActionArgs

IgnoreTerms List<string>
Terms to ignore in the search query.
IgnoreTerms []string
Terms to ignore in the search query.
ignoreTerms List<String>
Terms to ignore in the search query.
ignoreTerms string[]
Terms to ignore in the search query.
ignore_terms Sequence[str]
Terms to ignore in the search query.
ignoreTerms List<String>
Terms to ignore in the search query.

GoogleCloudRetailV2RuleIgnoreActionResponse
, GoogleCloudRetailV2RuleIgnoreActionResponseArgs

IgnoreTerms This property is required. List<string>
Terms to ignore in the search query.
IgnoreTerms This property is required. []string
Terms to ignore in the search query.
ignoreTerms This property is required. List<String>
Terms to ignore in the search query.
ignoreTerms This property is required. string[]
Terms to ignore in the search query.
ignore_terms This property is required. Sequence[str]
Terms to ignore in the search query.
ignoreTerms This property is required. List<String>
Terms to ignore in the search query.

GoogleCloudRetailV2RuleOnewaySynonymsAction
, GoogleCloudRetailV2RuleOnewaySynonymsActionArgs

OnewayTerms List<string>
Will be [deprecated = true] post migration;
QueryTerms List<string>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
Synonyms List<string>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
OnewayTerms []string
Will be [deprecated = true] post migration;
QueryTerms []string
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
Synonyms []string
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms List<String>
Will be [deprecated = true] post migration;
queryTerms List<String>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms List<String>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms string[]
Will be [deprecated = true] post migration;
queryTerms string[]
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms string[]
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
oneway_terms Sequence[str]
Will be [deprecated = true] post migration;
query_terms Sequence[str]
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms Sequence[str]
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms List<String>
Will be [deprecated = true] post migration;
queryTerms List<String>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms List<String>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
, GoogleCloudRetailV2RuleOnewaySynonymsActionResponseArgs

OnewayTerms This property is required. List<string>
Will be [deprecated = true] post migration;
QueryTerms This property is required. List<string>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
Synonyms This property is required. List<string>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
OnewayTerms This property is required. []string
Will be [deprecated = true] post migration;
QueryTerms This property is required. []string
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
Synonyms This property is required. []string
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms This property is required. List<String>
Will be [deprecated = true] post migration;
queryTerms This property is required. List<String>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms This property is required. List<String>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms This property is required. string[]
Will be [deprecated = true] post migration;
queryTerms This property is required. string[]
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms This property is required. string[]
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
oneway_terms This property is required. Sequence[str]
Will be [deprecated = true] post migration;
query_terms This property is required. Sequence[str]
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms This property is required. Sequence[str]
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
onewayTerms This property is required. List<String>
Will be [deprecated = true] post migration;
queryTerms This property is required. List<String>
Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
synonyms This property is required. List<String>
Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

GoogleCloudRetailV2RuleRedirectAction
, GoogleCloudRetailV2RuleRedirectActionArgs

RedirectUri string
URL must have length equal or less than 2000 characters.
RedirectUri string
URL must have length equal or less than 2000 characters.
redirectUri String
URL must have length equal or less than 2000 characters.
redirectUri string
URL must have length equal or less than 2000 characters.
redirect_uri str
URL must have length equal or less than 2000 characters.
redirectUri String
URL must have length equal or less than 2000 characters.

GoogleCloudRetailV2RuleRedirectActionResponse
, GoogleCloudRetailV2RuleRedirectActionResponseArgs

RedirectUri This property is required. string
URL must have length equal or less than 2000 characters.
RedirectUri This property is required. string
URL must have length equal or less than 2000 characters.
redirectUri This property is required. String
URL must have length equal or less than 2000 characters.
redirectUri This property is required. string
URL must have length equal or less than 2000 characters.
redirect_uri This property is required. str
URL must have length equal or less than 2000 characters.
redirectUri This property is required. String
URL must have length equal or less than 2000 characters.

GoogleCloudRetailV2RuleRemoveFacetAction
, GoogleCloudRetailV2RuleRemoveFacetActionArgs

AttributeNames List<string>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
AttributeNames []string
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames List<String>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames string[]
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attribute_names Sequence[str]
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames List<String>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

GoogleCloudRetailV2RuleRemoveFacetActionResponse
, GoogleCloudRetailV2RuleRemoveFacetActionResponseArgs

AttributeNames This property is required. List<string>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
AttributeNames This property is required. []string
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames This property is required. List<String>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames This property is required. string[]
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attribute_names This property is required. Sequence[str]
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
attributeNames This property is required. List<String>
The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.

GoogleCloudRetailV2RuleReplacementAction
, GoogleCloudRetailV2RuleReplacementActionArgs

QueryTerms List<string>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
ReplacementTerm string
Term that will be used for replacement.
Term string
Will be [deprecated = true] post migration;
QueryTerms []string
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
ReplacementTerm string
Term that will be used for replacement.
Term string
Will be [deprecated = true] post migration;
queryTerms List<String>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm String
Term that will be used for replacement.
term String
Will be [deprecated = true] post migration;
queryTerms string[]
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm string
Term that will be used for replacement.
term string
Will be [deprecated = true] post migration;
query_terms Sequence[str]
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacement_term str
Term that will be used for replacement.
term str
Will be [deprecated = true] post migration;
queryTerms List<String>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm String
Term that will be used for replacement.
term String
Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleReplacementActionResponse
, GoogleCloudRetailV2RuleReplacementActionResponseArgs

QueryTerms This property is required. List<string>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
ReplacementTerm This property is required. string
Term that will be used for replacement.
Term This property is required. string
Will be [deprecated = true] post migration;
QueryTerms This property is required. []string
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
ReplacementTerm This property is required. string
Term that will be used for replacement.
Term This property is required. string
Will be [deprecated = true] post migration;
queryTerms This property is required. List<String>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm This property is required. String
Term that will be used for replacement.
term This property is required. String
Will be [deprecated = true] post migration;
queryTerms This property is required. string[]
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm This property is required. string
Term that will be used for replacement.
term This property is required. string
Will be [deprecated = true] post migration;
query_terms This property is required. Sequence[str]
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacement_term This property is required. str
Term that will be used for replacement.
term This property is required. str
Will be [deprecated = true] post migration;
queryTerms This property is required. List<String>
Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
replacementTerm This property is required. String
Term that will be used for replacement.
term This property is required. String
Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleResponse
, GoogleCloudRetailV2RuleResponseArgs

BoostAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleBoostActionResponse
A boost action.
Condition This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionResponse
The condition that triggers the rule. If the condition is empty, the rule will always apply.
DoNotAssociateAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleDoNotAssociateActionResponse
Prevents term from being associated with other terms.
FilterAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleFilterActionResponse
Filters results.
ForceReturnFacetAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleForceReturnFacetActionResponse
Force returns an attribute as a facet in the request.
IgnoreAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleIgnoreActionResponse
Ignores specific terms from query during search.
OnewaySynonymsAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
RedirectAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRedirectActionResponse
Redirects a shopper to a specific page.
RemoveFacetAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRemoveFacetActionResponse
Remove an attribute as a facet in the request (if present).
ReplacementAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleReplacementActionResponse
Replaces specific terms in the query.
TwowaySynonymsAction This property is required. Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
Treats a set of terms as synonyms of one another.
BoostAction This property is required. GoogleCloudRetailV2RuleBoostActionResponse
A boost action.
Condition This property is required. GoogleCloudRetailV2ConditionResponse
The condition that triggers the rule. If the condition is empty, the rule will always apply.
DoNotAssociateAction This property is required. GoogleCloudRetailV2RuleDoNotAssociateActionResponse
Prevents term from being associated with other terms.
FilterAction This property is required. GoogleCloudRetailV2RuleFilterActionResponse
Filters results.
ForceReturnFacetAction This property is required. GoogleCloudRetailV2RuleForceReturnFacetActionResponse
Force returns an attribute as a facet in the request.
IgnoreAction This property is required. GoogleCloudRetailV2RuleIgnoreActionResponse
Ignores specific terms from query during search.
OnewaySynonymsAction This property is required. GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
RedirectAction This property is required. GoogleCloudRetailV2RuleRedirectActionResponse
Redirects a shopper to a specific page.
RemoveFacetAction This property is required. GoogleCloudRetailV2RuleRemoveFacetActionResponse
Remove an attribute as a facet in the request (if present).
ReplacementAction This property is required. GoogleCloudRetailV2RuleReplacementActionResponse
Replaces specific terms in the query.
TwowaySynonymsAction This property is required. GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
Treats a set of terms as synonyms of one another.
boostAction This property is required. GoogleCloudRetailV2RuleBoostActionResponse
A boost action.
condition This property is required. GoogleCloudRetailV2ConditionResponse
The condition that triggers the rule. If the condition is empty, the rule will always apply.
doNotAssociateAction This property is required. GoogleCloudRetailV2RuleDoNotAssociateActionResponse
Prevents term from being associated with other terms.
filterAction This property is required. GoogleCloudRetailV2RuleFilterActionResponse
Filters results.
forceReturnFacetAction This property is required. GoogleCloudRetailV2RuleForceReturnFacetActionResponse
Force returns an attribute as a facet in the request.
ignoreAction This property is required. GoogleCloudRetailV2RuleIgnoreActionResponse
Ignores specific terms from query during search.
onewaySynonymsAction This property is required. GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction This property is required. GoogleCloudRetailV2RuleRedirectActionResponse
Redirects a shopper to a specific page.
removeFacetAction This property is required. GoogleCloudRetailV2RuleRemoveFacetActionResponse
Remove an attribute as a facet in the request (if present).
replacementAction This property is required. GoogleCloudRetailV2RuleReplacementActionResponse
Replaces specific terms in the query.
twowaySynonymsAction This property is required. GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
Treats a set of terms as synonyms of one another.
boostAction This property is required. GoogleCloudRetailV2RuleBoostActionResponse
A boost action.
condition This property is required. GoogleCloudRetailV2ConditionResponse
The condition that triggers the rule. If the condition is empty, the rule will always apply.
doNotAssociateAction This property is required. GoogleCloudRetailV2RuleDoNotAssociateActionResponse
Prevents term from being associated with other terms.
filterAction This property is required. GoogleCloudRetailV2RuleFilterActionResponse
Filters results.
forceReturnFacetAction This property is required. GoogleCloudRetailV2RuleForceReturnFacetActionResponse
Force returns an attribute as a facet in the request.
ignoreAction This property is required. GoogleCloudRetailV2RuleIgnoreActionResponse
Ignores specific terms from query during search.
onewaySynonymsAction This property is required. GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction This property is required. GoogleCloudRetailV2RuleRedirectActionResponse
Redirects a shopper to a specific page.
removeFacetAction This property is required. GoogleCloudRetailV2RuleRemoveFacetActionResponse
Remove an attribute as a facet in the request (if present).
replacementAction This property is required. GoogleCloudRetailV2RuleReplacementActionResponse
Replaces specific terms in the query.
twowaySynonymsAction This property is required. GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
Treats a set of terms as synonyms of one another.
boost_action This property is required. GoogleCloudRetailV2RuleBoostActionResponse
A boost action.
condition This property is required. GoogleCloudRetailV2ConditionResponse
The condition that triggers the rule. If the condition is empty, the rule will always apply.
do_not_associate_action This property is required. GoogleCloudRetailV2RuleDoNotAssociateActionResponse
Prevents term from being associated with other terms.
filter_action This property is required. GoogleCloudRetailV2RuleFilterActionResponse
Filters results.
force_return_facet_action This property is required. GoogleCloudRetailV2RuleForceReturnFacetActionResponse
Force returns an attribute as a facet in the request.
ignore_action This property is required. GoogleCloudRetailV2RuleIgnoreActionResponse
Ignores specific terms from query during search.
oneway_synonyms_action This property is required. GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirect_action This property is required. GoogleCloudRetailV2RuleRedirectActionResponse
Redirects a shopper to a specific page.
remove_facet_action This property is required. GoogleCloudRetailV2RuleRemoveFacetActionResponse
Remove an attribute as a facet in the request (if present).
replacement_action This property is required. GoogleCloudRetailV2RuleReplacementActionResponse
Replaces specific terms in the query.
twoway_synonyms_action This property is required. GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
Treats a set of terms as synonyms of one another.
boostAction This property is required. Property Map
A boost action.
condition This property is required. Property Map
The condition that triggers the rule. If the condition is empty, the rule will always apply.
doNotAssociateAction This property is required. Property Map
Prevents term from being associated with other terms.
filterAction This property is required. Property Map
Filters results.
forceReturnFacetAction This property is required. Property Map
Force returns an attribute as a facet in the request.
ignoreAction This property is required. Property Map
Ignores specific terms from query during search.
onewaySynonymsAction This property is required. Property Map
Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
redirectAction This property is required. Property Map
Redirects a shopper to a specific page.
removeFacetAction This property is required. Property Map
Remove an attribute as a facet in the request (if present).
replacementAction This property is required. Property Map
Replaces specific terms in the query.
twowaySynonymsAction This property is required. Property Map
Treats a set of terms as synonyms of one another.

GoogleCloudRetailV2RuleTwowaySynonymsAction
, GoogleCloudRetailV2RuleTwowaySynonymsActionArgs

Synonyms List<string>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
Synonyms []string
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms List<String>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms string[]
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms Sequence[str]
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms List<String>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
, GoogleCloudRetailV2RuleTwowaySynonymsActionResponseArgs

Synonyms This property is required. List<string>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
Synonyms This property is required. []string
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms This property is required. List<String>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms This property is required. string[]
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms This property is required. Sequence[str]
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
synonyms This property is required. List<String>
Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native