public sealed class WidgetConfig : IMessage<WidgetConfig>, IEquatable<WidgetConfig>, IDeepCloneable<WidgetConfig>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class WidgetConfig.
WidgetConfig captures configs at the Widget level.
Implements
IMessageWidgetConfig, IEquatableWidgetConfig, IDeepCloneableWidgetConfig, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
WidgetConfig()
public WidgetConfig()WidgetConfig(WidgetConfig)
public WidgetConfig(WidgetConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
WidgetConfig |
Properties
AccessSettings
public WidgetConfig.Types.AccessSettings AccessSettings { get; set; }Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesAccessSettings |
|
AssistantSettings
public WidgetConfig.Types.AssistantSettings AssistantSettings { get; set; }Optional. Output only. Describes the assistant settings of the widget.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesAssistantSettings |
|
BatchAuthStatuses
public RepeatedField<WidgetConfig.Types.BatchAuthStatus> BatchAuthStatuses { get; }Output only. The batch authorization statuses for the widget's connectors.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldWidgetConfigTypesBatchAuthStatus |
|
CollectionComponents
public RepeatedField<WidgetConfig.Types.CollectionComponent> CollectionComponents { get; }Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
For SaaS / Business engines, when LookupWidgetConfig is called with
view = WITH_AVAILABLE_CONNECTORS, this list is additionally augmented
with synthetic placeholder entries for connectors the caller may attach
but has not yet attached (see CollectionComponent for the placeholder
contract). The frontend can therefore render a unified list of
already-attached and available-to-attach sources by iterating this single
field. For Enterprise engines and for the default view, only
already-attached connectors are returned (today's behavior).
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldWidgetConfigTypesCollectionComponent |
|
ConfigId
public string ConfigId { get; set; }Output only. Unique obfuscated identifier of a [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig].
| Property Value | |
|---|---|
| Type | Description |
string |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp the [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig] was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
CustomerProvidedConfig
public WidgetConfig.Types.CustomerProvidedConfig CustomerProvidedConfig { get; set; }Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesCustomerProvidedConfig |
|
DataStoreType
public WidgetConfig.Types.DataStoreType DataStoreType { get; set; }Output only. The type of the parent data store.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesDataStoreType |
|
DisplayName
public string DisplayName { get; set; }Required. The human readable widget config display name. Used in Discovery UI.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EnablePrivateKnowledgeGraph
public bool EnablePrivateKnowledgeGraph { get; set; }Optional. Output only. Whether to enable private knowledge graph.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
EnableResultScore
public bool EnableResultScore { get; set; }Whether to show the result score.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
GeminiBundle
public bool GeminiBundle { get; set; }Output only. Whether the subscription is gemini bundle or not.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HomepageSetting
public WidgetConfig.Types.HomepageSetting HomepageSetting { get; set; }Optional. Describes the homepage settings of the widget.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesHomepageSetting |
|
IndustryVertical
public IndustryVertical IndustryVertical { get; set; }Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated [Engine][google.cloud.discoveryengine.v1.Engine].
| Property Value | |
|---|---|
| Type | Description |
IndustryVertical |
|
LlmEnabled
public bool LlmEnabled { get; set; }Output only. Whether LLM is enabled in the corresponding data store.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
MinimumDataTermAccepted
public bool MinimumDataTermAccepted { get; set; }Output only. Whether the customer accepted data use terms.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }Immutable. The full resource name of the widget config.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Nodes
public RepeatedField<WidgetConfig.Types.Node> Nodes { get; }Output only. The nodes associated with the Widget Config.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldWidgetConfigTypesNode |
|
SolutionType
public SolutionType SolutionType { get; set; }Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
| Property Value | |
|---|---|
| Type | Description |
SolutionType |
|
UiBranding
public WidgetConfig.Types.UiBrandingSettings UiBranding { get; set; }Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesUiBrandingSettings |
|
UiSettings
public WidgetConfig.Types.UiSettings UiSettings { get; set; }Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigTypesUiSettings |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp the [WidgetConfig][google.cloud.discoveryengine.v1.WidgetConfig] was updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
WidgetConfigName
public WidgetConfigName WidgetConfigName { get; set; }WidgetConfigName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
WidgetConfigName |
|