GetControlRetailV2alphaResult class - retail library

Constructors

GetControlRetailV2alphaResult({required List<String> associatedServingConfigIds, required String displayName, required GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse facetSpec, required String name, required GoogleCloudRetailV2alphaRuleResponse rule, required List<String> searchSolutionUseCase, required List<String> solutionTypes}): Creates a new GetControlRetailV2alphaResult. associatedServingConfigIds List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view. displayName 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 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 Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/* rule 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 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 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.
const
GetControlRetailV2alphaResult.fromMap(Map<String, dynamic> map): factory

Properties

associatedServingConfigIds → List<String>: List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
final
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.
final
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.
final
hashCode → int: The hash code for this object.
no setterinherited
name → String: Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
final
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".
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
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.
final
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited