Discovery Engine v1 API - Class GetWidgetConfigRequest (1.17.0)

public sealed class GetWidgetConfigRequest : IMessage<GetWidgetConfigRequest>, IEquatable<GetWidgetConfigRequest>, IDeepCloneable<GetWidgetConfigRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class GetWidgetConfigRequest.

Request for [WidgetConfigService.GetWidgetConfig][google.cloud.discoveryengine.v1.WidgetConfigService.GetWidgetConfig] method.

Inheritance

object > GetWidgetConfigRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

GetWidgetConfigRequest()

public GetWidgetConfigRequest()

GetWidgetConfigRequest(GetWidgetConfigRequest)

public GetWidgetConfigRequest(GetWidgetConfigRequest other)
Parameter
Name Description
other GetWidgetConfigRequest

Properties

AcceptCache

public bool AcceptCache { get; set; }

Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.

Property Value
Type Description
bool

GetWidgetConfigRequestOption

public GetWidgetConfigRequest.Types.GetWidgetConfigRequestOption GetWidgetConfigRequestOption { get; set; }

Optional. Options for GetWidgetConfigRequest.

Property Value
Type Description
GetWidgetConfigRequestTypesGetWidgetConfigRequestOption

LanguageCode

public string LanguageCode { get; set; }

Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector display_name / description on WidgetConfig.UiSettings.ModelConfigInfo. Empty / unset falls back to the default language (English).

Property Value
Type Description
string

ModelInfoView

public ModelInfoView ModelInfoView { get; set; }

Optional. Selects which view of WidgetConfig.UiSettings.ModelConfigInfo the backend computes. ADMIN is set by the Cloud Console admin "Feature Management" page to receive the admin-surfaced model set with ResolvedModel.admin_view populated; END_USER_MOBILE is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / END_USER_WEB returns the end-user web selector.

Property Value
Type Description
ModelInfoView

Name

public string Name { get; set; }

Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}

Property Value
Type Description
string

WidgetConfigName

public WidgetConfigName WidgetConfigName { get; set; }

WidgetConfigName-typed view over the Name resource name property.

Property Value
Type Description
WidgetConfigName