Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. retail
  5. retail/v2alpha
  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/v2alpha.Control

Explore with Pulumi AI

google-native logo

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,
            facet_spec: Optional[GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            rule: Optional[GoogleCloudRetailV2alphaRuleArgs] = 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/v2alpha:Control
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ControlArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ControlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ControlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ControlArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var google_nativeControlResource = new GoogleNative.Retail.V2Alpha.Control("google-nativeControlResource", new()
{
    CatalogId = "string",
    ControlId = "string",
    DisplayName = "string",
    SolutionTypes = new[]
    {
        GoogleNative.Retail.V2Alpha.ControlSolutionTypesItem.SolutionTypeUnspecified,
    },
    FacetSpec = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs
    {
        FacetKey = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs
        {
            Key = "string",
            CaseInsensitive = false,
            Contains = new[]
            {
                "string",
            },
            Intervals = new[]
            {
                new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaIntervalArgs
                {
                    ExclusiveMaximum = 0,
                    ExclusiveMinimum = 0,
                    Maximum = 0,
                    Minimum = 0,
                },
            },
            OrderBy = "string",
            Prefixes = new[]
            {
                "string",
            },
            Query = "string",
            RestrictedValues = new[]
            {
                "string",
            },
            ReturnMinMax = false,
        },
        EnableDynamicPosition = false,
        ExcludedFilterKeys = new[]
        {
            "string",
        },
        Limit = 0,
    },
    Location = "string",
    Name = "string",
    Project = "string",
    Rule = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleArgs
    {
        Condition = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionArgs
        {
            ActiveTimeRange = new[]
            {
                new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionTimeRangeArgs
                {
                    EndTime = "string",
                    StartTime = "string",
                },
            },
            PageCategories = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionQueryTermArgs
                {
                    FullMatch = false,
                    Value = "string",
                },
            },
        },
        BoostAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleBoostActionArgs
        {
            Boost = 0,
            ProductsFilter = "string",
        },
        DoNotAssociateAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs
        {
            DoNotAssociateTerms = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                "string",
            },
            Terms = new[]
            {
                "string",
            },
        },
        FilterAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleFilterActionArgs
        {
            Filter = "string",
        },
        ForceReturnFacetAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetActionArgs
        {
            FacetPositionAdjustments = new[]
            {
                new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArgs
                {
                    AttributeName = "string",
                    Position = 0,
                },
            },
        },
        IgnoreAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleIgnoreActionArgs
        {
            IgnoreTerms = new[]
            {
                "string",
            },
        },
        OnewaySynonymsAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs
        {
            OnewayTerms = new[]
            {
                "string",
            },
            QueryTerms = new[]
            {
                "string",
            },
            Synonyms = new[]
            {
                "string",
            },
        },
        RedirectAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRedirectActionArgs
        {
            RedirectUri = "string",
        },
        RemoveFacetAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRemoveFacetActionArgs
        {
            AttributeNames = new[]
            {
                "string",
            },
        },
        ReplacementAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleReplacementActionArgs
        {
            QueryTerms = new[]
            {
                "string",
            },
            ReplacementTerm = "string",
            Term = "string",
        },
        TwowaySynonymsAction = new GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs
        {
            Synonyms = new[]
            {
                "string",
            },
        },
    },
    SearchSolutionUseCase = new[]
    {
        GoogleNative.Retail.V2Alpha.ControlSearchSolutionUseCaseItem.SearchSolutionUseCaseUnspecified,
    },
});

    example, err := retailv2alpha.NewControl(ctx, "google-nativeControlResource", &retailv2alpha.ControlArgs{
	CatalogId:   pulumi.String("string"),
	ControlId:   pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	SolutionTypes: retail.ControlSolutionTypesItemArray{
		retailv2alpha.ControlSolutionTypesItemSolutionTypeUnspecified,
	},
	FacetSpec: &retail.GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs{
		FacetKey: &retail.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs{
			Key:             pulumi.String("string"),
			CaseInsensitive: pulumi.Bool(false),
			Contains: pulumi.StringArray{
				pulumi.String("string"),
			},
			Intervals: retail.GoogleCloudRetailV2alphaIntervalArray{
				&retail.GoogleCloudRetailV2alphaIntervalArgs{
					ExclusiveMaximum: pulumi.Float64(0),
					ExclusiveMinimum: pulumi.Float64(0),
					Maximum:          pulumi.Float64(0),
					Minimum:          pulumi.Float64(0),
				},
			},
			OrderBy: pulumi.String("string"),
			Prefixes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Query: pulumi.String("string"),
			RestrictedValues: pulumi.StringArray{
				pulumi.String("string"),
			},
			ReturnMinMax: pulumi.Bool(false),
		},
		EnableDynamicPosition: pulumi.Bool(false),
		ExcludedFilterKeys: pulumi.StringArray{
			pulumi.String("string"),
		},
		Limit: pulumi.Int(0),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	Rule: &retail.GoogleCloudRetailV2alphaRuleArgs{
		Condition: &retail.GoogleCloudRetailV2alphaConditionArgs{
			ActiveTimeRange: retail.GoogleCloudRetailV2alphaConditionTimeRangeArray{
				&retail.GoogleCloudRetailV2alphaConditionTimeRangeArgs{
					EndTime:   pulumi.String("string"),
					StartTime: pulumi.String("string"),
				},
			},
			PageCategories: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: retail.GoogleCloudRetailV2alphaConditionQueryTermArray{
				&retail.GoogleCloudRetailV2alphaConditionQueryTermArgs{
					FullMatch: pulumi.Bool(false),
					Value:     pulumi.String("string"),
				},
			},
		},
		BoostAction: &retail.GoogleCloudRetailV2alphaRuleBoostActionArgs{
			Boost:          pulumi.Float64(0),
			ProductsFilter: pulumi.String("string"),
		},
		DoNotAssociateAction: &retail.GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs{
			DoNotAssociateTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			Terms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		FilterAction: &retail.GoogleCloudRetailV2alphaRuleFilterActionArgs{
			Filter: pulumi.String("string"),
		},
		ForceReturnFacetAction: &retail.GoogleCloudRetailV2alphaRuleForceReturnFacetActionArgs{
			FacetPositionAdjustments: retail.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArray{
				&retail.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArgs{
					AttributeName: pulumi.String("string"),
					Position:      pulumi.Int(0),
				},
			},
		},
		IgnoreAction: &retail.GoogleCloudRetailV2alphaRuleIgnoreActionArgs{
			IgnoreTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		OnewaySynonymsAction: &retail.GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs{
			OnewayTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			Synonyms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		RedirectAction: &retail.GoogleCloudRetailV2alphaRuleRedirectActionArgs{
			RedirectUri: pulumi.String("string"),
		},
		RemoveFacetAction: &retail.GoogleCloudRetailV2alphaRuleRemoveFacetActionArgs{
			AttributeNames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		ReplacementAction: &retail.GoogleCloudRetailV2alphaRuleReplacementActionArgs{
			QueryTerms: pulumi.StringArray{
				pulumi.String("string"),
			},
			ReplacementTerm: pulumi.String("string"),
			Term:            pulumi.String("string"),
		},
		TwowaySynonymsAction: &retail.GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs{
			Synonyms: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	SearchSolutionUseCase: retail.ControlSearchSolutionUseCaseItemArray{
		retailv2alpha.ControlSearchSolutionUseCaseItemSearchSolutionUseCaseUnspecified,
	},
})

    var google_nativeControlResource = new Control("google-nativeControlResource", ControlArgs.builder()
    .catalogId("string")
    .controlId("string")
    .displayName("string")
    .solutionTypes("SOLUTION_TYPE_UNSPECIFIED")
    .facetSpec(GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs.builder()
        .facetKey(GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs.builder()
            .key("string")
            .caseInsensitive(false)
            .contains("string")
            .intervals(GoogleCloudRetailV2alphaIntervalArgs.builder()
                .exclusiveMaximum(0)
                .exclusiveMinimum(0)
                .maximum(0)
                .minimum(0)
                .build())
            .orderBy("string")
            .prefixes("string")
            .query("string")
            .restrictedValues("string")
            .returnMinMax(false)
            .build())
        .enableDynamicPosition(false)
        .excludedFilterKeys("string")
        .limit(0)
        .build())
    .location("string")
    .name("string")
    .project("string")
    .rule(GoogleCloudRetailV2alphaRuleArgs.builder()
        .condition(GoogleCloudRetailV2alphaConditionArgs.builder()
            .activeTimeRange(GoogleCloudRetailV2alphaConditionTimeRangeArgs.builder()
                .endTime("string")
                .startTime("string")
                .build())
            .pageCategories("string")
            .queryTerms(GoogleCloudRetailV2alphaConditionQueryTermArgs.builder()
                .fullMatch(false)
                .value("string")
                .build())
            .build())
        .boostAction(GoogleCloudRetailV2alphaRuleBoostActionArgs.builder()
            .boost(0)
            .productsFilter("string")
            .build())
        .doNotAssociateAction(GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs.builder()
            .doNotAssociateTerms("string")
            .queryTerms("string")
            .terms("string")
            .build())
        .filterAction(GoogleCloudRetailV2alphaRuleFilterActionArgs.builder()
            .filter("string")
            .build())
        .forceReturnFacetAction(GoogleCloudRetailV2alphaRuleForceReturnFacetActionArgs.builder()
            .facetPositionAdjustments(GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArgs.builder()
                .attributeName("string")
                .position(0)
                .build())
            .build())
        .ignoreAction(GoogleCloudRetailV2alphaRuleIgnoreActionArgs.builder()
            .ignoreTerms("string")
            .build())
        .onewaySynonymsAction(GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs.builder()
            .onewayTerms("string")
            .queryTerms("string")
            .synonyms("string")
            .build())
        .redirectAction(GoogleCloudRetailV2alphaRuleRedirectActionArgs.builder()
            .redirectUri("string")
            .build())
        .removeFacetAction(GoogleCloudRetailV2alphaRuleRemoveFacetActionArgs.builder()
            .attributeNames("string")
            .build())
        .replacementAction(GoogleCloudRetailV2alphaRuleReplacementActionArgs.builder()
            .queryTerms("string")
            .replacementTerm("string")
            .term("string")
            .build())
        .twowaySynonymsAction(GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs.builder()
            .synonyms("string")
            .build())
        .build())
    .searchSolutionUseCase("SEARCH_SOLUTION_USE_CASE_UNSPECIFIED")
    .build());

    google_native_control_resource = google_native.retail.v2alpha.Control("google-nativeControlResource",
    catalog_id="string",
    control_id="string",
    display_name="string",
    solution_types=[google_native.retail.v2alpha.ControlSolutionTypesItem.SOLUTION_TYPE_UNSPECIFIED],
    facet_spec=google_native.retail.v2alpha.GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs(
        facet_key=google_native.retail.v2alpha.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs(
            key="string",
            case_insensitive=False,
            contains=["string"],
            intervals=[google_native.retail.v2alpha.GoogleCloudRetailV2alphaIntervalArgs(
                exclusive_maximum=0,
                exclusive_minimum=0,
                maximum=0,
                minimum=0,
            )],
            order_by="string",
            prefixes=["string"],
            query="string",
            restricted_values=["string"],
            return_min_max=False,
        ),
        enable_dynamic_position=False,
        excluded_filter_keys=["string"],
        limit=0,
    ),
    location="string",
    name="string",
    project="string",
    rule=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleArgs(
        condition=google_native.retail.v2alpha.GoogleCloudRetailV2alphaConditionArgs(
            active_time_range=[google_native.retail.v2alpha.GoogleCloudRetailV2alphaConditionTimeRangeArgs(
                end_time="string",
                start_time="string",
            )],
            page_categories=["string"],
            query_terms=[google_native.retail.v2alpha.GoogleCloudRetailV2alphaConditionQueryTermArgs(
                full_match=False,
                value="string",
            )],
        ),
        boost_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleBoostActionArgs(
            boost=0,
            products_filter="string",
        ),
        do_not_associate_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs(
            do_not_associate_terms=["string"],
            query_terms=["string"],
            terms=["string"],
        ),
        filter_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleFilterActionArgs(
            filter="string",
        ),
        force_return_facet_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleForceReturnFacetActionArgs(
            facet_position_adjustments=[google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArgs(
                attribute_name="string",
                position=0,
            )],
        ),
        ignore_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleIgnoreActionArgs(
            ignore_terms=["string"],
        ),
        oneway_synonyms_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs(
            oneway_terms=["string"],
            query_terms=["string"],
            synonyms=["string"],
        ),
        redirect_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleRedirectActionArgs(
            redirect_uri="string",
        ),
        remove_facet_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleRemoveFacetActionArgs(
            attribute_names=["string"],
        ),
        replacement_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleReplacementActionArgs(
            query_terms=["string"],
            replacement_term="string",
            term="string",
        ),
        twoway_synonyms_action=google_native.retail.v2alpha.GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs(
            synonyms=["string"],
        ),
    ),
    search_solution_use_case=[google_native.retail.v2alpha.ControlSearchSolutionUseCaseItem.SEARCH_SOLUTION_USE_CASE_UNSPECIFIED])

    const google_nativeControlResource = new google_native.retail.v2alpha.Control("google-nativeControlResource", {
    catalogId: "string",
    controlId: "string",
    displayName: "string",
    solutionTypes: [google_native.retail.v2alpha.ControlSolutionTypesItem.SolutionTypeUnspecified],
    facetSpec: {
        facetKey: {
            key: "string",
            caseInsensitive: false,
            contains: ["string"],
            intervals: [{
                exclusiveMaximum: 0,
                exclusiveMinimum: 0,
                maximum: 0,
                minimum: 0,
            }],
            orderBy: "string",
            prefixes: ["string"],
            query: "string",
            restrictedValues: ["string"],
            returnMinMax: false,
        },
        enableDynamicPosition: false,
        excludedFilterKeys: ["string"],
        limit: 0,
    },
    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.v2alpha.ControlSearchSolutionUseCaseItem.SearchSolutionUseCaseUnspecified],
});

    type: google-native:retail/v2alpha:Control
properties:
    catalogId: string
    controlId: string
    displayName: string
    facetSpec:
        enableDynamicPosition: false
        excludedFilterKeys:
            - string
        facetKey:
            caseInsensitive: false
            contains:
                - string
            intervals:
                - exclusiveMaximum: 0
                  exclusiveMinimum: 0
                  maximum: 0
                  minimum: 0
            key: string
            orderBy: string
            prefixes:
                - string
            query: string
            restrictedValues:
                - string
            returnMinMax: false
        limit: 0
    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

    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

    The Control resource accepts the following input properties:

    CatalogId string
    ControlId 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 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 List<Pulumi.GoogleNative.Retail.V2Alpha.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.
    FacetSpec Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpec
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    Location string
    Name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    Project string
    Rule Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRule
    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.V2Alpha.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 string
    ControlId 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 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 []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.
    FacetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    Location string
    Name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    Project string
    Rule GoogleCloudRetailV2alphaRuleArgs
    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 String
    controlId 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 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 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.
    facetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpec
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    location String
    name String
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    project String
    rule GoogleCloudRetailV2alphaRule
    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 string
    controlId 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 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 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.
    facetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpec
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    location string
    name string
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    project string
    rule GoogleCloudRetailV2alphaRule
    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 str
    control_id 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 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 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.
    facet_spec GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    location str
    name str
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    project str
    rule GoogleCloudRetailV2alphaRuleArgs
    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 String
    controlId 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 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 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.
    facetSpec Property Map
    A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
    location String
    name String
    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
    project 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.

    GoogleCloudRetailV2alphaCondition, GoogleCloudRetailV2alphaConditionArgs

    ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionTimeRange>
    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.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionQueryTerm>
    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 []GoogleCloudRetailV2alphaConditionTimeRange
    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 []GoogleCloudRetailV2alphaConditionQueryTerm
    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<GoogleCloudRetailV2alphaConditionTimeRange>
    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<GoogleCloudRetailV2alphaConditionQueryTerm>
    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 GoogleCloudRetailV2alphaConditionTimeRange[]
    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 GoogleCloudRetailV2alphaConditionQueryTerm[]
    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[GoogleCloudRetailV2alphaConditionTimeRange]
    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[GoogleCloudRetailV2alphaConditionQueryTerm]
    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).

    GoogleCloudRetailV2alphaConditionQueryTerm, GoogleCloudRetailV2alphaConditionQueryTermArgs

    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.

    GoogleCloudRetailV2alphaConditionQueryTermResponse, GoogleCloudRetailV2alphaConditionQueryTermResponseArgs

    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.

    GoogleCloudRetailV2alphaConditionResponse, GoogleCloudRetailV2alphaConditionResponseArgs

    ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionTimeRangeResponse>
    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.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionQueryTermResponse>
    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 []GoogleCloudRetailV2alphaConditionTimeRangeResponse
    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 []GoogleCloudRetailV2alphaConditionQueryTermResponse
    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<GoogleCloudRetailV2alphaConditionTimeRangeResponse>
    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<GoogleCloudRetailV2alphaConditionQueryTermResponse>
    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 GoogleCloudRetailV2alphaConditionTimeRangeResponse[]
    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 GoogleCloudRetailV2alphaConditionQueryTermResponse[]
    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[GoogleCloudRetailV2alphaConditionTimeRangeResponse]
    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[GoogleCloudRetailV2alphaConditionQueryTermResponse]
    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).

    GoogleCloudRetailV2alphaConditionTimeRange, GoogleCloudRetailV2alphaConditionTimeRangeArgs

    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.

    GoogleCloudRetailV2alphaConditionTimeRangeResponse, GoogleCloudRetailV2alphaConditionTimeRangeResponseArgs

    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.

    GoogleCloudRetailV2alphaInterval, GoogleCloudRetailV2alphaIntervalArgs

    ExclusiveMaximum double
    Exclusive upper bound.
    ExclusiveMinimum double
    Exclusive lower bound.
    Maximum double
    Inclusive upper bound.
    Minimum double
    Inclusive lower bound.
    ExclusiveMaximum float64
    Exclusive upper bound.
    ExclusiveMinimum float64
    Exclusive lower bound.
    Maximum float64
    Inclusive upper bound.
    Minimum float64
    Inclusive lower bound.
    exclusiveMaximum Double
    Exclusive upper bound.
    exclusiveMinimum Double
    Exclusive lower bound.
    maximum Double
    Inclusive upper bound.
    minimum Double
    Inclusive lower bound.
    exclusiveMaximum number
    Exclusive upper bound.
    exclusiveMinimum number
    Exclusive lower bound.
    maximum number
    Inclusive upper bound.
    minimum number
    Inclusive lower bound.
    exclusive_maximum float
    Exclusive upper bound.
    exclusive_minimum float
    Exclusive lower bound.
    maximum float
    Inclusive upper bound.
    minimum float
    Inclusive lower bound.
    exclusiveMaximum Number
    Exclusive upper bound.
    exclusiveMinimum Number
    Exclusive lower bound.
    maximum Number
    Inclusive upper bound.
    minimum Number
    Inclusive lower bound.

    GoogleCloudRetailV2alphaIntervalResponse, GoogleCloudRetailV2alphaIntervalResponseArgs

    ExclusiveMaximum double
    Exclusive upper bound.
    ExclusiveMinimum double
    Exclusive lower bound.
    Maximum double
    Inclusive upper bound.
    Minimum double
    Inclusive lower bound.
    ExclusiveMaximum float64
    Exclusive upper bound.
    ExclusiveMinimum float64
    Exclusive lower bound.
    Maximum float64
    Inclusive upper bound.
    Minimum float64
    Inclusive lower bound.
    exclusiveMaximum Double
    Exclusive upper bound.
    exclusiveMinimum Double
    Exclusive lower bound.
    maximum Double
    Inclusive upper bound.
    minimum Double
    Inclusive lower bound.
    exclusiveMaximum number
    Exclusive upper bound.
    exclusiveMinimum number
    Exclusive lower bound.
    maximum number
    Inclusive upper bound.
    minimum number
    Inclusive lower bound.
    exclusive_maximum float
    Exclusive upper bound.
    exclusive_minimum float
    Exclusive lower bound.
    maximum float
    Inclusive upper bound.
    minimum float
    Inclusive lower bound.
    exclusiveMaximum Number
    Exclusive upper bound.
    exclusiveMinimum Number
    Exclusive lower bound.
    maximum Number
    Inclusive upper bound.
    minimum Number
    Inclusive lower bound.

    GoogleCloudRetailV2alphaRule, GoogleCloudRetailV2alphaRuleArgs

    Condition Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaCondition
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    BoostAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleBoostAction
    A boost action.
    DoNotAssociateAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleDoNotAssociateAction
    Prevents term from being associated with other terms.
    FilterAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleFilterAction
    Filters results.
    ForceReturnFacetAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute as a facet in the request.
    IgnoreAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleIgnoreAction
    Ignores specific terms from query during search.
    OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    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.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page.
    RemoveFacetAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Remove an attribute as a facet in the request (if present).
    ReplacementAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces specific terms in the query.
    TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Treats a set of terms as synonyms of one another.
    Condition GoogleCloudRetailV2alphaCondition
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    BoostAction GoogleCloudRetailV2alphaRuleBoostAction
    A boost action.
    DoNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateAction
    Prevents term from being associated with other terms.
    FilterAction GoogleCloudRetailV2alphaRuleFilterAction
    Filters results.
    ForceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute as a facet in the request.
    IgnoreAction GoogleCloudRetailV2alphaRuleIgnoreAction
    Ignores specific terms from query during search.
    OnewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    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 GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page.
    RemoveFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Remove an attribute as a facet in the request (if present).
    ReplacementAction GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces specific terms in the query.
    TwowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Treats a set of terms as synonyms of one another.
    condition GoogleCloudRetailV2alphaCondition
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    boostAction GoogleCloudRetailV2alphaRuleBoostAction
    A boost action.
    doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateAction
    Prevents term from being associated with other terms.
    filterAction GoogleCloudRetailV2alphaRuleFilterAction
    Filters results.
    forceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute as a facet in the request.
    ignoreAction GoogleCloudRetailV2alphaRuleIgnoreAction
    Ignores specific terms from query during search.
    onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    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 GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page.
    removeFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Remove an attribute as a facet in the request (if present).
    replacementAction GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces specific terms in the query.
    twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Treats a set of terms as synonyms of one another.
    condition GoogleCloudRetailV2alphaCondition
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    boostAction GoogleCloudRetailV2alphaRuleBoostAction
    A boost action.
    doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateAction
    Prevents term from being associated with other terms.
    filterAction GoogleCloudRetailV2alphaRuleFilterAction
    Filters results.
    forceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute as a facet in the request.
    ignoreAction GoogleCloudRetailV2alphaRuleIgnoreAction
    Ignores specific terms from query during search.
    onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    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 GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page.
    removeFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Remove an attribute as a facet in the request (if present).
    replacementAction GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces specific terms in the query.
    twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Treats a set of terms as synonyms of one another.
    condition GoogleCloudRetailV2alphaCondition
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    boost_action GoogleCloudRetailV2alphaRuleBoostAction
    A boost action.
    do_not_associate_action GoogleCloudRetailV2alphaRuleDoNotAssociateAction
    Prevents term from being associated with other terms.
    filter_action GoogleCloudRetailV2alphaRuleFilterAction
    Filters results.
    force_return_facet_action GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute as a facet in the request.
    ignore_action GoogleCloudRetailV2alphaRuleIgnoreAction
    Ignores specific terms from query during search.
    oneway_synonyms_action GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    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 GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page.
    remove_facet_action GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Remove an attribute as a facet in the request (if present).
    replacement_action GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces specific terms in the query.
    twoway_synonyms_action GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Treats a set of terms as synonyms of one another.
    condition 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.

    GoogleCloudRetailV2alphaRuleBoostAction, GoogleCloudRetailV2alphaRuleBoostActionArgs

    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")) *

    GoogleCloudRetailV2alphaRuleBoostActionResponse, GoogleCloudRetailV2alphaRuleBoostActionResponseArgs

    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")) *

    GoogleCloudRetailV2alphaRuleDoNotAssociateAction, GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs

    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;

    GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse, GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponseArgs

    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;

    GoogleCloudRetailV2alphaRuleFilterAction, GoogleCloudRetailV2alphaRuleFilterActionArgs

    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")) *

    GoogleCloudRetailV2alphaRuleFilterActionResponse, GoogleCloudRetailV2alphaRuleFilterActionResponseArgs

    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")) *

    GoogleCloudRetailV2alphaRuleForceReturnFacetAction, GoogleCloudRetailV2alphaRuleForceReturnFacetActionArgs

    FacetPositionAdjustments List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment>
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    FacetPositionAdjustments []GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facetPositionAdjustments List<GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment>
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facetPositionAdjustments GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment[]
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facet_position_adjustments Sequence[GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment]
    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.

    GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment, GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentArgs

    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.

    GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse, GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponseArgs

    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.

    GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse, GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponseArgs

    FacetPositionAdjustments List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse>
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    FacetPositionAdjustments []GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facetPositionAdjustments List<GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse>
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facetPositionAdjustments GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse[]
    Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
    facet_position_adjustments Sequence[GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse]
    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.

    GoogleCloudRetailV2alphaRuleIgnoreAction, GoogleCloudRetailV2alphaRuleIgnoreActionArgs

    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.

    GoogleCloudRetailV2alphaRuleIgnoreActionResponse, GoogleCloudRetailV2alphaRuleIgnoreActionResponseArgs

    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.

    GoogleCloudRetailV2alphaRuleOnewaySynonymsAction, GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs

    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.

    GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse, GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponseArgs

    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.

    GoogleCloudRetailV2alphaRuleRedirectAction, GoogleCloudRetailV2alphaRuleRedirectActionArgs

    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.

    GoogleCloudRetailV2alphaRuleRedirectActionResponse, GoogleCloudRetailV2alphaRuleRedirectActionResponseArgs

    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.

    GoogleCloudRetailV2alphaRuleRemoveFacetAction, GoogleCloudRetailV2alphaRuleRemoveFacetActionArgs

    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.

    GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse, GoogleCloudRetailV2alphaRuleRemoveFacetActionResponseArgs

    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.

    GoogleCloudRetailV2alphaRuleReplacementAction, GoogleCloudRetailV2alphaRuleReplacementActionArgs

    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;

    GoogleCloudRetailV2alphaRuleReplacementActionResponse, GoogleCloudRetailV2alphaRuleReplacementActionResponseArgs

    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;

    GoogleCloudRetailV2alphaRuleResponse, GoogleCloudRetailV2alphaRuleResponseArgs

    BoostAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleBoostActionResponse
    A boost action.
    Condition Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionResponse
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    DoNotAssociateAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
    Prevents term from being associated with other terms.
    FilterAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleFilterActionResponse
    Filters results.
    ForceReturnFacetAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute as a facet in the request.
    IgnoreAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Ignores specific terms from query during search.
    OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    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.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page.
    RemoveFacetAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Remove an attribute as a facet in the request (if present).
    ReplacementAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces specific terms in the query.
    TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Treats a set of terms as synonyms of one another.
    BoostAction GoogleCloudRetailV2alphaRuleBoostActionResponse
    A boost action.
    Condition GoogleCloudRetailV2alphaConditionResponse
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    DoNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
    Prevents term from being associated with other terms.
    FilterAction GoogleCloudRetailV2alphaRuleFilterActionResponse
    Filters results.
    ForceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute as a facet in the request.
    IgnoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Ignores specific terms from query during search.
    OnewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    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 GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page.
    RemoveFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Remove an attribute as a facet in the request (if present).
    ReplacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces specific terms in the query.
    TwowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Treats a set of terms as synonyms of one another.
    boostAction GoogleCloudRetailV2alphaRuleBoostActionResponse
    A boost action.
    condition GoogleCloudRetailV2alphaConditionResponse
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
    Prevents term from being associated with other terms.
    filterAction GoogleCloudRetailV2alphaRuleFilterActionResponse
    Filters results.
    forceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute as a facet in the request.
    ignoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Ignores specific terms from query during search.
    onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    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 GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page.
    removeFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Remove an attribute as a facet in the request (if present).
    replacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces specific terms in the query.
    twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Treats a set of terms as synonyms of one another.
    boostAction GoogleCloudRetailV2alphaRuleBoostActionResponse
    A boost action.
    condition GoogleCloudRetailV2alphaConditionResponse
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
    Prevents term from being associated with other terms.
    filterAction GoogleCloudRetailV2alphaRuleFilterActionResponse
    Filters results.
    forceReturnFacetAction GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute as a facet in the request.
    ignoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Ignores specific terms from query during search.
    onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    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 GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page.
    removeFacetAction GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Remove an attribute as a facet in the request (if present).
    replacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces specific terms in the query.
    twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Treats a set of terms as synonyms of one another.
    boost_action GoogleCloudRetailV2alphaRuleBoostActionResponse
    A boost action.
    condition GoogleCloudRetailV2alphaConditionResponse
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    do_not_associate_action GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
    Prevents term from being associated with other terms.
    filter_action GoogleCloudRetailV2alphaRuleFilterActionResponse
    Filters results.
    force_return_facet_action GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute as a facet in the request.
    ignore_action GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Ignores specific terms from query during search.
    oneway_synonyms_action GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    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 GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page.
    remove_facet_action GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Remove an attribute as a facet in the request (if present).
    replacement_action GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces specific terms in the query.
    twoway_synonyms_action GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Treats a set of terms as synonyms of one another.
    boostAction Property Map
    A boost action.
    condition Property Map
    The condition that triggers the rule. If the condition is empty, the rule will always apply.
    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.

    GoogleCloudRetailV2alphaRuleTwowaySynonymsAction, GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs

    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.

    GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse, GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponseArgs

    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.

    GoogleCloudRetailV2alphaSearchRequestFacetSpec, GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs

    FacetKey Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    The facet key specification.
    EnableDynamicPosition bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    ExcludedFilterKeys List<string>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    Limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    FacetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    The facet key specification.
    EnableDynamicPosition bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    ExcludedFilterKeys []string
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    Limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    The facet key specification.
    enableDynamicPosition Boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys List<String>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    limit Integer
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    The facet key specification.
    enableDynamicPosition boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys string[]
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    limit number
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    facet_key GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    The facet key specification.
    enable_dynamic_position bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excluded_filter_keys Sequence[str]
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    facetKey Property Map
    The facet key specification.
    enableDynamicPosition Boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys List<String>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    limit Number
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

    GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey, GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs

    Key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    CaseInsensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    Contains List<string>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    Intervals List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaInterval>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    OrderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    Prefixes List<string>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    Query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    RestrictedValues List<string>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    ReturnMinMax bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    Key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    CaseInsensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    Contains []string
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    Intervals []GoogleCloudRetailV2alphaInterval
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    OrderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    Prefixes []string
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    Query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    RestrictedValues []string
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    ReturnMinMax bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    key String
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    caseInsensitive Boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains List<String>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals List<GoogleCloudRetailV2alphaInterval>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    orderBy String
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes List<String>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query String
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues List<String>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax Boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    caseInsensitive boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains string[]
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals GoogleCloudRetailV2alphaInterval[]
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    orderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes string[]
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues string[]
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    key str
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    case_insensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains Sequence[str]
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals Sequence[GoogleCloudRetailV2alphaInterval]
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    order_by str
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes Sequence[str]
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query str
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restricted_values Sequence[str]
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    return_min_max bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    key String
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    caseInsensitive Boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains List<String>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals List<Property Map>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    orderBy String
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes List<String>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query String
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues List<String>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax Boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

    GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse, GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponseArgs

    CaseInsensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    Contains List<string>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    Intervals List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaIntervalResponse>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    Key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    OrderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    Prefixes List<string>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    Query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    RestrictedValues List<string>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    ReturnMinMax bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    CaseInsensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    Contains []string
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    Intervals []GoogleCloudRetailV2alphaIntervalResponse
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    Key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    OrderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    Prefixes []string
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    Query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    RestrictedValues []string
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    ReturnMinMax bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    caseInsensitive Boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains List<String>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals List<GoogleCloudRetailV2alphaIntervalResponse>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    key String
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    orderBy String
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes List<String>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query String
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues List<String>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax Boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    caseInsensitive boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains string[]
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals GoogleCloudRetailV2alphaIntervalResponse[]
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    key string
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    orderBy string
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes string[]
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query string
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues string[]
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    case_insensitive bool
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains Sequence[str]
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals Sequence[GoogleCloudRetailV2alphaIntervalResponse]
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    key str
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    order_by str
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes Sequence[str]
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query str
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restricted_values Sequence[str]
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    return_min_max bool
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.
    caseInsensitive Boolean
    True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
    contains List<String>
    Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
    intervals List<Property Map>
    Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 40. For all numerical facet keys that appear in the list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and 100 are computed from their distribution weekly. If the model assigns a high score to a numerical facet key and its intervals are not specified in the search request, these percentiles become the bounds for its intervals and are returned in the response. If the facet key intervals are specified in the request, then the specified intervals are returned instead.
    key String
    Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"
    orderBy String
    The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.
    prefixes List<String>
    Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.
    query String
    The query that is used to compute facet for the given facet key. When provided, it overrides the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value is always "1" and SearchResponse.Facet.values.count is the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet counts the products that are both in stock and ship to store "123".
    restrictedValues List<String>
    Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5
    returnMinMax Boolean
    Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

    GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse, GoogleCloudRetailV2alphaSearchRequestFacetSpecResponseArgs

    EnableDynamicPosition bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    ExcludedFilterKeys List<string>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    FacetKey Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    The facet key specification.
    Limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    EnableDynamicPosition bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    ExcludedFilterKeys []string
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    FacetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    The facet key specification.
    Limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    enableDynamicPosition Boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys List<String>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    The facet key specification.
    limit Integer
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    enableDynamicPosition boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys string[]
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    The facet key specification.
    limit number
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    enable_dynamic_position bool
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excluded_filter_keys Sequence[str]
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    facet_key GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    The facet key specification.
    limit int
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
    enableDynamicPosition Boolean
    Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It is ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which generates a facet "gender". Then, the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position values are false.
    excludedFilterKeys List<String>
    List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
    facetKey Property Map
    The facet key specification.
    limit Number
    Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

    Package Details

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

    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