Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class WidgetConfig.
WidgetConfig captures configs at the Widget level.
Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The full resource name of the widget config. Format: |
↳ display_name |
string
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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp the WidgetConfig was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp the WidgetConfig was updated. |
↳ data_store_type |
int
Output only. The type of the parent data store. |
↳ config_id |
string
Output only. Unique obfuscated identifier of a WidgetConfig. |
↳ solution_type |
int
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
↳ industry_vertical |
int
Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. |
↳ llm_enabled |
bool
Output only. Whether LLM is enabled in the corresponding data store. |
↳ enable_result_score |
bool
Whether to show the result score. |
↳ minimum_data_term_accepted |
bool
Output only. Whether the customer accepted data use terms. |
↳ collection_components |
array<WidgetConfig\CollectionComponent>
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 |
↳ ui_settings |
WidgetConfig\UiSettings
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
↳ access_settings |
WidgetConfig\AccessSettings
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
↳ ui_branding |
WidgetConfig\UiBrandingSettings
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
↳ homepage_setting |
WidgetConfig\HomepageSetting
Optional. Describes the homepage settings of the widget. |
↳ assistant_settings |
WidgetConfig\AssistantSettings
Optional. Output only. Describes the assistant settings of the widget. |
↳ customer_provided_config |
WidgetConfig\CustomerProvidedConfig
Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. |
↳ enable_private_knowledge_graph |
bool
Optional. Output only. Whether to enable private knowledge graph. |
↳ gemini_bundle |
bool
Output only. Whether the subscription is gemini bundle or not. |
↳ batch_auth_statuses |
array<WidgetConfig\BatchAuthStatus>
Output only. The batch authorization statuses for the widget's connectors. |
↳ nodes |
array<WidgetConfig\Node>
Output only. The nodes associated with the Widget Config. |
getName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp the WidgetConfig was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the WidgetConfig was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp the WidgetConfig was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp the WidgetConfig was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDataStoreType
Output only. The type of the parent data store.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type DataStoreType. |
setDataStoreType
Output only. The type of the parent data store.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type DataStoreType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfigId
Output only. Unique obfuscated identifier of a WidgetConfig.
| Returns | |
|---|---|
| Type | Description |
string |
|
setConfigId
Output only. Unique obfuscated identifier of a WidgetConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSolutionType
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SolutionType. |
setSolutionType
Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SolutionType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIndustryVertical
Output only. The industry vertical that the WidgetConfig registers.
The WidgetConfig industry vertical is based on the associated Engine.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type IndustryVertical. |
setIndustryVertical
Output only. The industry vertical that the WidgetConfig registers.
The WidgetConfig industry vertical is based on the associated Engine.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type IndustryVertical. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLlmEnabled
Output only. Whether LLM is enabled in the corresponding data store.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setLlmEnabled
Output only. Whether LLM is enabled in the corresponding data store.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnableResultScore
Whether to show the result score.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnableResultScore
Whether to show the result score.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinimumDataTermAccepted
Output only. Whether the customer accepted data use terms.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setMinimumDataTermAccepted
Output only. Whether the customer accepted data use terms.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollectionComponents
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).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<WidgetConfig\CollectionComponent> |
|
setCollectionComponents
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).
| Parameter | |
|---|---|
| Name | Description |
var |
array<WidgetConfig\CollectionComponent>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUiSettings
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\UiSettings|null |
|
hasUiSettings
clearUiSettings
setUiSettings
Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\UiSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessSettings
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\AccessSettings|null |
|
hasAccessSettings
clearAccessSettings
setAccessSettings
Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\AccessSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUiBranding
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\UiBrandingSettings|null |
|
hasUiBranding
clearUiBranding
setUiBranding
Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\UiBrandingSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHomepageSetting
Optional. Describes the homepage settings of the widget.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\HomepageSetting|null |
|
hasHomepageSetting
clearHomepageSetting
setHomepageSetting
Optional. Describes the homepage settings of the widget.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\HomepageSetting
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssistantSettings
Optional. Output only. Describes the assistant settings of the widget.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\AssistantSettings|null |
|
hasAssistantSettings
clearAssistantSettings
setAssistantSettings
Optional. Output only. Describes the assistant settings of the widget.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\AssistantSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomerProvidedConfig
Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
| Returns | |
|---|---|
| Type | Description |
WidgetConfig\CustomerProvidedConfig|null |
|
hasCustomerProvidedConfig
clearCustomerProvidedConfig
setCustomerProvidedConfig
Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
| Parameter | |
|---|---|
| Name | Description |
var |
WidgetConfig\CustomerProvidedConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnablePrivateKnowledgeGraph
Optional. Output only. Whether to enable private knowledge graph.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnablePrivateKnowledgeGraph
Optional. Output only. Whether to enable private knowledge graph.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGeminiBundle
Output only. Whether the subscription is gemini bundle or not.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setGeminiBundle
Output only. Whether the subscription is gemini bundle or not.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBatchAuthStatuses
Output only. The batch authorization statuses for the widget's connectors.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<WidgetConfig\BatchAuthStatus> |
|
setBatchAuthStatuses
Output only. The batch authorization statuses for the widget's connectors.
| Parameter | |
|---|---|
| Name | Description |
var |
array<WidgetConfig\BatchAuthStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodes
Output only. The nodes associated with the Widget Config.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<WidgetConfig\Node> |
|
setNodes
Output only. The nodes associated with the Widget Config.
| Parameter | |
|---|---|
| Name | Description |
var |
array<WidgetConfig\Node>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|