public interface DataStoreOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
DataStore.BillingEstimation |
getBillingEstimation()
Output only.
|
DataStore.BillingEstimationOrBuilder |
getBillingEstimationOrBuilder()
Output only.
|
DataStore.ContentConfig |
getContentConfig()
Immutable.
|
int |
getContentConfigValue()
Immutable.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
String |
getDefaultSchemaId()
Output only.
|
com.google.protobuf.ByteString |
getDefaultSchemaIdBytes()
Output only.
|
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
DocumentProcessingConfig |
getDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
|
DocumentProcessingConfigOrBuilder |
getDocumentProcessingConfigOrBuilder()
Configuration for Document understanding and enrichment.
|
IndustryVertical |
getIndustryVertical()
Immutable.
|
int |
getIndustryVerticalValue()
Immutable.
|
LanguageInfo |
getLanguageInfo()
Language info for DataStore.
|
LanguageInfoOrBuilder |
getLanguageInfoOrBuilder()
Language info for DataStore.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
NaturalLanguageQueryUnderstandingConfig |
getNaturalLanguageQueryUnderstandingConfig()
Optional.
|
NaturalLanguageQueryUnderstandingConfigOrBuilder |
getNaturalLanguageQueryUnderstandingConfigOrBuilder()
Optional.
|
DataStore.ServingConfigDataStore |
getServingConfigDataStore()
Optional.
|
DataStore.ServingConfigDataStoreOrBuilder |
getServingConfigDataStoreOrBuilder()
Optional.
|
SolutionType |
getSolutionTypes(int index)
The solutions that the data store enrolls.
|
int |
getSolutionTypesCount()
The solutions that the data store enrolls.
|
List<SolutionType> |
getSolutionTypesList()
The solutions that the data store enrolls.
|
int |
getSolutionTypesValue(int index)
The solutions that the data store enrolls.
|
List<Integer> |
getSolutionTypesValueList()
The solutions that the data store enrolls.
|
Schema |
getStartingSchema()
The start schema to use for this
[DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
provisioning it.
|
SchemaOrBuilder |
getStartingSchemaOrBuilder()
The start schema to use for this
[DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
provisioning it.
|
WorkspaceConfig |
getWorkspaceConfig()
Config to store data store type configuration for workspace data.
|
WorkspaceConfigOrBuilder |
getWorkspaceConfigOrBuilder()
Config to store data store type configuration for workspace data.
|
boolean |
hasBillingEstimation()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
|
boolean |
hasLanguageInfo()
Language info for DataStore.
|
boolean |
hasNaturalLanguageQueryUnderstandingConfig()
Optional.
|
boolean |
hasServingConfigDataStore()
Optional.
|
boolean |
hasStartingSchema()
The start schema to use for this
[DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
provisioning it.
|
boolean |
hasWorkspaceConfig()
Config to store data store type configuration for workspace data.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
Immutable. The full resource name of the data store.
Format:
`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];com.google.protobuf.ByteString getNameBytes()
Immutable. The full resource name of the data store.
Format:
`projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];com.google.protobuf.ByteString getDisplayNameBytes()
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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];int getIndustryVerticalValue()
Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
IndustryVertical getIndustryVertical()
Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
List<SolutionType> getSolutionTypesList()
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;int getSolutionTypesCount()
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;SolutionType getSolutionTypes(int index)
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;index - The index of the element to return.List<Integer> getSolutionTypesValueList()
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;int getSolutionTypesValue(int index)
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;index - The index of the value to return.String getDefaultSchemaId()
Output only. The id of the default [Schema][google.cloud.discoveryengine.v1beta.Schema] asscociated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getDefaultSchemaIdBytes()
Output only. The id of the default [Schema][google.cloud.discoveryengine.v1beta.Schema] asscociated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];int getContentConfigValue()
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.NO_CONTENT].
.google.cloud.discoveryengine.v1beta.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
DataStore.ContentConfig getContentConfig()
Immutable. The content config of the data store. If this field is unset, the server behavior defaults to [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.NO_CONTENT].
.google.cloud.discoveryengine.v1beta.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
boolean hasCreateTime()
Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasLanguageInfo()
Language info for DataStore.
.google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;LanguageInfo getLanguageInfo()
Language info for DataStore.
.google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;LanguageInfoOrBuilder getLanguageInfoOrBuilder()
Language info for DataStore.
.google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;boolean hasNaturalLanguageQueryUnderstandingConfig()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
NaturalLanguageQueryUnderstandingConfig getNaturalLanguageQueryUnderstandingConfig()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
NaturalLanguageQueryUnderstandingConfigOrBuilder getNaturalLanguageQueryUnderstandingConfigOrBuilder()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
boolean hasBillingEstimation()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1beta.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
DataStore.BillingEstimation getBillingEstimation()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1beta.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
DataStore.BillingEstimationOrBuilder getBillingEstimationOrBuilder()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1beta.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasWorkspaceConfig()
Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1beta.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;WorkspaceConfig getWorkspaceConfig()
Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1beta.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;WorkspaceConfigOrBuilder getWorkspaceConfigOrBuilder()
Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1beta.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;boolean hasDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1beta.DocumentProcessingConfig document_processing_config = 27;
DocumentProcessingConfig getDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1beta.DocumentProcessingConfig document_processing_config = 27;
DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1beta.DocumentProcessingConfig document_processing_config = 27;
boolean hasStartingSchema()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.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).
.google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;Schema getStartingSchema()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.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).
.google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;SchemaOrBuilder getStartingSchemaOrBuilder()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.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).
.google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;boolean hasServingConfigDataStore()
Optional. Stores serving config at DataStore level.
.google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];
DataStore.ServingConfigDataStore getServingConfigDataStore()
Optional. Stores serving config at DataStore level.
.google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];
DataStore.ServingConfigDataStoreOrBuilder getServingConfigDataStoreOrBuilder()
Optional. Stores serving config at DataStore level.
.google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];
Copyright © 2025 Google LLC. All rights reserved.