- 0.60.0 (latest)
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface DataStoreOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAclEnabled()
public abstract boolean getAclEnabled() Immutable. Whether data in the
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
methods.
When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or 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];
| Returns | |
|---|---|
| Type | Description |
boolean |
The aclEnabled. |
getAdvancedSiteSearchConfig()
public abstract AdvancedSiteSearchConfig getAdvancedSiteSearchConfig()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfig |
The advancedSiteSearchConfig. |
getAdvancedSiteSearchConfigOrBuilder()
public abstract AdvancedSiteSearchConfigOrBuilder getAdvancedSiteSearchConfigOrBuilder()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfigOrBuilder |
|
getBillingEstimation()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
DataStore.BillingEstimation |
The billingEstimation. |
getBillingEstimationOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
DataStore.BillingEstimationOrBuilder |
|
getCmekConfig()
public abstract CmekConfig getCmekConfig()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmekConfig |
The cmekConfig. |
getCmekConfigOrBuilder()
public abstract CmekConfigOrBuilder getCmekConfigOrBuilder()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmekConfigOrBuilder |
|
getContentConfig()
public abstract 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 content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
DataStore.ContentConfig |
The contentConfig. |
getContentConfigValue()
public abstract 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 content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for contentConfig. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultSchemaId()
public abstract String getDefaultSchemaId()Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultSchemaId. |
getDefaultSchemaIdBytes()
public abstract ByteString getDefaultSchemaIdBytes()Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultSchemaId. |
getDisplayName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDocumentProcessingConfig()
public abstract DocumentProcessingConfig getDocumentProcessingConfig()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DocumentProcessingConfig |
The documentProcessingConfig. |
getDocumentProcessingConfigOrBuilder()
public abstract DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DocumentProcessingConfigOrBuilder |
|
getHealthcareFhirConfig()
public abstract HealthcareFhirConfig getHealthcareFhirConfig() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HealthcareFhirConfig |
The healthcareFhirConfig. |
getHealthcareFhirConfigOrBuilder()
public abstract HealthcareFhirConfigOrBuilder getHealthcareFhirConfigOrBuilder() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HealthcareFhirConfigOrBuilder |
|
getIdentityMappingStore()
public abstract String getIdentityMappingStore() Immutable. The fully qualified resource name of the associated
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The identityMappingStore. |
getIdentityMappingStoreBytes()
public abstract ByteString getIdentityMappingStoreBytes() Immutable. The fully qualified resource name of the associated
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for identityMappingStore. |
getIndustryVertical()
public abstract IndustryVertical getIndustryVertical()Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
IndustryVertical |
The industryVertical. |
getIndustryVerticalValue()
public abstract int getIndustryVerticalValue()Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for industryVertical. |
getKmsKeyName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The kmsKeyName. |
getKmsKeyNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kmsKeyName. |
getName()
public abstract String 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];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getSolutionTypes(int index)
public abstract SolutionType getSolutionTypes(int index)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
SolutionType |
The solutionTypes at the given index. |
getSolutionTypesCount()
public abstract int getSolutionTypesCount()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The count of solutionTypes. |
getSolutionTypesList()
public abstract List<SolutionType> getSolutionTypesList()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
List<SolutionType> |
A list containing the solutionTypes. |
getSolutionTypesValue(int index)
public abstract int getSolutionTypesValue(int index)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of solutionTypes at the given index. |
getSolutionTypesValueList()
public abstract List<Integer> getSolutionTypesValueList()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for solutionTypes. |
getStartingSchema()
public abstract Schema 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.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
Schema |
The startingSchema. |
getStartingSchemaOrBuilder()
public abstract SchemaOrBuilder getStartingSchemaOrBuilder()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.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
getWorkspaceConfig()
public abstract WorkspaceConfig 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.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
WorkspaceConfig |
The workspaceConfig. |
getWorkspaceConfigOrBuilder()
public abstract WorkspaceConfigOrBuilder getWorkspaceConfigOrBuilder()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.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
WorkspaceConfigOrBuilder |
|
hasAdvancedSiteSearchConfig()
public abstract boolean hasAdvancedSiteSearchConfig()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSiteSearchConfig field is set. |
hasBillingEstimation()
public abstract boolean hasBillingEstimation()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the billingEstimation field is set. |
hasCmekConfig()
public abstract boolean hasCmekConfig()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cmekConfig field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDocumentProcessingConfig()
public abstract boolean hasDocumentProcessingConfig()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the documentProcessingConfig field is set. |
hasHealthcareFhirConfig()
public abstract boolean hasHealthcareFhirConfig() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the healthcareFhirConfig field is set. |
hasStartingSchema()
public abstract boolean hasStartingSchema()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.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startingSchema field is set. |
hasWorkspaceConfig()
public abstract boolean hasWorkspaceConfig()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.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workspaceConfig field is set. |