ControlArgs class

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

Constructors

ControlArgs({Input<ControlBoostAction?>? boostAction, Input<String?>? collectionId, Input<List<ControlCondition>?>? conditions, required Input<String> controlId, Input<String?>? deletionPolicy, required Input<String> displayName, required Input<String> engineId, Input<ControlFilterAction?>? filterAction, required Input<String> location, Input<String?>? project, Input<ControlPromoteAction?>? promoteAction, Input<ControlRedirectAction?>? redirectAction, required Input<String> solutionType, Input<ControlSynonymsAction?>? synonymsAction, Input<List<String>?>? useCases})

Creates a new ControlArgs. boostAction Changes the returned order of results. collectionId The collection ID. Currently only accepts "defaultCollection". conditions The conditions under which the control is active. controlId The unique id of the control. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName The display name of the control. This field must be a UTF-8 encoded engineId The engine to add the control to. filterAction Removes entries from returned results. location The geographic location where the data store should reside. The value can project The ID of the project in which the resource belongs. promoteAction Promotes a specified link for a query. redirectAction Redirects to a specified URI. solutionType The solution type that the control belongs to. synonymsAction Associates queries with each other. useCases The use cases that the control is used for.

const

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

factory

Properties

boostAction → Input<ControlBoostAction?>?

Changes the returned order of results. Structure is documented below.

final

collectionId → Input<String?>?

The collection ID. Currently only accepts "defaultCollection".

final

conditions → Input<List<ControlCondition>?>?

The conditions under which the control is active. Structure is documented below.

final

controlId → Input<String>

The unique id of the control.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

displayName → Input<String>

The display name of the control. This field must be a UTF-8 encoded string with a length limit of 128 characters.

final

engineId → Input<String>

The engine to add the control to.

final

filterAction → Input<ControlFilterAction?>?

Removes entries from returned results. Structure is documented below.

final

hashCode → int

The hash code for this object.

no setter, inherited

location → Input<String>

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

final

project → Input<String?>?

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

final

promoteAction → Input<ControlPromoteAction?>?

Promotes a specified link for a query. Structure is documented below.

final

redirectAction → Input<ControlRedirectAction?>?

Redirects to a specified URI. Structure is documented below.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

solutionType → Input<String>

The solution type that the control belongs to. Possible values are: SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT.

final

synonymsAction → Input<ControlSynonymsAction?>?

Associates queries with each other. Structure is documented below.

final

useCases → Input<List<String>?>?

The use cases that the control is used for. Each value may be one of: SEARCH_USE_CASE_SEARCH, SEARCH_USE_CASE_BROWSE.

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