Google Cloud Discovery Engine V1 Client - Class GetWidgetConfigRequest (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class GetWidgetConfigRequest.

Request for WidgetConfigService.GetWidgetConfig method.

Generated from protobuf message google.cloud.discoveryengine.v1.GetWidgetConfigRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ accept_cache bool

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 GetWidgetConfigRequest\GetWidgetConfigRequestOption

Optional. Options for GetWidgetConfigRequest.

↳ language_code 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 int

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.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAcceptCache

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
Type Description
bool

setAcceptCache

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getGetWidgetConfigRequestOption

Optional. Options for GetWidgetConfigRequest.

Returns
Type Description
GetWidgetConfigRequest\GetWidgetConfigRequestOption|null

hasGetWidgetConfigRequestOption

clearGetWidgetConfigRequestOption

setGetWidgetConfigRequestOption

Optional. Options for GetWidgetConfigRequest.

Parameter
Name Description
var GetWidgetConfigRequest\GetWidgetConfigRequestOption
Returns
Type Description
$this

getLanguageCode

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
Type Description
string

setLanguageCode

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).

Parameter
Name Description
var string
Returns
Type Description
$this

getModelInfoView

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
Type Description
int Enum of type ModelInfoView.

setModelInfoView

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.

Parameter
Name Description
var int

Enum of type ModelInfoView.

Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id} Please see WidgetConfigServiceClient::widgetConfigName() for help formatting this field.

Returns
Type Description
GetWidgetConfigRequest