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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1DataStore
extends com.google.api.client.json.GenericJson
```
DataStore captures global settings and configs at the DataStore 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

GoogleCloudDiscoveryengineV1DataStore()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1DataStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1DataStore`	`clone()`
`String`	`getContentConfig()` Immutable.
`String`	`getCreateTime()` Output only.
`String`	`getDefaultSchemaId()` Output only.
`String`	`getDisplayName()` Required.
`GoogleCloudDiscoveryengineV1DocumentProcessingConfig`	`getDocumentProcessingConfig()` Configuration for Document understanding and enrichment.
`String`	`getIndustryVertical()` Immutable.
`String`	`getName()` Immutable.
`GoogleCloudDiscoveryengineV1ServingConfigDataStore`	`getServingConfigDataStore()` Optional.
`List<String>`	`getSolutionTypes()` The solutions that the data store enrolls.
`GoogleCloudDiscoveryengineV1Schema`	`getStartingSchema()` The start schema to use for this DataStore when provisioning it.
`GoogleCloudDiscoveryengineV1WorkspaceConfig`	`getWorkspaceConfig()` Config to store data store type configuration for workspace data.
`GoogleCloudDiscoveryengineV1DataStore`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1DataStore`	`setContentConfig(String contentConfig)` Immutable.
`GoogleCloudDiscoveryengineV1DataStore`	`setCreateTime(String createTime)` Output only.
`GoogleCloudDiscoveryengineV1DataStore`	`setDefaultSchemaId(String defaultSchemaId)` Output only.
`GoogleCloudDiscoveryengineV1DataStore`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1DataStore`	`setDocumentProcessingConfig(GoogleCloudDiscoveryengineV1DocumentProcessingConfig documentProcessingConfig)` Configuration for Document understanding and enrichment.
`GoogleCloudDiscoveryengineV1DataStore`	`setIndustryVertical(String industryVertical)` Immutable.
`GoogleCloudDiscoveryengineV1DataStore`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1DataStore`	`setServingConfigDataStore(GoogleCloudDiscoveryengineV1ServingConfigDataStore servingConfigDataStore)` Optional.
`GoogleCloudDiscoveryengineV1DataStore`	`setSolutionTypes(List<String> solutionTypes)` The solutions that the data store enrolls.
`GoogleCloudDiscoveryengineV1DataStore`	`setStartingSchema(GoogleCloudDiscoveryengineV1Schema startingSchema)` The start schema to use for this DataStore when provisioning it.
`GoogleCloudDiscoveryengineV1DataStore`	`setWorkspaceConfig(GoogleCloudDiscoveryengineV1WorkspaceConfig workspaceConfig)` Config to store data store type configuration for workspace data.

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
  - GoogleCloudDiscoveryengineV1DataStore
```
public GoogleCloudDiscoveryengineV1DataStore()
```
- Method Detail
  - getContentConfig
```
public String getContentConfig()
```
    Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
    
    Returns:
    
    value or null for none
  - setContentConfig
```
public GoogleCloudDiscoveryengineV1DataStore setContentConfig(String contentConfig)
```
    Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
    
    Parameters:
    
    contentConfig - contentConfig or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Timestamp the DataStore was created at.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudDiscoveryengineV1DataStore setCreateTime(String createTime)
```
    Output only. Timestamp the DataStore was created at.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDefaultSchemaId
```
public String getDefaultSchemaId()
```
    Output only. The id of the default Schema asscociated to this data store.
    
    Returns:
    
    value or null for none
  - setDefaultSchemaId
```
public GoogleCloudDiscoveryengineV1DataStore setDefaultSchemaId(String defaultSchemaId)
```
    Output only. The id of the default Schema asscociated to this data store.
    
    Parameters:
    
    defaultSchemaId - defaultSchemaId or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The data store display name. 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 GoogleCloudDiscoveryengineV1DataStore setDisplayName(String displayName)
```
    Required. The data store display name. 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
  - getDocumentProcessingConfig
```
public GoogleCloudDiscoveryengineV1DocumentProcessingConfig getDocumentProcessingConfig()
```
    Configuration for Document understanding and enrichment.
    
    Returns:
    
    value or null for none
  - setDocumentProcessingConfig
```
public GoogleCloudDiscoveryengineV1DataStore setDocumentProcessingConfig(GoogleCloudDiscoveryengineV1DocumentProcessingConfig documentProcessingConfig)
```
    Configuration for Document understanding and enrichment.
    
    Parameters:
    
    documentProcessingConfig - documentProcessingConfig or null for none
  - getIndustryVertical
```
public String getIndustryVertical()
```
    Immutable. The industry vertical that the data store registers.
    
    Returns:
    
    value or null for none
  - setIndustryVertical
```
public GoogleCloudDiscoveryengineV1DataStore setIndustryVertical(String industryVertical)
```
    Immutable. The industry vertical that the data store registers.
    
    Parameters:
    
    industryVertical - industryVertical or null for none
  - getName
```
public String getName()
```
    Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{loc ation}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1DataStore setName(String name)
```
    Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{loc ation}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    
    Parameters:
    
    name - name or null for none
  - getServingConfigDataStore
```
public GoogleCloudDiscoveryengineV1ServingConfigDataStore getServingConfigDataStore()
```
    Optional. Stores serving config at DataStore level.
    
    Returns:
    
    value or null for none
  - setServingConfigDataStore
```
public GoogleCloudDiscoveryengineV1DataStore setServingConfigDataStore(GoogleCloudDiscoveryengineV1ServingConfigDataStore servingConfigDataStore)
```
    Optional. Stores serving config at DataStore level.
    
    Parameters:
    
    servingConfigDataStore - servingConfigDataStore or null for none
  - getSolutionTypes
```
public List<String> getSolutionTypes()
```
    The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
    
    Returns:
    
    value or null for none
  - setSolutionTypes
```
public GoogleCloudDiscoveryengineV1DataStore setSolutionTypes(List<String> solutionTypes)
```
    The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
    
    Parameters:
    
    solutionTypes - solutionTypes or null for none
  - getStartingSchema
```
public GoogleCloudDiscoveryengineV1Schema getStartingSchema()
```
    The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
    
    Returns:
    
    value or null for none
  - setStartingSchema
```
public GoogleCloudDiscoveryengineV1DataStore setStartingSchema(GoogleCloudDiscoveryengineV1Schema startingSchema)
```
    The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
    
    Parameters:
    
    startingSchema - startingSchema or null for none
  - getWorkspaceConfig
```
public GoogleCloudDiscoveryengineV1WorkspaceConfig getWorkspaceConfig()
```
    Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
    
    Returns:
    
    value or null for none
  - setWorkspaceConfig
```
public GoogleCloudDiscoveryengineV1DataStore setWorkspaceConfig(GoogleCloudDiscoveryengineV1WorkspaceConfig workspaceConfig)
```
    Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
    
    Parameters:
    
    workspaceConfig - workspaceConfig or null for none
  - set
```
public GoogleCloudDiscoveryengineV1DataStore set(String fieldName,
                                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1DataStore clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1DataStore

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

GoogleCloudDiscoveryengineV1DataStore

Method Detail

getContentConfig

setContentConfig

getCreateTime

setCreateTime

getDefaultSchemaId

setDefaultSchemaId

getDisplayName

setDisplayName

getDocumentProcessingConfig

setDocumentProcessingConfig

getIndustryVertical

setIndustryVertical

getName

setName

getServingConfigDataStore

setServingConfigDataStore

getSolutionTypes

setSolutionTypes

getStartingSchema

setStartingSchema

getWorkspaceConfig

setWorkspaceConfig

set

clone