Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::GetWidgetConfigRequest (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::GetWidgetConfigRequest.

Request for WidgetConfigService.GetWidgetConfig method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accept_cache

def accept_cache() -> ::Boolean
Returns
  • (::Boolean) — 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.

#accept_cache=

def accept_cache=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#get_widget_config_request_option

def get_widget_config_request_option() -> ::Google::Cloud::DiscoveryEngine::V1::GetWidgetConfigRequest::GetWidgetConfigRequestOption
Returns

#get_widget_config_request_option=

def get_widget_config_request_option=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GetWidgetConfigRequest::GetWidgetConfigRequestOption
Parameter
Returns

#language_code

def language_code() -> ::String
Returns
  • (::String) — 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).

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::String) — 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).
Returns
  • (::String) — 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).

#model_info_view

def model_info_view() -> ::Google::Cloud::DiscoveryEngine::V1::ModelInfoView
Returns
  • (::Google::Cloud::DiscoveryEngine::V1::ModelInfoView) — 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.

#model_info_view=

def model_info_view=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ModelInfoView
Parameter
  • value (::Google::Cloud::DiscoveryEngine::V1::ModelInfoView) — 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.
Returns
  • (::Google::Cloud::DiscoveryEngine::V1::ModelInfoView) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}
Returns
  • (::String) — Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}