Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

Control

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 a Control Resource

new Control(name: string, args: ControlArgs, opts?: CustomResourceOptions);
@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,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            rule: Optional[GoogleCloudRetailV2RuleArgs] = None,
            search_solution_use_case: Optional[Sequence[ControlSearchSolutionUseCaseItem]] = None,
            solution_types: Optional[Sequence[ControlSolutionTypesItem]] = None)
@overload
def Control(resource_name: str,
            args: ControlArgs,
            opts: Optional[ResourceOptions] = None)
func NewControl(ctx *Context, name string, args ControlArgs, opts ...ResourceOption) (*Control, error)
public Control(string name, ControlArgs args, CustomResourceOptions? opts = null)
public Control(String name, ControlArgs args)
public Control(String name, ControlArgs args, CustomResourceOptions options)
type: google-native:retail/v2:Control
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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.

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.V2.ControlSolutionTypesItem>

Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

Location string
Name string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Project string
Rule Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleArgs

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

SearchSolutionUseCase List<Pulumi.GoogleNative.Retail.V2.ControlSearchSolutionUseCaseItem>

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

CatalogId 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.

Location string
Name string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Project string
Rule GoogleCloudRetailV2RuleArgs

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

SearchSolutionUseCase []ControlSearchSolutionUseCaseItem

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

catalogId 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.

location String
name String

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

project String
rule GoogleCloudRetailV2RuleArgs

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

searchSolutionUseCase 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.

location string
name string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

project string
rule GoogleCloudRetailV2RuleArgs

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

searchSolutionUseCase ControlSearchSolutionUseCaseItem[]

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

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.

location str
name str

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

project str
rule GoogleCloudRetailV2RuleArgs

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

search_solution_use_case Sequence[ControlSearchSolutionUseCaseItem]

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

catalogId 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.

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 configuration 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 configuration 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 configuration 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 configuration 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 configuration 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 configuration 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

SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.

SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCH

Search use case. Expects the traffic has a non-empty query.

SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

ControlSearchSolutionUseCaseItemSearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.

ControlSearchSolutionUseCaseItemSearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCH

Search use case. Expects the traffic has a non-empty query.

ControlSearchSolutionUseCaseItemSearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.

SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCH

Search use case. Expects the traffic has a non-empty query.

SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

SearchSolutionUseCaseUnspecified
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH.

SearchSolutionUseCaseSearch
SEARCH_SOLUTION_USE_CASE_SEARCH

Search use case. Expects the traffic has a non-empty query.

SearchSolutionUseCaseBrowse
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

SEARCH_SOLUTION_USE_CASE_UNSPECIFIED
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The 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_SEARCH

Search use case. Expects the traffic has a non-empty query.

SEARCH_SOLUTION_USE_CASE_BROWSE
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

"SEARCH_SOLUTION_USE_CASE_UNSPECIFIED"
SEARCH_SOLUTION_USE_CASE_UNSPECIFIED

The 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_SEARCH

Search use case. Expects the traffic has a non-empty query.

"SEARCH_SOLUTION_USE_CASE_BROWSE"
SEARCH_SOLUTION_USE_CASE_BROWSE

Browse use case. Expects the traffic has an empty query.

ControlSolutionTypesItem

SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIED

Default value.

SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

SolutionTypeSearch
SOLUTION_TYPE_SEARCH

Used for Retail Search.

ControlSolutionTypesItemSolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIED

Default value.

ControlSolutionTypesItemSolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

ControlSolutionTypesItemSolutionTypeSearch
SOLUTION_TYPE_SEARCH

Used for Retail Search.

SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIED

Default value.

SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

SolutionTypeSearch
SOLUTION_TYPE_SEARCH

Used for Retail Search.

SolutionTypeUnspecified
SOLUTION_TYPE_UNSPECIFIED

Default value.

SolutionTypeRecommendation
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

SolutionTypeSearch
SOLUTION_TYPE_SEARCH

Used for Retail Search.

SOLUTION_TYPE_UNSPECIFIED
SOLUTION_TYPE_UNSPECIFIED

Default value.

SOLUTION_TYPE_RECOMMENDATION
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

SOLUTION_TYPE_SEARCH
SOLUTION_TYPE_SEARCH

Used for Retail Search.

"SOLUTION_TYPE_UNSPECIFIED"
SOLUTION_TYPE_UNSPECIFIED

Default value.

"SOLUTION_TYPE_RECOMMENDATION"
SOLUTION_TYPE_RECOMMENDATION

Used for Recommendations AI.

"SOLUTION_TYPE_SEARCH"
SOLUTION_TYPE_SEARCH

Used for Retail Search.

GoogleCloudRetailV2Condition

ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionTimeRange>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

QueryTerms List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionQueryTerm>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

ActiveTimeRange []GoogleCloudRetailV2ConditionTimeRange

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

QueryTerms []GoogleCloudRetailV2ConditionQueryTerm

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange List<GoogleCloudRetailV2ConditionTimeRange>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

queryTerms List<GoogleCloudRetailV2ConditionQueryTerm>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange GoogleCloudRetailV2ConditionTimeRange[]

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

queryTerms GoogleCloudRetailV2ConditionQueryTerm[]

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

active_time_range Sequence[GoogleCloudRetailV2ConditionTimeRange]

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

query_terms Sequence[GoogleCloudRetailV2ConditionQueryTerm]

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange List<Property Map>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

queryTerms List<Property Map>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

GoogleCloudRetailV2ConditionQueryTerm

FullMatch bool

Whether this is supposed to be a full or partial match.

Value string

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

FullMatch bool

Whether this is supposed to be a full or partial match.

Value string

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

fullMatch Boolean

Whether this is supposed to be a full or partial match.

value String

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

fullMatch boolean

Whether this is supposed to be a full or partial match.

value string

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

full_match bool

Whether this is supposed to be a full or partial match.

value str

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

fullMatch Boolean

Whether this is supposed to be a full or partial match.

value String

The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.

GoogleCloudRetailV2ConditionQueryTermResponse

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.

GoogleCloudRetailV2ConditionResponse

ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionTimeRangeResponse>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

QueryTerms List<Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionQueryTermResponse>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

ActiveTimeRange []GoogleCloudRetailV2ConditionTimeRangeResponse

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

QueryTerms []GoogleCloudRetailV2ConditionQueryTermResponse

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange List<GoogleCloudRetailV2ConditionTimeRangeResponse>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

queryTerms List<GoogleCloudRetailV2ConditionQueryTermResponse>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange GoogleCloudRetailV2ConditionTimeRangeResponse[]

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

queryTerms GoogleCloudRetailV2ConditionQueryTermResponse[]

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

active_time_range Sequence[GoogleCloudRetailV2ConditionTimeRangeResponse]

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

query_terms Sequence[GoogleCloudRetailV2ConditionQueryTermResponse]

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

activeTimeRange List<Property Map>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

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).

GoogleCloudRetailV2ConditionTimeRange

EndTime string

End of time range. Range is inclusive.

StartTime string

Start of time range. Range is inclusive.

EndTime string

End of time range. Range is inclusive.

StartTime string

Start of time range. Range is inclusive.

endTime String

End of time range. Range is inclusive.

startTime String

Start of time range. Range is inclusive.

endTime string

End of time range. Range is inclusive.

startTime string

Start of time range. Range is inclusive.

end_time str

End of time range. Range is inclusive.

start_time str

Start of time range. Range is inclusive.

endTime String

End of time range. Range is inclusive.

startTime String

Start of time range. Range is inclusive.

GoogleCloudRetailV2ConditionTimeRangeResponse

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.

GoogleCloudRetailV2Rule

Condition Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2Condition

The condition that triggers the rule. If the condition is empty, the rule will always apply.

BoostAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleBoostAction

A boost action.

DoNotAssociateAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleDoNotAssociateAction

Prevents term from being associated with other terms.

FilterAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleFilterAction

Filters results.

IgnoreAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleIgnoreAction

Ignores specific terms from query during search.

OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleOnewaySynonymsAction

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

RedirectAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRedirectAction

Redirects a shopper to a specific page.

ReplacementAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleReplacementAction

Replaces specific terms in the query.

TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

Condition GoogleCloudRetailV2Condition

The condition that triggers the rule. If the condition is empty, the rule will always apply.

BoostAction GoogleCloudRetailV2RuleBoostAction

A boost action.

DoNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction

Prevents term from being associated with other terms.

FilterAction GoogleCloudRetailV2RuleFilterAction

Filters results.

IgnoreAction GoogleCloudRetailV2RuleIgnoreAction

Ignores specific terms from query during search.

OnewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

RedirectAction GoogleCloudRetailV2RuleRedirectAction

Redirects a shopper to a specific page.

ReplacementAction GoogleCloudRetailV2RuleReplacementAction

Replaces specific terms in the query.

TwowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

condition GoogleCloudRetailV2Condition

The condition that triggers the rule. If the condition is empty, the rule will always apply.

boostAction GoogleCloudRetailV2RuleBoostAction

A boost action.

doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2RuleFilterAction

Filters results.

ignoreAction GoogleCloudRetailV2RuleIgnoreAction

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirectAction GoogleCloudRetailV2RuleRedirectAction

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2RuleReplacementAction

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

condition GoogleCloudRetailV2Condition

The condition that triggers the rule. If the condition is empty, the rule will always apply.

boostAction GoogleCloudRetailV2RuleBoostAction

A boost action.

doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2RuleFilterAction

Filters results.

ignoreAction GoogleCloudRetailV2RuleIgnoreAction

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirectAction GoogleCloudRetailV2RuleRedirectAction

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2RuleReplacementAction

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction

Treats a set of terms as synonyms of one another.

condition GoogleCloudRetailV2Condition

The condition that triggers the rule. If the condition is empty, the rule will always apply.

boost_action GoogleCloudRetailV2RuleBoostAction

A boost action.

do_not_associate_action GoogleCloudRetailV2RuleDoNotAssociateAction

Prevents term from being associated with other terms.

filter_action GoogleCloudRetailV2RuleFilterAction

Filters results.

ignore_action GoogleCloudRetailV2RuleIgnoreAction

Ignores specific terms from query during search.

oneway_synonyms_action GoogleCloudRetailV2RuleOnewaySynonymsAction

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirect_action GoogleCloudRetailV2RuleRedirectAction

Redirects a shopper to a specific page.

replacement_action GoogleCloudRetailV2RuleReplacementAction

Replaces specific terms in the query.

twoway_synonyms_action GoogleCloudRetailV2RuleTwowaySynonymsAction

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.

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.

replacementAction Property Map

Replaces specific terms in the query.

twowaySynonymsAction Property Map

Treats a set of terms as synonyms of one another.

GoogleCloudRetailV2RuleBoostAction

Boost double

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

ProductsFilter string

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

Boost float64

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

ProductsFilter string

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

boost Double

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

productsFilter String

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

boost number

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

productsFilter string

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

boost float

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

products_filter str

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

boost Number

Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.

productsFilter String

The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleBoostActionResponse

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

GoogleCloudRetailV2RuleDoNotAssociateAction

DoNotAssociateTerms List<string>

Cannot contain duplicates or the query term. Can specify up to 100 terms.

QueryTerms List<string>

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

Terms List<string>

Will be [deprecated = true] post migration;

DoNotAssociateTerms []string

Cannot contain duplicates or the query term. Can specify up to 100 terms.

QueryTerms []string

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

Terms []string

Will be [deprecated = true] post migration;

doNotAssociateTerms List<String>

Cannot contain duplicates or the query term. Can specify up to 100 terms.

queryTerms List<String>

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

terms List<String>

Will be [deprecated = true] post migration;

doNotAssociateTerms string[]

Cannot contain duplicates or the query term. Can specify up to 100 terms.

queryTerms string[]

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

terms string[]

Will be [deprecated = true] post migration;

do_not_associate_terms Sequence[str]

Cannot contain duplicates or the query term. Can specify up to 100 terms.

query_terms Sequence[str]

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

terms Sequence[str]

Will be [deprecated = true] post migration;

doNotAssociateTerms List<String>

Cannot contain duplicates or the query term. Can specify up to 100 terms.

queryTerms List<String>

Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.

terms List<String>

Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleDoNotAssociateActionResponse

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;

GoogleCloudRetailV2RuleFilterAction

Filter string

A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *

GoogleCloudRetailV2RuleFilterActionResponse

Filter string

A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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. See more details at the Retail Search user guide. * 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")) *

GoogleCloudRetailV2RuleIgnoreAction

IgnoreTerms List<string>

Terms to ignore in the search query.

IgnoreTerms []string

Terms to ignore in the search query.

ignoreTerms List<String>

Terms to ignore in the search query.

ignoreTerms string[]

Terms to ignore in the search query.

ignore_terms Sequence[str]

Terms to ignore in the search query.

ignoreTerms List<String>

Terms to ignore in the search query.

GoogleCloudRetailV2RuleIgnoreActionResponse

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.

GoogleCloudRetailV2RuleOnewaySynonymsAction

OnewayTerms List<string>

Will be [deprecated = true] post migration;

QueryTerms List<string>

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

Synonyms List<string>

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

OnewayTerms []string

Will be [deprecated = true] post migration;

QueryTerms []string

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

Synonyms []string

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

onewayTerms List<String>

Will be [deprecated = true] post migration;

queryTerms List<String>

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

synonyms List<String>

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

onewayTerms string[]

Will be [deprecated = true] post migration;

queryTerms string[]

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

synonyms string[]

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

oneway_terms Sequence[str]

Will be [deprecated = true] post migration;

query_terms Sequence[str]

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

synonyms Sequence[str]

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

onewayTerms List<String>

Will be [deprecated = true] post migration;

queryTerms List<String>

Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.

synonyms List<String>

Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.

GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

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.

GoogleCloudRetailV2RuleRedirectAction

RedirectUri string

URL must have length equal or less than 2000 characters.

RedirectUri string

URL must have length equal or less than 2000 characters.

redirectUri String

URL must have length equal or less than 2000 characters.

redirectUri string

URL must have length equal or less than 2000 characters.

redirect_uri str

URL must have length equal or less than 2000 characters.

redirectUri String

URL must have length equal or less than 2000 characters.

GoogleCloudRetailV2RuleRedirectActionResponse

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.

GoogleCloudRetailV2RuleReplacementAction

QueryTerms List<string>

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

ReplacementTerm string

Term that will be used for replacement.

Term string

Will be [deprecated = true] post migration;

QueryTerms []string

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

ReplacementTerm string

Term that will be used for replacement.

Term string

Will be [deprecated = true] post migration;

queryTerms List<String>

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

replacementTerm String

Term that will be used for replacement.

term String

Will be [deprecated = true] post migration;

queryTerms string[]

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

replacementTerm string

Term that will be used for replacement.

term string

Will be [deprecated = true] post migration;

query_terms Sequence[str]

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

replacement_term str

Term that will be used for replacement.

term str

Will be [deprecated = true] post migration;

queryTerms List<String>

Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.

replacementTerm String

Term that will be used for replacement.

term String

Will be [deprecated = true] post migration;

GoogleCloudRetailV2RuleReplacementActionResponse

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;

GoogleCloudRetailV2RuleResponse

BoostAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleBoostActionResponse

A boost action.

Condition Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2ConditionResponse

The condition that triggers the rule. If the condition is empty, the rule will always apply.

DoNotAssociateAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

FilterAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleFilterActionResponse

Filters results.

IgnoreAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleIgnoreActionResponse

Ignores specific terms from query during search.

OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

RedirectAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleRedirectActionResponse

Redirects a shopper to a specific page.

ReplacementAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleReplacementActionResponse

Replaces specific terms in the query.

TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2.Inputs.GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

BoostAction GoogleCloudRetailV2RuleBoostActionResponse

A boost action.

Condition GoogleCloudRetailV2ConditionResponse

The condition that triggers the rule. If the condition is empty, the rule will always apply.

DoNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

FilterAction GoogleCloudRetailV2RuleFilterActionResponse

Filters results.

IgnoreAction GoogleCloudRetailV2RuleIgnoreActionResponse

Ignores specific terms from query during search.

OnewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

RedirectAction GoogleCloudRetailV2RuleRedirectActionResponse

Redirects a shopper to a specific page.

ReplacementAction GoogleCloudRetailV2RuleReplacementActionResponse

Replaces specific terms in the query.

TwowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boostAction GoogleCloudRetailV2RuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2ConditionResponse

The condition that triggers the rule. If the condition is empty, the rule will always apply.

doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2RuleFilterActionResponse

Filters results.

ignoreAction GoogleCloudRetailV2RuleIgnoreActionResponse

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirectAction GoogleCloudRetailV2RuleRedirectActionResponse

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2RuleReplacementActionResponse

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boostAction GoogleCloudRetailV2RuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2ConditionResponse

The condition that triggers the rule. If the condition is empty, the rule will always apply.

doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2RuleFilterActionResponse

Filters results.

ignoreAction GoogleCloudRetailV2RuleIgnoreActionResponse

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirectAction GoogleCloudRetailV2RuleRedirectActionResponse

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2RuleReplacementActionResponse

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boost_action GoogleCloudRetailV2RuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2ConditionResponse

The condition that triggers the rule. If the condition is empty, the rule will always apply.

do_not_associate_action GoogleCloudRetailV2RuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filter_action GoogleCloudRetailV2RuleFilterActionResponse

Filters results.

ignore_action GoogleCloudRetailV2RuleIgnoreActionResponse

Ignores specific terms from query during search.

oneway_synonyms_action GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.

redirect_action GoogleCloudRetailV2RuleRedirectActionResponse

Redirects a shopper to a specific page.

replacement_action GoogleCloudRetailV2RuleReplacementActionResponse

Replaces specific terms in the query.

twoway_synonyms_action GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

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.

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.

replacementAction Property Map

Replaces specific terms in the query.

twowaySynonymsAction Property Map

Treats a set of terms as synonyms of one another.

GoogleCloudRetailV2RuleTwowaySynonymsAction

Synonyms List<string>

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

Synonyms []string

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

synonyms List<String>

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

synonyms string[]

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

synonyms Sequence[str]

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

synonyms List<String>

Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.

GoogleCloudRetailV2RuleTwowaySynonymsActionResponse

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.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0