Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getControl

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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:retail/v2alpha:getControl
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogId string
ControlId string
Location string
Project string
CatalogId string
ControlId string
Location string
Project string
catalogId String
controlId String
location String
project String
catalogId string
controlId string
location string
project string
catalogId String
controlId String
location String
project String

getControl Result

The following output properties are available:

AssociatedServingConfigIds List<string>

List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

FacetSpec Pulumi.GoogleNative.Retail.V2Alpha.Outputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

Name string

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

Rule Pulumi.GoogleNative.Retail.V2Alpha.Outputs.GoogleCloudRetailV2alphaRuleResponse

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 configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

FacetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

Name string

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

Rule GoogleCloudRetailV2alphaRuleResponse

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 configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

facetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

name String

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

rule GoogleCloudRetailV2alphaRuleResponse

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 configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

facetSpec GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

name string

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

rule GoogleCloudRetailV2alphaRuleResponse

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 configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

facet_spec GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

name str

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

rule GoogleCloudRetailV2alphaRuleResponse

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 configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

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.

facetSpec Property Map

A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.

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

GoogleCloudRetailV2alphaConditionQueryTermResponse

FullMatch bool

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

Value string

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

FullMatch bool

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

Value string

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

fullMatch Boolean

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

value String

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

fullMatch boolean

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

value string

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

full_match bool

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

value str

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

fullMatch Boolean

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

value String

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

GoogleCloudRetailV2alphaConditionResponse

ActiveTimeRange List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionTimeRangeResponse>

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

QueryTerms List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionQueryTermResponse>

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

ActiveTimeRange []GoogleCloudRetailV2alphaConditionTimeRangeResponse

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

QueryTerms []GoogleCloudRetailV2alphaConditionQueryTermResponse

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

activeTimeRange List<GoogleCloudRetailV2alphaConditionTimeRangeResponse>

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

queryTerms List<GoogleCloudRetailV2alphaConditionQueryTermResponse>

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

activeTimeRange GoogleCloudRetailV2alphaConditionTimeRangeResponse[]

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

queryTerms GoogleCloudRetailV2alphaConditionQueryTermResponse[]

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

active_time_range Sequence[GoogleCloudRetailV2alphaConditionTimeRangeResponse]

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

query_terms Sequence[GoogleCloudRetailV2alphaConditionQueryTermResponse]

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

activeTimeRange List<Property Map>

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

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

GoogleCloudRetailV2alphaConditionTimeRangeResponse

EndTime string

End of time range. Range is inclusive.

StartTime string

Start of time range. Range is inclusive.

EndTime string

End of time range. Range is inclusive.

StartTime string

Start of time range. Range is inclusive.

endTime String

End of time range. Range is inclusive.

startTime String

Start of time range. Range is inclusive.

endTime string

End of time range. Range is inclusive.

startTime string

Start of time range. Range is inclusive.

end_time str

End of time range. Range is inclusive.

start_time str

Start of time range. Range is inclusive.

endTime String

End of time range. Range is inclusive.

startTime String

Start of time range. Range is inclusive.

GoogleCloudRetailV2alphaIntervalResponse

ExclusiveMaximum double

Exclusive upper bound.

ExclusiveMinimum double

Exclusive lower bound.

Maximum double

Inclusive upper bound.

Minimum double

Inclusive lower bound.

ExclusiveMaximum float64

Exclusive upper bound.

ExclusiveMinimum float64

Exclusive lower bound.

Maximum float64

Inclusive upper bound.

Minimum float64

Inclusive lower bound.

exclusiveMaximum Double

Exclusive upper bound.

exclusiveMinimum Double

Exclusive lower bound.

maximum Double

Inclusive upper bound.

minimum Double

Inclusive lower bound.

exclusiveMaximum number

Exclusive upper bound.

exclusiveMinimum number

Exclusive lower bound.

maximum number

Inclusive upper bound.

minimum number

Inclusive lower bound.

exclusive_maximum float

Exclusive upper bound.

exclusive_minimum float

Exclusive lower bound.

maximum float

Inclusive upper bound.

minimum float

Inclusive lower bound.

exclusiveMaximum Number

Exclusive upper bound.

exclusiveMinimum Number

Exclusive lower bound.

maximum Number

Inclusive upper bound.

minimum Number

Inclusive lower bound.

GoogleCloudRetailV2alphaRuleBoostActionResponse

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

GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

DoNotAssociateTerms List<string>

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

QueryTerms List<string>

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

Terms List<string>

Will be [deprecated = true] post migration;

DoNotAssociateTerms []string

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

QueryTerms []string

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

Terms []string

Will be [deprecated = true] post migration;

doNotAssociateTerms List<String>

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

queryTerms List<String>

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

terms List<String>

Will be [deprecated = true] post migration;

doNotAssociateTerms string[]

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

queryTerms string[]

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

terms string[]

Will be [deprecated = true] post migration;

do_not_associate_terms Sequence[str]

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

query_terms Sequence[str]

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

terms Sequence[str]

Will be [deprecated = true] post migration;

doNotAssociateTerms List<String>

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

queryTerms List<String>

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

terms List<String>

Will be [deprecated = true] post migration;

GoogleCloudRetailV2alphaRuleFilterActionResponse

Filter string

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

Filter string

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

filter String

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

filter string

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

filter str

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

filter String

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

GoogleCloudRetailV2alphaRuleIgnoreActionResponse

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.

GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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.

GoogleCloudRetailV2alphaRuleRedirectActionResponse

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.

GoogleCloudRetailV2alphaRuleReplacementActionResponse

QueryTerms List<string>

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

ReplacementTerm string

Term that will be used for replacement.

Term string

Will be [deprecated = true] post migration;

QueryTerms []string

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

ReplacementTerm string

Term that will be used for replacement.

Term string

Will be [deprecated = true] post migration;

queryTerms List<String>

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

replacementTerm String

Term that will be used for replacement.

term String

Will be [deprecated = true] post migration;

queryTerms string[]

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

replacementTerm string

Term that will be used for replacement.

term string

Will be [deprecated = true] post migration;

query_terms Sequence[str]

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

replacement_term str

Term that will be used for replacement.

term str

Will be [deprecated = true] post migration;

queryTerms List<String>

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

replacementTerm String

Term that will be used for replacement.

term String

Will be [deprecated = true] post migration;

GoogleCloudRetailV2alphaRuleResponse

BoostAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleBoostActionResponse

A boost action.

Condition Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaConditionResponse

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

DoNotAssociateAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

FilterAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleFilterActionResponse

Filters results.

IgnoreAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleIgnoreActionResponse

Ignores specific terms from query during search.

OnewaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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

RedirectAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleRedirectActionResponse

Redirects a shopper to a specific page.

ReplacementAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleReplacementActionResponse

Replaces specific terms in the query.

TwowaySynonymsAction Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

BoostAction GoogleCloudRetailV2alphaRuleBoostActionResponse

A boost action.

Condition GoogleCloudRetailV2alphaConditionResponse

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

DoNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

FilterAction GoogleCloudRetailV2alphaRuleFilterActionResponse

Filters results.

IgnoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse

Ignores specific terms from query during search.

OnewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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

RedirectAction GoogleCloudRetailV2alphaRuleRedirectActionResponse

Redirects a shopper to a specific page.

ReplacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse

Replaces specific terms in the query.

TwowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boostAction GoogleCloudRetailV2alphaRuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2alphaConditionResponse

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

doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2alphaRuleFilterActionResponse

Filters results.

ignoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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

redirectAction GoogleCloudRetailV2alphaRuleRedirectActionResponse

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boostAction GoogleCloudRetailV2alphaRuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2alphaConditionResponse

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

doNotAssociateAction GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filterAction GoogleCloudRetailV2alphaRuleFilterActionResponse

Filters results.

ignoreAction GoogleCloudRetailV2alphaRuleIgnoreActionResponse

Ignores specific terms from query during search.

onewaySynonymsAction GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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

redirectAction GoogleCloudRetailV2alphaRuleRedirectActionResponse

Redirects a shopper to a specific page.

replacementAction GoogleCloudRetailV2alphaRuleReplacementActionResponse

Replaces specific terms in the query.

twowaySynonymsAction GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boost_action GoogleCloudRetailV2alphaRuleBoostActionResponse

A boost action.

condition GoogleCloudRetailV2alphaConditionResponse

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

do_not_associate_action GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse

Prevents term from being associated with other terms.

filter_action GoogleCloudRetailV2alphaRuleFilterActionResponse

Filters results.

ignore_action GoogleCloudRetailV2alphaRuleIgnoreActionResponse

Ignores specific terms from query during search.

oneway_synonyms_action GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse

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

redirect_action GoogleCloudRetailV2alphaRuleRedirectActionResponse

Redirects a shopper to a specific page.

replacement_action GoogleCloudRetailV2alphaRuleReplacementActionResponse

Replaces specific terms in the query.

twoway_synonyms_action GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

Treats a set of terms as synonyms of one another.

boostAction Property Map

A boost action.

condition Property Map

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

doNotAssociateAction Property Map

Prevents term from being associated with other terms.

filterAction Property Map

Filters results.

ignoreAction Property Map

Ignores specific terms from query during search.

onewaySynonymsAction Property Map

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

redirectAction Property Map

Redirects a shopper to a specific page.

replacementAction Property Map

Replaces specific terms in the query.

twowaySynonymsAction Property Map

Treats a set of terms as synonyms of one another.

GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse

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.

GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

CaseInsensitive bool

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Contains List<string>

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

Intervals List<Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaIntervalResponse>

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

Key string

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

OrderBy string

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

Prefixes List<string>

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

Query string

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

RestrictedValues List<string>

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

ReturnMinMax bool

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

CaseInsensitive bool

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Contains []string

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

Intervals []GoogleCloudRetailV2alphaIntervalResponse

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

Key string

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

OrderBy string

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

Prefixes []string

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

Query string

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

RestrictedValues []string

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

ReturnMinMax bool

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

caseInsensitive Boolean

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

contains List<String>

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

intervals List<GoogleCloudRetailV2alphaIntervalResponse>

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

key String

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

orderBy String

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

prefixes List<String>

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

query String

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

restrictedValues List<String>

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

returnMinMax Boolean

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

caseInsensitive boolean

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

contains string[]

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

intervals GoogleCloudRetailV2alphaIntervalResponse[]

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

key string

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

orderBy string

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

prefixes string[]

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

query string

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

restrictedValues string[]

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

returnMinMax boolean

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

case_insensitive bool

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

contains Sequence[str]

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

intervals Sequence[GoogleCloudRetailV2alphaIntervalResponse]

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

key str

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

order_by str

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

prefixes Sequence[str]

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

query str

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

restricted_values Sequence[str]

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

return_min_max bool

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

caseInsensitive Boolean

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

contains List<String>

Only get facet values that contains the given strings. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the "categories" facet will give only "Women > Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.

intervals List<Property Map>

Set only if values should be bucketized into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

key String

Supported textual and numerical facet keys in Product object, over which the facet values are computed. Facet key is case-sensitive. Allowed facet keys when FacetKey.query is not specified: * textual_field = * "brands" * "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key" * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,price)" * "inventory(place_id,original_price)" * "inventory(place_id,attributes.key)"

orderBy String

The order in which SearchResponse.Facet.values are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are sorted in the order given by FacetSpec.FacetKey.restricted_values.

prefixes List<String>

Only get facet values that start with the given string prefix. For example, suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum is 10.

query String

The query that is used to compute facet for the given facet key. When provided, it will override the default behavior of facet computation. The query syntax is the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Notice that there is no limitation on FacetKey.key when query is specified. In the response, SearchResponse.Facet.values.value will be always "1" and SearchResponse.Facet.values.count will be the number of results that match the query. For example, you can set a customized facet for "shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability: ANY("IN_STOCK") AND shipToStore: ANY("123")". Then the facet will count the products that are both in stock and ship to store "123".

restrictedValues List<String>

Only get facet for the given restricted values. For example, when using "pickupInStore" as key and set restricted values to ["store123", "store456"], only facets for "store123" and "store456" are returned. Only supported on predefined textual fields, custom textual attributes and fulfillments. Maximum is 20. Must be set for the fulfillment facet keys: * pickupInStore * shipToStore * sameDayDelivery * nextDayDelivery * customFulfillment1 * customFulfillment2 * customFulfillment3 * customFulfillment4 * customFulfillment5

returnMinMax Boolean

Returns the min and max value for each numerical facet intervals. Ignored for textual facets.

GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse

EnableDynamicPosition bool

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

ExcludedFilterKeys List<string>

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

FacetKey Pulumi.GoogleNative.Retail.V2Alpha.Inputs.GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

The facet key specification.

Limit int

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

EnableDynamicPosition bool

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

ExcludedFilterKeys []string

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

FacetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

The facet key specification.

Limit int

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

enableDynamicPosition Boolean

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

excludedFilterKeys List<String>

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

The facet key specification.

limit Integer

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

enableDynamicPosition boolean

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

excludedFilterKeys string[]

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

facetKey GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

The facet key specification.

limit number

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

enable_dynamic_position bool

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

excluded_filter_keys Sequence[str]

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

facet_key GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse

The facet key specification.

limit int

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

enableDynamicPosition Boolean

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response will be determined by Google Retail Search. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enable, which will generate a facet 'gender'. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

excludedFilterKeys List<String>

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

facetKey Property Map

The facet key specification.

limit Number

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

Package Details

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