pulumi-google-native-kotlin/com.pulumi.googlenative.retail.v2.kotlin/ControlArgs

ControlArgs

data class ControlArgs(val catalogId: Output<String>? = null, val controlId: Output<String>? = null, val displayName: Output<String>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val rule: Output<GoogleCloudRetailV2RuleArgs>? = null, val searchSolutionUseCase: Output<List<ControlSearchSolutionUseCaseItem>>? = null, val solutionTypes: Output<List<ControlSolutionTypesItem>>? = null) : ConvertibleToJava<ControlArgs>

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.

Constructors

ControlArgs

constructor(catalogId: Output<String>? = null, controlId: Output<String>? = null, displayName: Output<String>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, rule: Output<GoogleCloudRetailV2RuleArgs>? = null, searchSolutionUseCase: Output<List<ControlSearchSolutionUseCaseItem>>? = null, solutionTypes: Output<List<ControlSolutionTypesItem>>? = null)

Properties

catalogId

val catalogId: Output<String>? = null

controlId

val controlId: Output<String>? = null

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

val displayName: Output<String>? = null

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

val location: Output<String>? = null

name

val name: Output<String>? = null

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

project

val project: Output<String>? = null

rule

val rule: Output<GoogleCloudRetailV2RuleArgs>? = null

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

val searchSolutionUseCase: Output<List<ControlSearchSolutionUseCaseItem>>? = null

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

val solutionTypes: Output<List<ControlSolutionTypesItem>>? = null

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. //*/

Functions

toJava

open override fun toJava(): ControlArgs