ControlArgs class

The set of arguments for Control. The set of arguments for Control.

Constructors

ControlArgs({required Input<String> catalogId, required Input<String> controlId, required Input<String> displayName, Input<String>? location, Input<String>? name, Input<String>? project, Input<GoogleCloudRetailV2Rule>? rule, Input<List<ControlSearchSolutionUseCaseItem>>? searchSolutionUseCase, required Input<List<ControlSolutionTypesItem>> solutionTypes})

Creates a new ControlArgs. catalogId Required. controlId Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/. 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. location Optional. name Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/* project Optional. 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

ControlArgs.fromMap(Map<String, dynamic> map)

factory

Properties

catalogId → Input<String>

final

controlId → Input<String>

Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

final

displayName → Input<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

hashCode → int

The hash code for this object.

no setter, inherited

location → Input<String>?

final

name → Input<String>?

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

final

project → Input<String>?

final

rule → Input<GoogleCloudRetailV2Rule>?

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 setter, inherited

searchSolutionUseCase → Input<List<ControlSearchSolutionUseCaseItem>>?

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 → Input<List<ControlSolutionTypesItem>>

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