1. Packages
  2. Google Cloud Native
  3. API Docs
  4. retail
  5. retail/v2
  6. getControl

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>
Copy
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]
Copy
func LookupControl(ctx *Context, args *LookupControlArgs, opts ...InvokeOption) (*LookupControlResult, error)
func LookupControlOutput(ctx *Context, args *LookupControlOutputArgs, opts ...InvokeOption) LookupControlResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetControlResult> getControl(GetControlArgs args, InvokeOptions options)
public static Output<GetControlResult> getControl(GetControlArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:retail/v2:getControl
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CatalogId This property is required. string
ControlId This property is required. string
Location This property is required. string
Project string
CatalogId This property is required. string
ControlId This property is required. string
Location This property is required. string
Project string
catalogId This property is required. String
controlId This property is required. String
location This property is required. String
project String
catalogId This property is required. string
controlId This property is required. string
location This property is required. string
project string
catalog_id This property is required. str
control_id This property is required. str
location This property is required. str
project str
catalogId This property is required. String
controlId This property is required. String
location This property is required. String
project String

getControl Result

The following output properties are available:

AssociatedServingConfigIds List<string>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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.GoogleNative.Retail.V2.Outputs.GoogleCloudRetailV2RuleResponse
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
SearchSolutionUseCase List<string>
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_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
AssociatedServingConfigIds []string
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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 GoogleCloudRetailV2RuleResponse
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
SearchSolutionUseCase []string
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_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
associatedServingConfigIds List<String>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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 GoogleCloudRetailV2RuleResponse
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
searchSolutionUseCase List<String>
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_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
associatedServingConfigIds string[]
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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 GoogleCloudRetailV2RuleResponse
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
searchSolutionUseCase string[]
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_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
associated_serving_config_ids Sequence[str]
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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 GoogleCloudRetailV2RuleResponse
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
search_solution_use_case Sequence[str]
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.
associatedServingConfigIds List<String>
List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
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".
searchSolutionUseCase List<String>
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_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

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

GoogleCloudRetailV2ConditionResponse

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

GoogleCloudRetailV2ConditionTimeRangeResponse

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

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

GoogleCloudRetailV2RuleDoNotAssociateActionResponse

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

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

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

GoogleCloudRetailV2RuleForceReturnFacetActionResponse

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

GoogleCloudRetailV2RuleIgnoreActionResponse

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

GoogleCloudRetailV2RuleOnewaySynonymsActionResponse

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

GoogleCloudRetailV2RuleRedirectActionResponse

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

GoogleCloudRetailV2RuleRemoveFacetActionResponse

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

GoogleCloudRetailV2RuleReplacementActionResponse

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

GoogleCloudRetailV2RuleResponse

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

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