Package-level declarations

Types

Link copied to clipboard
data class GetControlPlainArgs(val catalogId: String, val controlId: String, val location: String, val project: String? = null) : ConvertibleToJava<GetControlPlainArgs>
Link copied to clipboard
data class GetModelPlainArgs(val catalogId: String, val location: String, val modelId: String, val project: String? = null) : ConvertibleToJava<GetModelPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetProductPlainArgs(val branchId: String, val catalogId: String, val location: String, val productId: String, val project: String? = null) : ConvertibleToJava<GetProductPlainArgs>
Link copied to clipboard
data class GetServingConfigPlainArgs(val catalogId: String, val location: String, val project: String? = null, val servingConfigId: String) : ConvertibleToJava<GetServingConfigPlainArgs>
Link copied to clipboard
data class GoogleCloudRetailV2alphaAudienceArgs(val ageGroups: Output<List<String>>? = null, val genders: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaAudienceArgs>

An intended audience of the Product for whom it's sold.

Link copied to clipboard
data class GoogleCloudRetailV2alphaColorInfoArgs(val colorFamilies: Output<List<String>>? = null, val colors: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaColorInfoArgs>

The color information of a Product.

Link copied to clipboard
data class GoogleCloudRetailV2alphaConditionArgs(val activeTimeRange: Output<List<GoogleCloudRetailV2alphaConditionTimeRangeArgs>>? = null, val queryTerms: Output<List<GoogleCloudRetailV2alphaConditionQueryTermArgs>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaConditionArgs>

Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

data class GoogleCloudRetailV2alphaConditionQueryTermArgs(val fullMatch: Output<Boolean>? = null, val value: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaConditionQueryTermArgs>

Query terms that we want to match on.

data class GoogleCloudRetailV2alphaConditionTimeRangeArgs(val endTime: Output<String>? = null, val startTime: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaConditionTimeRangeArgs>

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

data class GoogleCloudRetailV2alphaFulfillmentInfoArgs(val placeIds: Output<List<String>>? = null, val type: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaFulfillmentInfoArgs>

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

Link copied to clipboard
data class GoogleCloudRetailV2alphaImageArgs(val height: Output<Int>? = null, val uri: Output<String>, val width: Output<Int>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaImageArgs>

Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

Link copied to clipboard
data class GoogleCloudRetailV2alphaIntervalArgs(val exclusiveMaximum: Output<Double>? = null, val exclusiveMinimum: Output<Double>? = null, val maximum: Output<Double>? = null, val minimum: Output<Double>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaIntervalArgs>

A floating point interval.

data class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigArgs(val contextProductsType: Output<GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigContextProductsType>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigArgs>

Additional configs for the frequently-bought-together model type.

data class GoogleCloudRetailV2alphaModelModelFeaturesConfigArgs(val frequentlyBoughtTogetherConfig: Output<GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigArgs>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaModelModelFeaturesConfigArgs>

Additional model features config.

data class GoogleCloudRetailV2alphaModelPageOptimizationConfigArgs(val pageOptimizationEventType: Output<String>, val panels: Output<List<GoogleCloudRetailV2alphaModelPageOptimizationConfigPanelArgs>>, val restriction: Output<GoogleCloudRetailV2alphaModelPageOptimizationConfigRestriction>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaModelPageOptimizationConfigArgs>

The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.

data class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateArgs(val servingConfigId: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateArgs>

A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.

data class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanelArgs(val candidates: Output<List<GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateArgs>>, val defaultCandidate: Output<GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateArgs>, val displayName: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaModelPageOptimizationConfigPanelArgs>

An individual panel with a list of ServingConfigs to consider for it.

Link copied to clipboard
data class GoogleCloudRetailV2alphaPriceInfoArgs(val cost: Output<Double>? = null, val currencyCode: Output<String>? = null, val originalPrice: Output<Double>? = null, val price: Output<Double>? = null, val priceEffectiveTime: Output<String>? = null, val priceExpireTime: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaPriceInfoArgs>

The price information of a Product.

Link copied to clipboard
data class GoogleCloudRetailV2alphaPromotionArgs(val promotionId: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaPromotionArgs>

Promotion specification.

Link copied to clipboard
data class GoogleCloudRetailV2alphaRatingArgs(val averageRating: Output<Double>? = null, val ratingCount: Output<Int>? = null, val ratingHistogram: Output<List<Int>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRatingArgs>

The rating of a Product.

Link copied to clipboard
data class GoogleCloudRetailV2alphaRuleArgs(val boostAction: Output<GoogleCloudRetailV2alphaRuleBoostActionArgs>? = null, val condition: Output<GoogleCloudRetailV2alphaConditionArgs>, val doNotAssociateAction: Output<GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs>? = null, val filterAction: Output<GoogleCloudRetailV2alphaRuleFilterActionArgs>? = null, val ignoreAction: Output<GoogleCloudRetailV2alphaRuleIgnoreActionArgs>? = null, val onewaySynonymsAction: Output<GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs>? = null, val redirectAction: Output<GoogleCloudRetailV2alphaRuleRedirectActionArgs>? = null, val replacementAction: Output<GoogleCloudRetailV2alphaRuleReplacementActionArgs>? = null, val twowaySynonymsAction: Output<GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleArgs>

A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.

data class GoogleCloudRetailV2alphaRuleBoostActionArgs(val boost: Output<Double>? = null, val productsFilter: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleBoostActionArgs>

A boost action to apply to results matching condition specified above.

data class GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs(val doNotAssociateTerms: Output<List<String>>? = null, val queryTerms: Output<List<String>>? = null, val terms: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleDoNotAssociateActionArgs>

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

data class GoogleCloudRetailV2alphaRuleFilterActionArgs(val filter: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleFilterActionArgs>
data class GoogleCloudRetailV2alphaRuleIgnoreActionArgs(val ignoreTerms: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleIgnoreActionArgs>

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

data class GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs(val onewayTerms: Output<List<String>>? = null, val queryTerms: Output<List<String>>? = null, val synonyms: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleOnewaySynonymsActionArgs>

Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".

data class GoogleCloudRetailV2alphaRuleRedirectActionArgs(val redirectUri: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleRedirectActionArgs>

Redirects a shopper to a specific page. * Rule Condition: - Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.

data class GoogleCloudRetailV2alphaRuleReplacementActionArgs(val queryTerms: Output<List<String>>? = null, val replacementTerm: Output<String>? = null, val term: Output<String>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleReplacementActionArgs>

Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".

data class GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs(val synonyms: Output<List<String>>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaRuleTwowaySynonymsActionArgs>

Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".

data class GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecArgs(val mode: Output<GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecMode>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecArgs>

The specifications of dynamically generated facets.

data class GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs(val enableDynamicPosition: Output<Boolean>? = null, val excludedFilterKeys: Output<List<String>>? = null, val facetKey: Output<GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs>, val limit: Output<Int>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaSearchRequestFacetSpecArgs>

A facet specification to perform faceted search.

data class GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs(val caseInsensitive: Output<Boolean>? = null, val contains: Output<List<String>>? = null, val intervals: Output<List<GoogleCloudRetailV2alphaIntervalArgs>>? = null, val key: Output<String>, val orderBy: Output<String>? = null, val prefixes: Output<List<String>>? = null, val query: Output<String>? = null, val restrictedValues: Output<List<String>>? = null, val returnMinMax: Output<Boolean>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyArgs>

Specifies how a facet is computed.

data class GoogleCloudRetailV2alphaSearchRequestPersonalizationSpecArgs(val mode: Output<GoogleCloudRetailV2alphaSearchRequestPersonalizationSpecMode>? = null) : ConvertibleToJava<GoogleCloudRetailV2alphaSearchRequestPersonalizationSpecArgs>

The specification for personalization.