GoogleCloudDiscoveryengineV1WidgetConfig (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1WidgetConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1WidgetConfig
extends com.google.api.client.json.GenericJson
```
WidgetConfig captures configs at the Widget level.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1WidgetConfig()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1WidgetConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1WidgetConfig`	`clone()`
`GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings`	`getAccessSettings()` Will be used for all widget access settings seen in cloud console integration page.
`List<String>`	`getAllowlistedDomains()` Allowlisted domains that can load this widget.
`Boolean`	`getAllowPublicAccess()` Whether allow no-auth integration with widget.
`GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings`	`getAssistantSettings()` Optional.
`List<GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent>`	`getCollectionComponents()` Output only.
`String`	`getConfigId()` Output only.
`GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec`	`getContentSearchSpec()` The content search spec that configs the desired behavior of content search.
`String`	`getCreateTime()` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig`	`getCustomerProvidedConfig()` Optional.
`String`	`getDataStoreType()` Output only.
`List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig>`	`getDataStoreUiConfigs()` Configurable UI configurations per data store.
`String`	`getDefaultSearchRequestOrderBy()` The default ordering for search results if specified.
`String`	`getDisplayName()` Required.
`Boolean`	`getEnableAutocomplete()` Whether or not to enable autocomplete.
`Boolean`	`getEnableConversationalSearch()` Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
`Boolean`	`getEnablePrivateKnowledgeGraph()` Optional.
`Boolean`	`getEnableQualityFeedback()` Turn on or off collecting the search result quality feedback from end users.
`Boolean`	`getEnableResultScore()` Whether to show the result score.
`Boolean`	`getEnableSafeSearch()` Whether to enable safe search.
`Boolean`	`getEnableSearchAsYouType()` Whether to enable search-as-you-type behavior for the search widget
`Boolean`	`getEnableSnippetResultSummary()` Turn on or off summary for each snippets result.
`Boolean`	`getEnableSummarization()` Turn on or off summarization for the search response.
`Boolean`	`getEnableWebApp()` Whether to enable standalone web app.
`List<GoogleCloudDiscoveryengineV1WidgetConfigFacetField>`	`getFacetField()` The configuration and appearance of facets in the end user view.
`Map<String,GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField>`	`getFieldsUiComponentsMap()` The key is the UI component.
`Boolean`	`getGeminiBundle()` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting`	`getHomepageSetting()` Optional.
`String`	`getIndustryVertical()` Output only.
`Boolean`	`getLlmEnabled()` Output only.
`Boolean`	`getMinimumDataTermAccepted()` Output only.
`String`	`getName()` Immutable.
`List<GoogleCloudDiscoveryengineV1WidgetConfigNode>`	`getNodes()` Output only.
`String`	`getResultDisplayType()` The type of snippet to display in UCS widget.
`String`	`getSolutionType()` Required.
`GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings`	`getUiBranding()` Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
`GoogleCloudDiscoveryengineV1WidgetConfigUiSettings`	`getUiSettings()` Describes general widget search settings as seen in cloud console widget configuration page.
`String`	`getUpdateTime()` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setAccessSettings(GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings accessSettings)` Will be used for all widget access settings seen in cloud console integration page.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setAllowlistedDomains(List<String> allowlistedDomains)` Allowlisted domains that can load this widget.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setAllowPublicAccess(Boolean allowPublicAccess)` Whether allow no-auth integration with widget.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setAssistantSettings(GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings assistantSettings)` Optional.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setCollectionComponents(List<GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent> collectionComponents)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setConfigId(String configId)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setContentSearchSpec(GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec contentSearchSpec)` The content search spec that configs the desired behavior of content search.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setCustomerProvidedConfig(GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig customerProvidedConfig)` Optional.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setDataStoreType(String dataStoreType)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setDataStoreUiConfigs(List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> dataStoreUiConfigs)` Configurable UI configurations per data store.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setDefaultSearchRequestOrderBy(String defaultSearchRequestOrderBy)` The default ordering for search results if specified.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableAutocomplete(Boolean enableAutocomplete)` Whether or not to enable autocomplete.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableConversationalSearch(Boolean enableConversationalSearch)` Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnablePrivateKnowledgeGraph(Boolean enablePrivateKnowledgeGraph)` Optional.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableQualityFeedback(Boolean enableQualityFeedback)` Turn on or off collecting the search result quality feedback from end users.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableResultScore(Boolean enableResultScore)` Whether to show the result score.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableSafeSearch(Boolean enableSafeSearch)` Whether to enable safe search.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableSearchAsYouType(Boolean enableSearchAsYouType)` Whether to enable search-as-you-type behavior for the search widget
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableSnippetResultSummary(Boolean enableSnippetResultSummary)` Turn on or off summary for each snippets result.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableSummarization(Boolean enableSummarization)` Turn on or off summarization for the search response.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setEnableWebApp(Boolean enableWebApp)` Whether to enable standalone web app.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setFacetField(List<GoogleCloudDiscoveryengineV1WidgetConfigFacetField> facetField)` The configuration and appearance of facets in the end user view.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setFieldsUiComponentsMap(Map<String,GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField> fieldsUiComponentsMap)` The key is the UI component.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setGeminiBundle(Boolean geminiBundle)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setHomepageSetting(GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting homepageSetting)` Optional.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setIndustryVertical(String industryVertical)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setLlmEnabled(Boolean llmEnabled)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setMinimumDataTermAccepted(Boolean minimumDataTermAccepted)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setNodes(List<GoogleCloudDiscoveryengineV1WidgetConfigNode> nodes)` Output only.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setResultDisplayType(String resultDisplayType)` The type of snippet to display in UCS widget.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setSolutionType(String solutionType)` Required.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setUiBranding(GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings uiBranding)` Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setUiSettings(GoogleCloudDiscoveryengineV1WidgetConfigUiSettings uiSettings)` Describes general widget search settings as seen in cloud console widget configuration page.
`GoogleCloudDiscoveryengineV1WidgetConfig`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1WidgetConfig
```
public GoogleCloudDiscoveryengineV1WidgetConfig()
```
- Method Detail
  - getAccessSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings getAccessSettings()
```
    Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
    
    Returns:
    
    value or null for none
  - setAccessSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfig setAccessSettings(GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings accessSettings)
```
    Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
    
    Parameters:
    
    accessSettings - accessSettings or null for none
  - getAllowPublicAccess
```
public Boolean getAllowPublicAccess()
```
    Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
    
    Returns:
    
    value or null for none
  - setAllowPublicAccess
```
public GoogleCloudDiscoveryengineV1WidgetConfig setAllowPublicAccess(Boolean allowPublicAccess)
```
    Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
    
    Parameters:
    
    allowPublicAccess - allowPublicAccess or null for none
  - getAllowlistedDomains
```
public List<String> getAllowlistedDomains()
```
    Allowlisted domains that can load this widget.
    
    Returns:
    
    value or null for none
  - setAllowlistedDomains
```
public GoogleCloudDiscoveryengineV1WidgetConfig setAllowlistedDomains(List<String> allowlistedDomains)
```
    Allowlisted domains that can load this widget.
    
    Parameters:
    
    allowlistedDomains - allowlistedDomains or null for none
  - getAssistantSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings getAssistantSettings()
```
    Optional. Output only. Describes the assistant settings of the widget.
    
    Returns:
    
    value or null for none
  - setAssistantSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfig setAssistantSettings(GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings assistantSettings)
```
    Optional. Output only. Describes the assistant settings of the widget.
    
    Parameters:
    
    assistantSettings - assistantSettings or null for none
  - getCollectionComponents
```
public List<GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent> 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.
    
    Returns:
    
    value or null for none
  - setCollectionComponents
```
public GoogleCloudDiscoveryengineV1WidgetConfig setCollectionComponents(List<GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent> collectionComponents)
```
    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.
    
    Parameters:
    
    collectionComponents - collectionComponents or null for none
  - getConfigId
```
public String getConfigId()
```
    Output only. Unique obfuscated identifier of a WidgetConfig.
    
    Returns:
    
    value or null for none
  - setConfigId
```
public GoogleCloudDiscoveryengineV1WidgetConfig setConfigId(String configId)
```
    Output only. Unique obfuscated identifier of a WidgetConfig.
    
    Parameters:
    
    configId - configId or null for none
  - getContentSearchSpec
```
public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec getContentSearchSpec()
```
    The content search spec that configs the desired behavior of content search.
    
    Returns:
    
    value or null for none
  - setContentSearchSpec
```
public GoogleCloudDiscoveryengineV1WidgetConfig setContentSearchSpec(GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec contentSearchSpec)
```
    The content search spec that configs the desired behavior of content search.
    
    Parameters:
    
    contentSearchSpec - contentSearchSpec or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Timestamp the WidgetConfig was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1WidgetConfig setCreateTime(String createTime)
```
    Output only. Timestamp the WidgetConfig was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCustomerProvidedConfig
```
public GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig getCustomerProvidedConfig()
```
    Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
    
    Returns:
    
    value or null for none
  - setCustomerProvidedConfig
```
public GoogleCloudDiscoveryengineV1WidgetConfig setCustomerProvidedConfig(GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig customerProvidedConfig)
```
    Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
    
    Parameters:
    
    customerProvidedConfig - customerProvidedConfig or null for none
  - getDataStoreType
```
public String getDataStoreType()
```
    Output only. The type of the parent data store.
    
    Returns:
    
    value or null for none
  - setDataStoreType
```
public GoogleCloudDiscoveryengineV1WidgetConfig setDataStoreType(String dataStoreType)
```
    Output only. The type of the parent data store.
    
    Parameters:
    
    dataStoreType - dataStoreType or null for none
  - getDataStoreUiConfigs
```
public List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> getDataStoreUiConfigs()
```
    Configurable UI configurations per data store.
    
    Returns:
    
    value or null for none
  - setDataStoreUiConfigs
```
public GoogleCloudDiscoveryengineV1WidgetConfig setDataStoreUiConfigs(List<GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig> dataStoreUiConfigs)
```
    Configurable UI configurations per data store.
    
    Parameters:
    
    dataStoreUiConfigs - dataStoreUiConfigs or null for none
  - getDefaultSearchRequestOrderBy
```
public String getDefaultSearchRequestOrderBy()
```
    The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1a lpha/projects.locations.dataStores.servingConfigs/search#request-body
    
    Returns:
    
    value or null for none
  - setDefaultSearchRequestOrderBy
```
public GoogleCloudDiscoveryengineV1WidgetConfig setDefaultSearchRequestOrderBy(String defaultSearchRequestOrderBy)
```
    The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1a lpha/projects.locations.dataStores.servingConfigs/search#request-body
    
    Parameters:
    
    defaultSearchRequestOrderBy - defaultSearchRequestOrderBy or null for none
  - getDisplayName
```
public String 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:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1WidgetConfig setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEnableAutocomplete
```
public Boolean getEnableAutocomplete()
```
    Whether or not to enable autocomplete.
    
    Returns:
    
    value or null for none
  - setEnableAutocomplete
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableAutocomplete(Boolean enableAutocomplete)
```
    Whether or not to enable autocomplete.
    
    Parameters:
    
    enableAutocomplete - enableAutocomplete or null for none
  - getEnableConversationalSearch
```
public Boolean getEnableConversationalSearch()
```
    Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
    
    Returns:
    
    value or null for none
  - setEnableConversationalSearch
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableConversationalSearch(Boolean enableConversationalSearch)
```
    Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
    
    Parameters:
    
    enableConversationalSearch - enableConversationalSearch or null for none
  - getEnablePrivateKnowledgeGraph
```
public Boolean getEnablePrivateKnowledgeGraph()
```
    Optional. Output only. Whether to enable private knowledge graph.
    
    Returns:
    
    value or null for none
  - setEnablePrivateKnowledgeGraph
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnablePrivateKnowledgeGraph(Boolean enablePrivateKnowledgeGraph)
```
    Optional. Output only. Whether to enable private knowledge graph.
    
    Parameters:
    
    enablePrivateKnowledgeGraph - enablePrivateKnowledgeGraph or null for none
  - getEnableQualityFeedback
```
public Boolean getEnableQualityFeedback()
```
    Turn on or off collecting the search result quality feedback from end users.
    
    Returns:
    
    value or null for none
  - setEnableQualityFeedback
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableQualityFeedback(Boolean enableQualityFeedback)
```
    Turn on or off collecting the search result quality feedback from end users.
    
    Parameters:
    
    enableQualityFeedback - enableQualityFeedback or null for none
  - getEnableResultScore
```
public Boolean getEnableResultScore()
```
    Whether to show the result score.
    
    Returns:
    
    value or null for none
  - setEnableResultScore
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableResultScore(Boolean enableResultScore)
```
    Whether to show the result score.
    
    Parameters:
    
    enableResultScore - enableResultScore or null for none
  - getEnableSafeSearch
```
public Boolean getEnableSafeSearch()
```
    Whether to enable safe search.
    
    Returns:
    
    value or null for none
  - setEnableSafeSearch
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableSafeSearch(Boolean enableSafeSearch)
```
    Whether to enable safe search.
    
    Parameters:
    
    enableSafeSearch - enableSafeSearch or null for none
  - getEnableSearchAsYouType
```
public Boolean getEnableSearchAsYouType()
```
    Whether to enable search-as-you-type behavior for the search widget
    
    Returns:
    
    value or null for none
  - setEnableSearchAsYouType
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableSearchAsYouType(Boolean enableSearchAsYouType)
```
    Whether to enable search-as-you-type behavior for the search widget
    
    Parameters:
    
    enableSearchAsYouType - enableSearchAsYouType or null for none
  - getEnableSnippetResultSummary
```
public Boolean getEnableSnippetResultSummary()
```
    Turn on or off summary for each snippets result.
    
    Returns:
    
    value or null for none
  - setEnableSnippetResultSummary
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableSnippetResultSummary(Boolean enableSnippetResultSummary)
```
    Turn on or off summary for each snippets result.
    
    Parameters:
    
    enableSnippetResultSummary - enableSnippetResultSummary or null for none
  - getEnableSummarization
```
public Boolean getEnableSummarization()
```
    Turn on or off summarization for the search response.
    
    Returns:
    
    value or null for none
  - setEnableSummarization
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableSummarization(Boolean enableSummarization)
```
    Turn on or off summarization for the search response.
    
    Parameters:
    
    enableSummarization - enableSummarization or null for none
  - getEnableWebApp
```
public Boolean getEnableWebApp()
```
    Whether to enable standalone web app.
    
    Returns:
    
    value or null for none
  - setEnableWebApp
```
public GoogleCloudDiscoveryengineV1WidgetConfig setEnableWebApp(Boolean enableWebApp)
```
    Whether to enable standalone web app.
    
    Parameters:
    
    enableWebApp - enableWebApp or null for none
  - getFacetField
```
public List<GoogleCloudDiscoveryengineV1WidgetConfigFacetField> getFacetField()
```
    The configuration and appearance of facets in the end user view.
    
    Returns:
    
    value or null for none
  - setFacetField
```
public GoogleCloudDiscoveryengineV1WidgetConfig setFacetField(List<GoogleCloudDiscoveryengineV1WidgetConfigFacetField> facetField)
```
    The configuration and appearance of facets in the end user view.
    
    Parameters:
    
    facetField - facetField or null for none
  - getFieldsUiComponentsMap
```
public Map<String,GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField> getFieldsUiComponentsMap()
```
    The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
    
    Returns:
    
    value or null for none
  - setFieldsUiComponentsMap
```
public GoogleCloudDiscoveryengineV1WidgetConfig setFieldsUiComponentsMap(Map<String,GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField> fieldsUiComponentsMap)
```
    The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
    
    Parameters:
    
    fieldsUiComponentsMap - fieldsUiComponentsMap or null for none
  - getGeminiBundle
```
public Boolean getGeminiBundle()
```
    Output only. Whether the subscription is gemini bundle or not.
    
    Returns:
    
    value or null for none
  - setGeminiBundle
```
public GoogleCloudDiscoveryengineV1WidgetConfig setGeminiBundle(Boolean geminiBundle)
```
    Output only. Whether the subscription is gemini bundle or not.
    
    Parameters:
    
    geminiBundle - geminiBundle or null for none
  - getHomepageSetting
```
public GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting getHomepageSetting()
```
    Optional. Describes the homepage settings of the widget.
    
    Returns:
    
    value or null for none
  - setHomepageSetting
```
public GoogleCloudDiscoveryengineV1WidgetConfig setHomepageSetting(GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting homepageSetting)
```
    Optional. Describes the homepage settings of the widget.
    
    Parameters:
    
    homepageSetting - homepageSetting or null for none
  - getIndustryVertical
```
public String getIndustryVertical()
```
    Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
    
    Returns:
    
    value or null for none
  - setIndustryVertical
```
public GoogleCloudDiscoveryengineV1WidgetConfig setIndustryVertical(String industryVertical)
```
    Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
    
    Parameters:
    
    industryVertical - industryVertical or null for none
  - getLlmEnabled
```
public Boolean getLlmEnabled()
```
    Output only. Whether LLM is enabled in the corresponding data store.
    
    Returns:
    
    value or null for none
  - setLlmEnabled
```
public GoogleCloudDiscoveryengineV1WidgetConfig setLlmEnabled(Boolean llmEnabled)
```
    Output only. Whether LLM is enabled in the corresponding data store.
    
    Parameters:
    
    llmEnabled - llmEnabled or null for none
  - getMinimumDataTermAccepted
```
public Boolean getMinimumDataTermAccepted()
```
    Output only. Whether the customer accepted data use terms.
    
    Returns:
    
    value or null for none
  - setMinimumDataTermAccepted
```
public GoogleCloudDiscoveryengineV1WidgetConfig setMinimumDataTermAccepted(Boolean minimumDataTermAccepted)
```
    Output only. Whether the customer accepted data use terms.
    
    Parameters:
    
    minimumDataTermAccepted - minimumDataTermAccepted or null for none
  - getName
```
public String 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_i d}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1WidgetConfig setName(String name)
```
    Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{ location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_i d}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Parameters:
    
    name - name or null for none
  - getNodes
```
public List<GoogleCloudDiscoveryengineV1WidgetConfigNode> getNodes()
```
    Output only. The nodes associated with the Widget Config.
    
    Returns:
    
    value or null for none
  - setNodes
```
public GoogleCloudDiscoveryengineV1WidgetConfig setNodes(List<GoogleCloudDiscoveryengineV1WidgetConfigNode> nodes)
```
    Output only. The nodes associated with the Widget Config.
    
    Parameters:
    
    nodes - nodes or null for none
  - getResultDisplayType
```
public String getResultDisplayType()
```
    The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
    
    Returns:
    
    value or null for none
  - setResultDisplayType
```
public GoogleCloudDiscoveryengineV1WidgetConfig setResultDisplayType(String resultDisplayType)
```
    The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
    
    Parameters:
    
    resultDisplayType - resultDisplayType or null for none
  - getSolutionType
```
public String getSolutionType()
```
    Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
    
    Returns:
    
    value or null for none
  - setSolutionType
```
public GoogleCloudDiscoveryengineV1WidgetConfig setSolutionType(String solutionType)
```
    Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
    
    Parameters:
    
    solutionType - solutionType or null for none
  - getUiBranding
```
public GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings getUiBranding()
```
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
    
    Returns:
    
    value or null for none
  - setUiBranding
```
public GoogleCloudDiscoveryengineV1WidgetConfig setUiBranding(GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings uiBranding)
```
    Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
    
    Parameters:
    
    uiBranding - uiBranding or null for none
  - getUiSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfigUiSettings getUiSettings()
```
    Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
    
    Returns:
    
    value or null for none
  - setUiSettings
```
public GoogleCloudDiscoveryengineV1WidgetConfig setUiSettings(GoogleCloudDiscoveryengineV1WidgetConfigUiSettings uiSettings)
```
    Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
    
    Parameters:
    
    uiSettings - uiSettings or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Timestamp the WidgetConfig was updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public GoogleCloudDiscoveryengineV1WidgetConfig setUpdateTime(String updateTime)
```
    Output only. Timestamp the WidgetConfig was updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public GoogleCloudDiscoveryengineV1WidgetConfig set(String fieldName,
                                                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1WidgetConfig clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1WidgetConfig

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1WidgetConfig

Method Detail

getAccessSettings

setAccessSettings

getAllowPublicAccess

setAllowPublicAccess

getAllowlistedDomains

setAllowlistedDomains

getAssistantSettings

setAssistantSettings

getCollectionComponents

setCollectionComponents

getConfigId

setConfigId

getContentSearchSpec

setContentSearchSpec

getCreateTime

setCreateTime

getCustomerProvidedConfig

setCustomerProvidedConfig

getDataStoreType

setDataStoreType

getDataStoreUiConfigs

setDataStoreUiConfigs

getDefaultSearchRequestOrderBy

setDefaultSearchRequestOrderBy

getDisplayName

setDisplayName

getEnableAutocomplete

setEnableAutocomplete

getEnableConversationalSearch

setEnableConversationalSearch

getEnablePrivateKnowledgeGraph

setEnablePrivateKnowledgeGraph

getEnableQualityFeedback

setEnableQualityFeedback

getEnableResultScore

setEnableResultScore

getEnableSafeSearch

setEnableSafeSearch

getEnableSearchAsYouType

setEnableSearchAsYouType

getEnableSnippetResultSummary

setEnableSnippetResultSummary

getEnableSummarization

setEnableSummarization

getEnableWebApp

setEnableWebApp

getFacetField

setFacetField

getFieldsUiComponentsMap

setFieldsUiComponentsMap

getGeminiBundle

setGeminiBundle

getHomepageSetting

setHomepageSetting

getIndustryVertical

setIndustryVertical

getLlmEnabled

setLlmEnabled

getMinimumDataTermAccepted

setMinimumDataTermAccepted

getName

setName

getNodes

setNodes

getResultDisplayType