GoogleCloudDiscoveryengineV1Assistant (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.GoogleCloudDiscoveryengineV1Assistant

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1Assistant
extends com.google.api.client.json.GenericJson
```
Discovery Engine Assistant resource.
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

GoogleCloudDiscoveryengineV1Assistant()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1Assistant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1Assistant`	`clone()`
`String`	`getCreateTime()` Output only.
`GoogleCloudDiscoveryengineV1AssistantCustomerPolicy`	`getCustomerPolicy()` Optional.
`Boolean`	`getDefaultWebGroundingToggleOff()` Optional.
`String`	`getDescription()` Optional.
`String`	`getDisplayName()` Required.
`Map<String,GoogleCloudDiscoveryengineV1AssistantToolList>`	`getEnabledTools()` Optional.
`GoogleCloudDiscoveryengineV1AssistantGenerationConfig`	`getGenerationConfig()` Optional.
`String`	`getName()` Immutable.
`String`	`getUpdateTime()` Output only.
`String`	`getWebGroundingType()` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1Assistant`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1Assistant`	`setCustomerPolicy(GoogleCloudDiscoveryengineV1AssistantCustomerPolicy customerPolicy)` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`setDefaultWebGroundingToggleOff(Boolean defaultWebGroundingToggleOff)` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`setDescription(String description)` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1Assistant`	`setEnabledTools(Map<String,GoogleCloudDiscoveryengineV1AssistantToolList> enabledTools)` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`setGenerationConfig(GoogleCloudDiscoveryengineV1AssistantGenerationConfig generationConfig)` Optional.
`GoogleCloudDiscoveryengineV1Assistant`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1Assistant`	`setUpdateTime(String updateTime)` Output only.
`GoogleCloudDiscoveryengineV1Assistant`	`setWebGroundingType(String webGroundingType)` Optional.

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
  - GoogleCloudDiscoveryengineV1Assistant
```
public GoogleCloudDiscoveryengineV1Assistant()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Represents the time when this Assistant was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1Assistant setCreateTime(String createTime)
```
    Output only. Represents the time when this Assistant was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCustomerPolicy
```
public GoogleCloudDiscoveryengineV1AssistantCustomerPolicy getCustomerPolicy()
```
    Optional. Customer policy for the assistant.
    
    Returns:
    
    value or null for none
  - setCustomerPolicy
```
public GoogleCloudDiscoveryengineV1Assistant setCustomerPolicy(GoogleCloudDiscoveryengineV1AssistantCustomerPolicy customerPolicy)
```
    Optional. Customer policy for the assistant.
    
    Parameters:
    
    customerPolicy - customerPolicy or null for none
  - getDefaultWebGroundingToggleOff
```
public Boolean getDefaultWebGroundingToggleOff()
```
    Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
    
    Returns:
    
    value or null for none
  - setDefaultWebGroundingToggleOff
```
public GoogleCloudDiscoveryengineV1Assistant setDefaultWebGroundingToggleOff(Boolean defaultWebGroundingToggleOff)
```
    Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
    
    Parameters:
    
    defaultWebGroundingToggleOff - defaultWebGroundingToggleOff or null for none
  - getDescription
```
public String getDescription()
```
    Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudDiscoveryengineV1Assistant setDescription(String description)
```
    Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
    
    Parameters:
    
    description - description or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1Assistant setDisplayName(String displayName)
```
    Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEnabledTools
```
public Map<String,GoogleCloudDiscoveryengineV1AssistantToolList> getEnabledTools()
```
    Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
    
    Returns:
    
    value or null for none
  - setEnabledTools
```
public GoogleCloudDiscoveryengineV1Assistant setEnabledTools(Map<String,GoogleCloudDiscoveryengineV1AssistantToolList> enabledTools)
```
    Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
    
    Parameters:
    
    enabledTools - enabledTools or null for none
  - getGenerationConfig
```
public GoogleCloudDiscoveryengineV1AssistantGenerationConfig getGenerationConfig()
```
    Optional. Configuration for the generation of the assistant response.
    
    Returns:
    
    value or null for none
  - setGenerationConfig
```
public GoogleCloudDiscoveryengineV1Assistant setGenerationConfig(GoogleCloudDiscoveryengineV1AssistantGenerationConfig generationConfig)
```
    Optional. Configuration for the generation of the assistant response.
    
    Parameters:
    
    generationConfig - generationConfig or null for none
  - getName
```
public String getName()
```
    Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/col lections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1Assistant setName(String name)
```
    Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/col lections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Parameters:
    
    name - name or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Represents the time when this Assistant was most recently updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public GoogleCloudDiscoveryengineV1Assistant setUpdateTime(String updateTime)
```
    Output only. Represents the time when this Assistant was most recently updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getWebGroundingType
```
public String getWebGroundingType()
```
    Optional. The type of web grounding to use.
    
    Returns:
    
    value or null for none
  - setWebGroundingType
```
public GoogleCloudDiscoveryengineV1Assistant setWebGroundingType(String webGroundingType)
```
    Optional. The type of web grounding to use.
    
    Parameters:
    
    webGroundingType - webGroundingType or null for none
  - set
```
public GoogleCloudDiscoveryengineV1Assistant set(String fieldName,
                                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1Assistant clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1Assistant

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

GoogleCloudDiscoveryengineV1Assistant

Method Detail

getCreateTime

setCreateTime

getCustomerPolicy

setCustomerPolicy

getDefaultWebGroundingToggleOff

setDefaultWebGroundingToggleOff

getDescription

setDescription

getDisplayName

setDisplayName

getEnabledTools

setEnabledTools

getGenerationConfig

setGenerationConfig

getName

setName

getUpdateTime

setUpdateTime

getWebGroundingType

setWebGroundingType

set

clone