Show / Hide Table of Contents

Class GoogleCloudDiscoveryengineV1Control

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

Inheritance
object
GoogleCloudDiscoveryengineV1Control
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DiscoveryEngine.v1.Data
Assembly: Google.Apis.DiscoveryEngine.v1.dll
Syntax
public class GoogleCloudDiscoveryengineV1Control : IDirectResponseSchema

Properties

AssociatedServingConfigIds

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

Declaration
[JsonProperty("associatedServingConfigIds")]
public virtual IList<string> AssociatedServingConfigIds { get; set; }
Property Value
Type Description
IList<string>

BoostAction

Defines a boost-type control

Declaration
[JsonProperty("boostAction")]
public virtual GoogleCloudDiscoveryengineV1ControlBoostAction BoostAction { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1ControlBoostAction

Conditions

Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

Declaration
[JsonProperty("conditions")]
public virtual IList<GoogleCloudDiscoveryengineV1Condition> Conditions { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1Condition>

DisplayName

Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FilterAction

Defines a filter-type control Currently not supported by Recommendation

Declaration
[JsonProperty("filterAction")]
public virtual GoogleCloudDiscoveryengineV1ControlFilterAction FilterAction { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1ControlFilterAction

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PromoteAction

Promote certain links based on predefined trigger queries.

Declaration
[JsonProperty("promoteAction")]
public virtual GoogleCloudDiscoveryengineV1ControlPromoteAction PromoteAction { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1ControlPromoteAction

RedirectAction

Defines a redirect-type control.

Declaration
[JsonProperty("redirectAction")]
public virtual GoogleCloudDiscoveryengineV1ControlRedirectAction RedirectAction { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1ControlRedirectAction

SolutionType

Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

Declaration
[JsonProperty("solutionType")]
public virtual string SolutionType { get; set; }
Property Value
Type Description
string

SynonymsAction

Treats a group of terms as synonyms of one another.

Declaration
[JsonProperty("synonymsAction")]
public virtual GoogleCloudDiscoveryengineV1ControlSynonymsAction SynonymsAction { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1ControlSynonymsAction

UseCases

Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

Declaration
[JsonProperty("useCases")]
public virtual IList<string> UseCases { get; set; }
Property Value
Type Description
IList<string>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX