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
google-native.retail/v2.getControl
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a Control.
Using getControl
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getControl(args: GetControlArgs, opts?: InvokeOptions): Promise<GetControlResult>
function getControlOutput(args: GetControlOutputArgs, opts?: InvokeOptions): Output<GetControlResult>
def get_control(catalog_id: Optional[str] = None,
control_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetControlResult
def get_control_output(catalog_id: Optional[pulumi.Input[str]] = None,
control_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetControlResult]
func LookupControl(ctx *Context, args *LookupControlArgs, opts ...InvokeOption) (*LookupControlResult, error)
func LookupControlOutput(ctx *Context, args *LookupControlOutputArgs, opts ...InvokeOption) LookupControlResultOutput
> Note: This function is named LookupControl
in the Go SDK.
public static class GetControl
{
public static Task<GetControlResult> InvokeAsync(GetControlArgs args, InvokeOptions? opts = null)
public static Output<GetControlResult> Invoke(GetControlInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetControlResult> getControl(GetControlArgs args, InvokeOptions options)
public static Output<GetControlResult> getControl(GetControlArgs args, InvokeOptions options)
fn::invoke:
function: google-native:retail/v2:getControl
arguments:
# arguments dictionary
The following arguments are supported:
- catalog_
id This property is required. str - control_
id This property is required. str - location
This property is required. str - project str
getControl Result
The following output properties are available:
- Associated
Serving List<string>Config Ids - 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.
- Display
Name 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.
- Name string
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- Rule
Pulumi.
Google Native. Retail. V2. Outputs. Google Cloud Retail V2Rule Response - 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 List<string>Use Case - 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.
- Solution
Types List<string> - 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.
- Associated
Serving []stringConfig Ids - 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.
- Display
Name 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.
- Name string
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- Rule
Google
Cloud Retail V2Rule Response - 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 []stringUse Case - 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.
- Solution
Types []string - 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.
- associated
Serving List<String>Config Ids - 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.
- display
Name 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.
- name String
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- rule
Google
Cloud Retail V2Rule Response - 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 List<String>Use Case - 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.
- solution
Types List<String> - 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.
- associated
Serving string[]Config Ids - 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.
- display
Name 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.
- name string
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- rule
Google
Cloud Retail V2Rule Response - 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 string[]Use Case - 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.
- solution
Types string[] - 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.
- associated_
serving_ Sequence[str]config_ ids - 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.
- 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.
- name str
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- rule
Google
Cloud Retail V2Rule Response - 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_ Sequence[str]use_ case - 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.
- solution_
types Sequence[str] - 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.
- associated
Serving List<String>Config Ids - 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.
- display
Name 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.
- name String
- Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
- 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".
- search
Solution List<String>Use Case - 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.
- solution
Types List<String> - 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.
Supporting Types
GoogleCloudRetailV2ConditionQueryTermResponse
- Full
Match This property is required. bool - Whether this is supposed to be a full or partial match.
- Value
This property is required. string - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
- Full
Match This property is required. bool - Whether this is supposed to be a full or partial match.
- Value
This property is required. string - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
- full
Match This property is required. Boolean - Whether this is supposed to be a full or partial match.
- value
This property is required. String - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
- full
Match This property is required. boolean - Whether this is supposed to be a full or partial match.
- value
This property is required. string - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
- full_
match This property is required. bool - Whether this is supposed to be a full or partial match.
- value
This property is required. str - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
- full
Match This property is required. Boolean - Whether this is supposed to be a full or partial match.
- value
This property is required. String - The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
GoogleCloudRetailV2ConditionResponse
- Active
Time Range This property is required. List<Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Condition Time Range Response> - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- Page
Categories This property is required. List<string> - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- Query
Terms This property is required. List<Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Condition Query Term Response> - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
- Active
Time Range This property is required. []GoogleCloud Retail V2Condition Time Range Response - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- Page
Categories This property is required. []string - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- Query
Terms This property is required. []GoogleCloud Retail V2Condition Query Term Response - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
- active
Time Range This property is required. List<GoogleCloud Retail V2Condition Time Range Response> - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- page
Categories This property is required. List<String> - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- query
Terms This property is required. List<GoogleCloud Retail V2Condition Query Term Response> - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
- active
Time Range This property is required. GoogleCloud Retail V2Condition Time Range Response[] - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- page
Categories This property is required. string[] - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- query
Terms This property is required. GoogleCloud Retail V2Condition Query Term Response[] - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
- active_
time_ range This property is required. Sequence[GoogleCloud Retail V2Condition Time Range Response] - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- page_
categories This property is required. Sequence[str] - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- query_
terms This property is required. Sequence[GoogleCloud Retail V2Condition Query Term Response] - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
- active
Time Range This property is required. List<Property Map> - Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- page
Categories This property is required. List<String> - Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- query
Terms This property is required. List<Property Map> - A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
GoogleCloudRetailV2ConditionTimeRangeResponse
- end_
time This property is required. str - End of time range. Range is inclusive.
- start_
time This property is required. str - Start of time range. Range is inclusive.
GoogleCloudRetailV2RuleBoostActionResponse
- Boost
This property is required. double - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- Products
Filter This property is required. string - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- Boost
This property is required. float64 - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- Products
Filter This property is required. string - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- boost
This property is required. Double - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- products
Filter This property is required. String - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- boost
This property is required. number - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- products
Filter This property is required. string - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- boost
This property is required. float - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- products_
filter This property is required. str - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- boost
This property is required. Number - Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
- products
Filter This property is required. String - The filter can have a max size of 5000 characters. An expression which specifies which products to apply an action to. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
GoogleCloudRetailV2RuleDoNotAssociateActionResponse
- Do
Not Associate Terms This property is required. List<string> - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- Query
Terms This property is required. List<string> - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- Terms
This property is required. List<string> - Will be [deprecated = true] post migration;
- Do
Not Associate Terms This property is required. []string - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- Query
Terms This property is required. []string - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- Terms
This property is required. []string - Will be [deprecated = true] post migration;
- do
Not Associate Terms This property is required. List<String> - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- query
Terms This property is required. List<String> - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- terms
This property is required. List<String> - Will be [deprecated = true] post migration;
- do
Not Associate Terms This property is required. string[] - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- query
Terms This property is required. string[] - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- terms
This property is required. string[] - Will be [deprecated = true] post migration;
- do_
not_ associate_ terms This property is required. Sequence[str] - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- query_
terms This property is required. Sequence[str] - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- terms
This property is required. Sequence[str] - Will be [deprecated = true] post migration;
- do
Not Associate Terms This property is required. List<String> - Cannot contain duplicates or the query term. Can specify up to 100 terms.
- query
Terms This property is required. List<String> - Terms from the search query. Will not consider do_not_associate_terms for search if in search query. Can specify up to 100 terms.
- terms
This property is required. List<String> - Will be [deprecated = true] post migration;
GoogleCloudRetailV2RuleFilterActionResponse
- Filter
This property is required. string - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- Filter
This property is required. string - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter
This property is required. String - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter
This property is required. string - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter
This property is required. str - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter
This property is required. String - A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse
- Attribute
Name This property is required. string - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- Position
This property is required. int - This is the position in the request as explained above. It should be strictly positive be at most 100.
- Attribute
Name This property is required. string - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- Position
This property is required. int - This is the position in the request as explained above. It should be strictly positive be at most 100.
- attribute
Name This property is required. String - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position
This property is required. Integer - This is the position in the request as explained above. It should be strictly positive be at most 100.
- attribute
Name This property is required. string - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position
This property is required. number - This is the position in the request as explained above. It should be strictly positive be at most 100.
- attribute_
name This property is required. str - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position
This property is required. int - This is the position in the request as explained above. It should be strictly positive be at most 100.
- attribute
Name This property is required. String - The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position
This property is required. Number - This is the position in the request as explained above. It should be strictly positive be at most 100.
GoogleCloudRetailV2RuleForceReturnFacetActionResponse
- Facet
Position Adjustments This property is required. List<Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Force Return Facet Action Facet Position Adjustment Response> - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
- Facet
Position Adjustments This property is required. []GoogleCloud Retail V2Rule Force Return Facet Action Facet Position Adjustment Response - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
- facet
Position Adjustments This property is required. List<GoogleCloud Retail V2Rule Force Return Facet Action Facet Position Adjustment Response> - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
- facet
Position Adjustments This property is required. GoogleCloud Retail V2Rule Force Return Facet Action Facet Position Adjustment Response[] - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
- facet_
position_ adjustments This property is required. Sequence[GoogleCloud Retail V2Rule Force Return Facet Action Facet Position Adjustment Response] - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
- facet
Position Adjustments This property is required. List<Property Map> - Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
GoogleCloudRetailV2RuleIgnoreActionResponse
- Ignore
Terms This property is required. List<string> - Terms to ignore in the search query.
- Ignore
Terms This property is required. []string - Terms to ignore in the search query.
- ignore
Terms This property is required. List<String> - Terms to ignore in the search query.
- ignore
Terms This property is required. string[] - Terms to ignore in the search query.
- ignore_
terms This property is required. Sequence[str] - Terms to ignore in the search query.
- ignore
Terms This property is required. List<String> - Terms to ignore in the search query.
GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
- Oneway
Terms This property is required. List<string> - Will be [deprecated = true] post migration;
- Query
Terms This property is required. List<string> - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- Synonyms
This property is required. List<string> - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
- Oneway
Terms This property is required. []string - Will be [deprecated = true] post migration;
- Query
Terms This property is required. []string - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- Synonyms
This property is required. []string - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
- oneway
Terms This property is required. List<String> - Will be [deprecated = true] post migration;
- query
Terms This property is required. List<String> - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- synonyms
This property is required. List<String> - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
- oneway
Terms This property is required. string[] - Will be [deprecated = true] post migration;
- query
Terms This property is required. string[] - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- synonyms
This property is required. string[] - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
- oneway_
terms This property is required. Sequence[str] - Will be [deprecated = true] post migration;
- query_
terms This property is required. Sequence[str] - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- synonyms
This property is required. Sequence[str] - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
- oneway
Terms This property is required. List<String> - Will be [deprecated = true] post migration;
- query
Terms This property is required. List<String> - Terms from the search query. Will treat synonyms as their synonyms. Not themselves synonyms of the synonyms. Can specify up to 100 terms.
- synonyms
This property is required. List<String> - Defines a set of synonyms. Cannot contain duplicates. Can specify up to 100 synonyms.
GoogleCloudRetailV2RuleRedirectActionResponse
- Redirect
Uri This property is required. string - URL must have length equal or less than 2000 characters.
- Redirect
Uri This property is required. string - URL must have length equal or less than 2000 characters.
- redirect
Uri This property is required. String - URL must have length equal or less than 2000 characters.
- redirect
Uri This property is required. string - URL must have length equal or less than 2000 characters.
- redirect_
uri This property is required. str - URL must have length equal or less than 2000 characters.
- redirect
Uri This property is required. String - URL must have length equal or less than 2000 characters.
GoogleCloudRetailV2RuleRemoveFacetActionResponse
- Attribute
Names This property is required. List<string> - The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- Attribute
Names This property is required. []string - The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attribute
Names This property is required. 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.
- attribute
Names This property is required. string[] - The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attribute_
names This property is required. Sequence[str] - The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attribute
Names This property is required. List<String> - The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
GoogleCloudRetailV2RuleReplacementActionResponse
- Query
Terms This property is required. List<string> - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- Replacement
Term This property is required. string - Term that will be used for replacement.
- Term
This property is required. string - Will be [deprecated = true] post migration;
- Query
Terms This property is required. []string - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- Replacement
Term This property is required. string - Term that will be used for replacement.
- Term
This property is required. string - Will be [deprecated = true] post migration;
- query
Terms This property is required. List<String> - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- replacement
Term This property is required. String - Term that will be used for replacement.
- term
This property is required. String - Will be [deprecated = true] post migration;
- query
Terms This property is required. string[] - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- replacement
Term This property is required. string - Term that will be used for replacement.
- term
This property is required. string - Will be [deprecated = true] post migration;
- query_
terms This property is required. Sequence[str] - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- replacement_
term This property is required. str - Term that will be used for replacement.
- term
This property is required. str - Will be [deprecated = true] post migration;
- query
Terms This property is required. List<String> - Terms from the search query. Will be replaced by replacement term. Can specify up to 100 terms.
- replacement
Term This property is required. String - Term that will be used for replacement.
- term
This property is required. String - Will be [deprecated = true] post migration;
GoogleCloudRetailV2RuleResponse
- Boost
Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Boost Action Response - A boost action.
- Condition
This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Condition Response - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- Do
Not Associate Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Do Not Associate Action Response - Prevents term from being associated with other terms.
- Filter
Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Filter Action Response - Filters results.
- Force
Return Facet Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Force Return Facet Action Response - Force returns an attribute as a facet in the request.
- Ignore
Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Ignore Action Response - Ignores specific terms from query during search.
- Oneway
Synonyms Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Oneway Synonyms Action Response - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- Redirect
Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Redirect Action Response - Redirects a shopper to a specific page.
- Remove
Facet Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Remove Facet Action Response - Remove an attribute as a facet in the request (if present).
- Replacement
Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Replacement Action Response - Replaces specific terms in the query.
- Twoway
Synonyms Action This property is required. Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Twoway Synonyms Action Response - Treats a set of terms as synonyms of one another.
- Boost
Action This property is required. GoogleCloud Retail V2Rule Boost Action Response - A boost action.
- Condition
This property is required. GoogleCloud Retail V2Condition Response - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- Do
Not Associate Action This property is required. GoogleCloud Retail V2Rule Do Not Associate Action Response - Prevents term from being associated with other terms.
- Filter
Action This property is required. GoogleCloud Retail V2Rule Filter Action Response - Filters results.
- Force
Return Facet Action This property is required. GoogleCloud Retail V2Rule Force Return Facet Action Response - Force returns an attribute as a facet in the request.
- Ignore
Action This property is required. GoogleCloud Retail V2Rule Ignore Action Response - Ignores specific terms from query during search.
- Oneway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Oneway Synonyms Action Response - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- Redirect
Action This property is required. GoogleCloud Retail V2Rule Redirect Action Response - Redirects a shopper to a specific page.
- Remove
Facet Action This property is required. GoogleCloud Retail V2Rule Remove Facet Action Response - Remove an attribute as a facet in the request (if present).
- Replacement
Action This property is required. GoogleCloud Retail V2Rule Replacement Action Response - Replaces specific terms in the query.
- Twoway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Twoway Synonyms Action Response - Treats a set of terms as synonyms of one another.
- boost
Action This property is required. GoogleCloud Retail V2Rule Boost Action Response - A boost action.
- condition
This property is required. GoogleCloud Retail V2Condition Response - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- do
Not Associate Action This property is required. GoogleCloud Retail V2Rule Do Not Associate Action Response - Prevents term from being associated with other terms.
- filter
Action This property is required. GoogleCloud Retail V2Rule Filter Action Response - Filters results.
- force
Return Facet Action This property is required. GoogleCloud Retail V2Rule Force Return Facet Action Response - Force returns an attribute as a facet in the request.
- ignore
Action This property is required. GoogleCloud Retail V2Rule Ignore Action Response - Ignores specific terms from query during search.
- oneway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Oneway Synonyms Action Response - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- redirect
Action This property is required. GoogleCloud Retail V2Rule Redirect Action Response - Redirects a shopper to a specific page.
- remove
Facet Action This property is required. GoogleCloud Retail V2Rule Remove Facet Action Response - Remove an attribute as a facet in the request (if present).
- replacement
Action This property is required. GoogleCloud Retail V2Rule Replacement Action Response - Replaces specific terms in the query.
- twoway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Twoway Synonyms Action Response - Treats a set of terms as synonyms of one another.
- boost
Action This property is required. GoogleCloud Retail V2Rule Boost Action Response - A boost action.
- condition
This property is required. GoogleCloud Retail V2Condition Response - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- do
Not Associate Action This property is required. GoogleCloud Retail V2Rule Do Not Associate Action Response - Prevents term from being associated with other terms.
- filter
Action This property is required. GoogleCloud Retail V2Rule Filter Action Response - Filters results.
- force
Return Facet Action This property is required. GoogleCloud Retail V2Rule Force Return Facet Action Response - Force returns an attribute as a facet in the request.
- ignore
Action This property is required. GoogleCloud Retail V2Rule Ignore Action Response - Ignores specific terms from query during search.
- oneway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Oneway Synonyms Action Response - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- redirect
Action This property is required. GoogleCloud Retail V2Rule Redirect Action Response - Redirects a shopper to a specific page.
- remove
Facet Action This property is required. GoogleCloud Retail V2Rule Remove Facet Action Response - Remove an attribute as a facet in the request (if present).
- replacement
Action This property is required. GoogleCloud Retail V2Rule Replacement Action Response - Replaces specific terms in the query.
- twoway
Synonyms Action This property is required. GoogleCloud Retail V2Rule Twoway Synonyms Action Response - Treats a set of terms as synonyms of one another.
- boost_
action This property is required. GoogleCloud Retail V2Rule Boost Action Response - A boost action.
- condition
This property is required. GoogleCloud Retail V2Condition Response - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- do_
not_ associate_ action This property is required. GoogleCloud Retail V2Rule Do Not Associate Action Response - Prevents term from being associated with other terms.
- filter_
action This property is required. GoogleCloud Retail V2Rule Filter Action Response - Filters results.
- force_
return_ facet_ action This property is required. GoogleCloud Retail V2Rule Force Return Facet Action Response - Force returns an attribute as a facet in the request.
- ignore_
action This property is required. GoogleCloud Retail V2Rule Ignore Action Response - Ignores specific terms from query during search.
- oneway_
synonyms_ action This property is required. GoogleCloud Retail V2Rule Oneway Synonyms Action Response - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- redirect_
action This property is required. GoogleCloud Retail V2Rule Redirect Action Response - Redirects a shopper to a specific page.
- remove_
facet_ action This property is required. GoogleCloud Retail V2Rule Remove Facet Action Response - Remove an attribute as a facet in the request (if present).
- replacement_
action This property is required. GoogleCloud Retail V2Rule Replacement Action Response - Replaces specific terms in the query.
- twoway_
synonyms_ action This property is required. GoogleCloud Retail V2Rule Twoway Synonyms Action Response - Treats a set of terms as synonyms of one another.
- boost
Action This property is required. Property Map - A boost action.
- condition
This property is required. Property Map - The condition that triggers the rule. If the condition is empty, the rule will always apply.
- do
Not Associate Action This property is required. Property Map - Prevents term from being associated with other terms.
- filter
Action This property is required. Property Map - Filters results.
- force
Return Facet Action This property is required. Property Map - Force returns an attribute as a facet in the request.
- ignore
Action This property is required. Property Map - Ignores specific terms from query during search.
- oneway
Synonyms Action This property is required. Property Map - Treats specific term as a synonym with a group of terms. Group of terms will not be treated as synonyms with the specific term.
- redirect
Action This property is required. Property Map - Redirects a shopper to a specific page.
- remove
Facet Action This property is required. Property Map - Remove an attribute as a facet in the request (if present).
- replacement
Action This property is required. Property Map - Replaces specific terms in the query.
- twoway
Synonyms Action This property is required. Property Map - Treats a set of terms as synonyms of one another.
GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
- Synonyms
This property is required. List<string> - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
- Synonyms
This property is required. []string - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
- synonyms
This property is required. List<String> - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
- synonyms
This property is required. string[] - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
- synonyms
This property is required. Sequence[str] - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
- synonyms
This property is required. List<String> - Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi