GoogleCloudDiscoveryengineV1alphaEngine (Discovery Engine API v1-rev20240912-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.GoogleCloudDiscoveryengineV1alphaEngine

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1alphaEngine
extends com.google.api.client.json.GenericJson
```
Metadata that describes the training and serving parameters of an Engine.
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

GoogleCloudDiscoveryengineV1alphaEngine()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1alphaEngine()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1alphaEngine`	`clone()`
`GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig`	`getChatEngineConfig()` Configurations for the Chat Engine.
`GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata`	`getChatEngineMetadata()` Output only.
`GoogleCloudDiscoveryengineV1alphaEngineCommonConfig`	`getCommonConfig()` Common config spec that specifies the metadata of the engine.
`String`	`getCreateTime()` Output only.
`List<String>`	`getDataStoreIds()` The data stores associated with this engine.
`String`	`getDisplayName()` Required.
`String`	`getIndustryVertical()` The industry vertical that the engine registers.
`GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig`	`getMediaRecommendationEngineConfig()` Configurations for the Media Engine.
`String`	`getName()` Immutable.
`GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata`	`getRecommendationMetadata()` Output only.
`GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig`	`getSearchEngineConfig()` Configurations for the Search Engine.
`GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig`	`getSimilarDocumentsConfig()` Additional config specs for a `similar-items` engine.
`String`	`getSolutionType()` Required.
`String`	`getUpdateTime()` Output only.
`GoogleCloudDiscoveryengineV1alphaEngine`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1alphaEngine`	`setChatEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig chatEngineConfig)` Configurations for the Chat Engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setChatEngineMetadata(GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata chatEngineMetadata)` Output only.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setCommonConfig(GoogleCloudDiscoveryengineV1alphaEngineCommonConfig commonConfig)` Common config spec that specifies the metadata of the engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setDataStoreIds(List<String> dataStoreIds)` The data stores associated with this engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setIndustryVertical(String industryVertical)` The industry vertical that the engine registers.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setMediaRecommendationEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig mediaRecommendationEngineConfig)` Configurations for the Media Engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setRecommendationMetadata(GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata recommendationMetadata)` Output only.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setSearchEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig searchEngineConfig)` Configurations for the Search Engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setSimilarDocumentsConfig(GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig similarDocumentsConfig)` Additional config specs for a `similar-items` engine.
`GoogleCloudDiscoveryengineV1alphaEngine`	`setSolutionType(String solutionType)` Required.
`GoogleCloudDiscoveryengineV1alphaEngine`	`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
  - GoogleCloudDiscoveryengineV1alphaEngine
```
public GoogleCloudDiscoveryengineV1alphaEngine()
```
- Method Detail
  - getChatEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig getChatEngineConfig()
```
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    
    Returns:
    
    value or null for none
  - setChatEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngine setChatEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig chatEngineConfig)
```
    Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    
    Parameters:
    
    chatEngineConfig - chatEngineConfig or null for none
  - getChatEngineMetadata
```
public GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata getChatEngineMetadata()
```
    Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    
    Returns:
    
    value or null for none
  - setChatEngineMetadata
```
public GoogleCloudDiscoveryengineV1alphaEngine setChatEngineMetadata(GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata chatEngineMetadata)
```
    Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
    
    Parameters:
    
    chatEngineMetadata - chatEngineMetadata or null for none
  - getCommonConfig
```
public GoogleCloudDiscoveryengineV1alphaEngineCommonConfig getCommonConfig()
```
    Common config spec that specifies the metadata of the engine.
    
    Returns:
    
    value or null for none
  - setCommonConfig
```
public GoogleCloudDiscoveryengineV1alphaEngine setCommonConfig(GoogleCloudDiscoveryengineV1alphaEngineCommonConfig commonConfig)
```
    Common config spec that specifies the metadata of the engine.
    
    Parameters:
    
    commonConfig - commonConfig or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Timestamp the Recommendation Engine was created at.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1alphaEngine setCreateTime(String createTime)
```
    Output only. Timestamp the Recommendation Engine was created at.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDataStoreIds
```
public List<String> getDataStoreIds()
```
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    
    Returns:
    
    value or null for none
  - setDataStoreIds
```
public GoogleCloudDiscoveryengineV1alphaEngine setDataStoreIds(List<String> dataStoreIds)
```
    The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
    
    Parameters:
    
    dataStoreIds - dataStoreIds or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1alphaEngine setDisplayName(String displayName)
```
    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getIndustryVertical
```
public String getIndustryVertical()
```
    The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
    
    Returns:
    
    value or null for none
  - setIndustryVertical
```
public GoogleCloudDiscoveryengineV1alphaEngine setIndustryVertical(String industryVertical)
```
    The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.
    
    Parameters:
    
    industryVertical - industryVertical or null for none
  - getMediaRecommendationEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig getMediaRecommendationEngineConfig()
```
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    
    Returns:
    
    value or null for none
  - setMediaRecommendationEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngine setMediaRecommendationEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig mediaRecommendationEngineConfig)
```
    Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
    
    Parameters:
    
    mediaRecommendationEngineConfig - mediaRecommendationEngineConfig or null for none
  - getName
```
public String getName()
```
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9. Otherwise, an INVALID_ARGUMENT error is returned.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1alphaEngine setName(String name)
```
    Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9. Otherwise, an INVALID_ARGUMENT error is returned.
    
    Parameters:
    
    name - name or null for none
  - getRecommendationMetadata
```
public GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata getRecommendationMetadata()
```
    Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    
    Returns:
    
    value or null for none
  - setRecommendationMetadata
```
public GoogleCloudDiscoveryengineV1alphaEngine setRecommendationMetadata(GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata recommendationMetadata)
```
    Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
    
    Parameters:
    
    recommendationMetadata - recommendationMetadata or null for none
  - getSearchEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig getSearchEngineConfig()
```
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    
    Returns:
    
    value or null for none
  - setSearchEngineConfig
```
public GoogleCloudDiscoveryengineV1alphaEngine setSearchEngineConfig(GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig searchEngineConfig)
```
    Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
    
    Parameters:
    
    searchEngineConfig - searchEngineConfig or null for none
  - getSimilarDocumentsConfig
```
public GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig getSimilarDocumentsConfig()
```
    Additional config specs for a `similar-items` engine.
    
    Returns:
    
    value or null for none
  - setSimilarDocumentsConfig
```
public GoogleCloudDiscoveryengineV1alphaEngine setSimilarDocumentsConfig(GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig similarDocumentsConfig)
```
    Additional config specs for a `similar-items` engine.
    
    Parameters:
    
    similarDocumentsConfig - similarDocumentsConfig or null for none
  - getSolutionType
```
public String getSolutionType()
```
    Required. The solutions of the engine.
    
    Returns:
    
    value or null for none
  - setSolutionType
```
public GoogleCloudDiscoveryengineV1alphaEngine setSolutionType(String solutionType)
```
    Required. The solutions of the engine.
    
    Parameters:
    
    solutionType - solutionType or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Timestamp the Recommendation Engine was last updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public GoogleCloudDiscoveryengineV1alphaEngine setUpdateTime(String updateTime)
```
    Output only. Timestamp the Recommendation Engine was last updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public GoogleCloudDiscoveryengineV1alphaEngine set(String fieldName,
                                                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1alphaEngine clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1alphaEngine

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

GoogleCloudDiscoveryengineV1alphaEngine

Method Detail

getChatEngineConfig

setChatEngineConfig

getChatEngineMetadata

setChatEngineMetadata

getCommonConfig

setCommonConfig

getCreateTime

setCreateTime

getDataStoreIds

setDataStoreIds

getDisplayName

setDisplayName

getIndustryVertical

setIndustryVertical

getMediaRecommendationEngineConfig

setMediaRecommendationEngineConfig

getName

setName

getRecommendationMetadata

setRecommendationMetadata

getSearchEngineConfig

setSearchEngineConfig

getSimilarDocumentsConfig

setSimilarDocumentsConfig

getSolutionType

setSolutionType

getUpdateTime

setUpdateTime

set

clone