@Generated
public interface DataStoreOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
getAclEnabled()
Immutable.
|
AdvancedSiteSearchConfig |
getAdvancedSiteSearchConfig()
Optional.
|
AdvancedSiteSearchConfigOrBuilder |
getAdvancedSiteSearchConfigOrBuilder()
Optional.
|
DataStore.BillingEstimation |
getBillingEstimation()
Output only.
|
DataStore.BillingEstimationOrBuilder |
getBillingEstimationOrBuilder()
Output only.
|
CmekConfig |
getCmekConfig()
Output only.
|
CmekConfigOrBuilder |
getCmekConfigOrBuilder()
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.
|
HealthcareFhirConfig |
getHealthcareFhirConfig()
Optional.
|
HealthcareFhirConfigOrBuilder |
getHealthcareFhirConfigOrBuilder()
Optional.
|
String |
getIdentityMappingStore()
Immutable.
|
com.google.protobuf.ByteString |
getIdentityMappingStoreBytes()
Immutable.
|
IndustryVertical |
getIndustryVertical()
Immutable.
|
int |
getIndustryVerticalValue()
Immutable.
|
String |
getKmsKeyName()
Input only.
|
com.google.protobuf.ByteString |
getKmsKeyNameBytes()
Input only.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
NaturalLanguageQueryUnderstandingConfig |
getNaturalLanguageQueryUnderstandingConfig()
Optional.
|
NaturalLanguageQueryUnderstandingConfigOrBuilder |
getNaturalLanguageQueryUnderstandingConfigOrBuilder()
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.v1.DataStore] when provisioning
it.
|
SchemaOrBuilder |
getStartingSchemaOrBuilder()
The start schema to use for this
[DataStore][google.cloud.discoveryengine.v1.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 |
hasAdvancedSiteSearchConfig()
Optional.
|
boolean |
hasBillingEstimation()
Output only.
|
boolean |
hasCmekConfig()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
|
boolean |
hasHealthcareFhirConfig()
Optional.
|
boolean |
hasNaturalLanguageQueryUnderstandingConfig()
Optional.
|
boolean |
hasStartingSchema()
The start schema to use for this
[DataStore][google.cloud.discoveryengine.v1.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. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
com.google.protobuf.ByteString getNameBytes()
Immutable. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
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.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
IndustryVertical getIndustryVertical()
Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.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.v1.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.v1.SolutionType solution_types = 5;int getSolutionTypesCount()
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1.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.v1.SolutionType solution_types = 5;SolutionType getSolutionTypes(int index)
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.SolutionType solution_types = 5;int getSolutionTypesValue(int index)
The solutions that the data store enrolls. Available solutions for each [industry_vertical][google.cloud.discoveryengine.v1.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.v1.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.v1.Schema] associated 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.v1.Schema] associated 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.v1.DataStore.ContentConfig.NO_CONTENT].
.google.cloud.discoveryengine.v1.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.v1.DataStore.ContentConfig.NO_CONTENT].
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
boolean hasCreateTime()
Output only. Timestamp the [DataStore][google.cloud.discoveryengine.v1.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.v1.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.v1.DataStore] was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasAdvancedSiteSearchConfig()
Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
AdvancedSiteSearchConfig getAdvancedSiteSearchConfig()
Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
AdvancedSiteSearchConfigOrBuilder getAdvancedSiteSearchConfigOrBuilder()
Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
boolean hasNaturalLanguageQueryUnderstandingConfig()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
NaturalLanguageQueryUnderstandingConfig getNaturalLanguageQueryUnderstandingConfig()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
NaturalLanguageQueryUnderstandingConfigOrBuilder getNaturalLanguageQueryUnderstandingConfigOrBuilder()
Optional. Configuration for Natural Language Query Understanding.
.google.cloud.discoveryengine.v1.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
String getKmsKeyName()
Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];com.google.protobuf.ByteString getKmsKeyNameBytes()
Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];boolean hasCmekConfig()
Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
CmekConfig getCmekConfig()
Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
CmekConfigOrBuilder getCmekConfigOrBuilder()
Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasBillingEstimation()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
DataStore.BillingEstimation getBillingEstimation()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
DataStore.BillingEstimationOrBuilder getBillingEstimationOrBuilder()
Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean getAclEnabled()
Immutable. Whether data in the [DataStore][google.cloud.discoveryengine.v1.DataStore] has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by [DocumentService.ImportDocuments][google.cloud.discoveryengine.v1.DocumentService.ImportDocuments] methods. When ACL is enabled for the [DataStore][google.cloud.discoveryengine.v1.DataStore], [Document][google.cloud.discoveryengine.v1.Document] can't be accessed by calling [DocumentService.GetDocument][google.cloud.discoveryengine.v1.DocumentService.GetDocument] or [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.
bool acl_enabled = 24 [(.google.api.field_behavior) = IMMUTABLE];boolean hasWorkspaceConfig()
Config to store data store type configuration for workspace data. This must be set when [DataStore.content_config][google.cloud.discoveryengine.v1.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1.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.v1.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1.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.v1.DataStore.content_config] is set as [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1.DataStore.ContentConfig.GOOGLE_WORKSPACE].
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;boolean hasDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
DocumentProcessingConfig getDocumentProcessingConfig()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
boolean hasStartingSchema()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1.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.v1.Schema starting_schema = 28;Schema getStartingSchema()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1.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.v1.Schema starting_schema = 28;SchemaOrBuilder getStartingSchemaOrBuilder()
The start schema to use for this [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore] API. To retrieve a schema of a [DataStore][google.cloud.discoveryengine.v1.DataStore], use [SchemaService.GetSchema][google.cloud.discoveryengine.v1.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.v1.Schema starting_schema = 28;boolean hasHealthcareFhirConfig()
Optional. Configuration for `HEALTHCARE_FHIR` vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
HealthcareFhirConfig getHealthcareFhirConfig()
Optional. Configuration for `HEALTHCARE_FHIR` vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
HealthcareFhirConfigOrBuilder getHealthcareFhirConfigOrBuilder()
Optional. Configuration for `HEALTHCARE_FHIR` vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
String getIdentityMappingStore()
Immutable. The fully qualified resource name of the associated
[IdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStore].
This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
`GSUITE` IdP. Format:
`projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
com.google.protobuf.ByteString getIdentityMappingStoreBytes()
Immutable. The fully qualified resource name of the associated
[IdentityMappingStore][google.cloud.discoveryengine.v1.IdentityMappingStore].
This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or
`GSUITE` IdP. Format:
`projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
Copyright © 2026 Google LLC. All rights reserved.