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 dictionaryThe following arguments are supported:
- catalog_id str
- control_id str
- location str
- project str
getControl Result
The following output properties are available:
- AssociatedServing 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.
- 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.
- 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".
- SearchSolution 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.
- SolutionTypes 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_SEARCHvalue is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
- AssociatedServing []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.
- 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.
- Name string
- Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
- Rule
GoogleCloud 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".
- SearchSolution []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.
- SolutionTypes []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_SEARCHvalue is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
- associatedServing 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.
- 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.
- name String
- Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
- rule
GoogleCloud 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".
- searchSolution 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.
- solutionTypes 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_SEARCHvalue is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
- associatedServing 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.
- 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.
- name string
- Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
- rule
GoogleCloud 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".
- searchSolution 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.
- solutionTypes 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_SEARCHvalue 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
GoogleCloud 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_SEARCHvalue is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
- associatedServing 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.
- 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.
- 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".
- searchSolution 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.
- solutionTypes 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_SEARCHvalue is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
Supporting Types
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    
- ActiveTime List<Pulumi.Range 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.
- PageCategories List<string>
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- QueryTerms List<Pulumi.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).
- ActiveTime []GoogleRange Cloud Retail V2Condition Time Range Response 
- Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- PageCategories []string
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- QueryTerms []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).
- activeTime List<GoogleRange Cloud Retail V2Condition Time Range Response> 
- Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- pageCategories List<String>
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- queryTerms List<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).
- activeTime GoogleRange Cloud Retail V2Condition Time Range Response[] 
- Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- pageCategories string[]
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- queryTerms 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_ Sequence[Googlerange Cloud Retail V2Condition Time Range Response] 
- Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- page_categories Sequence[str]
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- query_terms Sequence[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).
- activeTime List<Property Map>Range 
- Range of time(s) specifying when Condition is active. Condition true if any time range matches.
- pageCategories List<String>
- Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;
- queryTerms List<Property Map>
- A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
GoogleCloudRetailV2ConditionTimeRangeResponse      
- end_time str
- End of time range. Range is inclusive.
- start_time str
- Start of time range. Range is inclusive.
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")) *
GoogleCloudRetailV2RuleDoNotAssociateActionResponse        
- DoNot List<string>Associate Terms 
- 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;
- DoNot []stringAssociate Terms 
- 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;
- doNot List<String>Associate Terms 
- 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;
- doNot string[]Associate Terms 
- 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_ Sequence[str]associate_ terms 
- 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;
- doNot List<String>Associate Terms 
- 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;
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. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- Filter string
- A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter String
- A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter string
- A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter str
- A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
- filter String
- A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see Filter. * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse           
- AttributeName string
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- Position int
- This is the position in the request as explained above. It should be strictly positive be at most 100.
- AttributeName string
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- Position int
- This is the position in the request as explained above. It should be strictly positive be at most 100.
- attributeName String
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position Integer
- This is the position in the request as explained above. It should be strictly positive be at most 100.
- attributeName string
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position number
- This is the position in the request as explained above. It should be strictly positive be at most 100.
- attribute_name str
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position int
- This is the position in the request as explained above. It should be strictly positive be at most 100.
- attributeName String
- The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.
- position Number
- This is the position in the request as explained above. It should be strictly positive be at most 100.
GoogleCloudRetailV2RuleForceReturnFacetActionResponse        
- FacetPosition List<Pulumi.Adjustments 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.
- FacetPosition []GoogleAdjustments 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.
- facetPosition List<GoogleAdjustments 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.
- facetPosition GoogleAdjustments 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_ Sequence[Googleadjustments 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.
- facetPosition List<Property Map>Adjustments 
- Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.
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.
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.
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.
GoogleCloudRetailV2RuleRemoveFacetActionResponse       
- AttributeNames List<string>
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- AttributeNames []string
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attributeNames List<String>
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attributeNames string[]
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attribute_names Sequence[str]
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
- attributeNames List<String>
- The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.
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.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Boost Action Response 
- A boost action.
- Condition
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.
- DoNot Pulumi.Associate Action Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Do Not Associate Action Response 
- Prevents term from being associated with other terms.
- FilterAction Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Filter Action Response 
- Filters results.
- ForceReturn Pulumi.Facet Action Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Force Return Facet Action Response 
- Force returns an attribute as a facet in the request.
- IgnoreAction Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Ignore Action Response 
- Ignores specific terms from query during search.
- OnewaySynonyms Pulumi.Action 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.
- RedirectAction Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Redirect Action Response 
- Redirects a shopper to a specific page.
- RemoveFacet Pulumi.Action Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Remove Facet Action Response 
- Remove an attribute as a facet in the request (if present).
- ReplacementAction Pulumi.Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Replacement Action Response 
- Replaces specific terms in the query.
- TwowaySynonyms Pulumi.Action Google Native. Retail. V2. Inputs. Google Cloud Retail V2Rule Twoway Synonyms Action Response 
- Treats a set of terms as synonyms of one another.
- BoostAction GoogleCloud Retail V2Rule Boost Action Response 
- A boost action.
- Condition
GoogleCloud Retail V2Condition Response 
- The condition that triggers the rule. If the condition is empty, the rule will always apply.
- DoNot GoogleAssociate Action Cloud Retail V2Rule Do Not Associate Action Response 
- Prevents term from being associated with other terms.
- FilterAction GoogleCloud Retail V2Rule Filter Action Response 
- Filters results.
- ForceReturn GoogleFacet Action Cloud Retail V2Rule Force Return Facet Action Response 
- Force returns an attribute as a facet in the request.
- IgnoreAction GoogleCloud Retail V2Rule Ignore Action Response 
- Ignores specific terms from query during search.
- OnewaySynonyms GoogleAction 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.
- RedirectAction GoogleCloud Retail V2Rule Redirect Action Response 
- Redirects a shopper to a specific page.
- RemoveFacet GoogleAction Cloud Retail V2Rule Remove Facet Action Response 
- Remove an attribute as a facet in the request (if present).
- ReplacementAction GoogleCloud Retail V2Rule Replacement Action Response 
- Replaces specific terms in the query.
- TwowaySynonyms GoogleAction Cloud Retail V2Rule Twoway Synonyms Action Response 
- Treats a set of terms as synonyms of one another.
- boostAction GoogleCloud Retail V2Rule Boost Action Response 
- A boost action.
- condition
GoogleCloud Retail V2Condition Response 
- The condition that triggers the rule. If the condition is empty, the rule will always apply.
- doNot GoogleAssociate Action Cloud Retail V2Rule Do Not Associate Action Response 
- Prevents term from being associated with other terms.
- filterAction GoogleCloud Retail V2Rule Filter Action Response 
- Filters results.
- forceReturn GoogleFacet Action Cloud Retail V2Rule Force Return Facet Action Response 
- Force returns an attribute as a facet in the request.
- ignoreAction GoogleCloud Retail V2Rule Ignore Action Response 
- Ignores specific terms from query during search.
- onewaySynonyms GoogleAction 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.
- redirectAction GoogleCloud Retail V2Rule Redirect Action Response 
- Redirects a shopper to a specific page.
- removeFacet GoogleAction Cloud Retail V2Rule Remove Facet Action Response 
- Remove an attribute as a facet in the request (if present).
- replacementAction GoogleCloud Retail V2Rule Replacement Action Response 
- Replaces specific terms in the query.
- twowaySynonyms GoogleAction Cloud Retail V2Rule Twoway Synonyms Action Response 
- Treats a set of terms as synonyms of one another.
- boostAction GoogleCloud Retail V2Rule Boost Action Response 
- A boost action.
- condition
GoogleCloud Retail V2Condition Response 
- The condition that triggers the rule. If the condition is empty, the rule will always apply.
- doNot GoogleAssociate Action Cloud Retail V2Rule Do Not Associate Action Response 
- Prevents term from being associated with other terms.
- filterAction GoogleCloud Retail V2Rule Filter Action Response 
- Filters results.
- forceReturn GoogleFacet Action Cloud Retail V2Rule Force Return Facet Action Response 
- Force returns an attribute as a facet in the request.
- ignoreAction GoogleCloud Retail V2Rule Ignore Action Response 
- Ignores specific terms from query during search.
- onewaySynonyms GoogleAction 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.
- redirectAction GoogleCloud Retail V2Rule Redirect Action Response 
- Redirects a shopper to a specific page.
- removeFacet GoogleAction Cloud Retail V2Rule Remove Facet Action Response 
- Remove an attribute as a facet in the request (if present).
- replacementAction GoogleCloud Retail V2Rule Replacement Action Response 
- Replaces specific terms in the query.
- twowaySynonyms GoogleAction Cloud Retail V2Rule Twoway Synonyms Action Response 
- Treats a set of terms as synonyms of one another.
- boost_action GoogleCloud Retail V2Rule Boost Action Response 
- A boost action.
- condition
GoogleCloud Retail V2Condition Response 
- The condition that triggers the rule. If the condition is empty, the rule will always apply.
- do_not_ Googleassociate_ action Cloud Retail V2Rule Do Not Associate Action Response 
- Prevents term from being associated with other terms.
- filter_action GoogleCloud Retail V2Rule Filter Action Response 
- Filters results.
- force_return_ Googlefacet_ action Cloud Retail V2Rule Force Return Facet Action Response 
- Force returns an attribute as a facet in the request.
- ignore_action GoogleCloud Retail V2Rule Ignore Action Response 
- Ignores specific terms from query during search.
- oneway_synonyms_ Googleaction 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 GoogleCloud Retail V2Rule Redirect Action Response 
- Redirects a shopper to a specific page.
- remove_facet_ Googleaction Cloud Retail V2Rule Remove Facet Action Response 
- Remove an attribute as a facet in the request (if present).
- replacement_action GoogleCloud Retail V2Rule Replacement Action Response 
- Replaces specific terms in the query.
- twoway_synonyms_ Googleaction Cloud Retail V2Rule Twoway Synonyms Action Response 
- 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.
- doNot Property MapAssociate Action 
- Prevents term from being associated with other terms.
- filterAction Property Map
- Filters results.
- forceReturn Property MapFacet Action 
- Force returns an attribute as a facet in the request.
- ignoreAction Property Map
- Ignores specific terms from query during search.
- onewaySynonyms Property MapAction 
- 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.
- removeFacet Property MapAction 
- Remove an attribute as a facet in the request (if present).
- replacementAction Property Map
- Replaces specific terms in the query.
- twowaySynonyms Property MapAction 
- Treats a set of terms as synonyms of one another.
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
- 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