Package com.google.cloud.discoveryengine.v1

Interface DataStoreOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DataStore, DataStore.Builder
@Generated public interface DataStoreOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDisplayName

      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:
      The displayName.

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getIndustryVerticalValue

      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:
      The enum numeric value on the wire for industryVertical.

    • getIndustryVertical

      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:
      The industryVertical.

    • getSolutionTypesList

      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;
      Returns:
      A list containing the solutionTypes.

    • getSolutionTypesCount

      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;
      Returns:
      The count of solutionTypes.

    • getSolutionTypes

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The solutionTypes at the given index.

    • getSolutionTypesValueList

      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;
      Returns:
      A list containing the enum numeric values on the wire for solutionTypes.

    • getSolutionTypesValue

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of solutionTypes at the given index.

    • getDefaultSchemaId

      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];
      Returns:
      The defaultSchemaId.

    • getDefaultSchemaIdBytes

      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];
      Returns:
      The bytes for defaultSchemaId.

    • getContentConfigValue

      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];
      Returns:
      The enum numeric value on the wire for contentConfig.

    • getContentConfig

      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];
      Returns:
      The contentConfig.

    • hasCreateTime

      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];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasAdvancedSiteSearchConfig

      boolean hasAdvancedSiteSearchConfig()
       Optional. Configuration for advanced site search.
      .google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the advancedSiteSearchConfig field is set.

    • getAdvancedSiteSearchConfig

      AdvancedSiteSearchConfig getAdvancedSiteSearchConfig()
       Optional. Configuration for advanced site search.
      .google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The advancedSiteSearchConfig.

    • getAdvancedSiteSearchConfigOrBuilder

      AdvancedSiteSearchConfigOrBuilder getAdvancedSiteSearchConfigOrBuilder()
       Optional. Configuration for advanced site search.
      .google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];

    • hasNaturalLanguageQueryUnderstandingConfig

      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];
      Returns:
      Whether the naturalLanguageQueryUnderstandingConfig field is set.

    • getNaturalLanguageQueryUnderstandingConfig

      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];
      Returns:
      The naturalLanguageQueryUnderstandingConfig.

    • getNaturalLanguageQueryUnderstandingConfigOrBuilder

      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];

    • getKmsKeyName

      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:
      The kmsKeyName.

    • getKmsKeyNameBytes

      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];
      Returns:
      The bytes for kmsKeyName.

    • hasCmekConfig

      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:
      Whether the cmekConfig field is set.

    • getCmekConfig

      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:
      The cmekConfig.

    • getCmekConfigOrBuilder

      CmekConfigOrBuilder getCmekConfigOrBuilder()
       Output only. CMEK-related information for the DataStore.
      .google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasBillingEstimation

      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:
      Whether the billingEstimation field is set.

    • getBillingEstimation

      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:
      The billingEstimation.

    • getBillingEstimationOrBuilder

      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];

    • getAclEnabled

      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];
      Returns:
      The aclEnabled.

    • hasWorkspaceConfig

      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;
      Returns:
      Whether the workspaceConfig field is set.

    • getWorkspaceConfig

      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;
      Returns:
      The workspaceConfig.

    • getWorkspaceConfigOrBuilder

      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;

    • hasDocumentProcessingConfig

      boolean hasDocumentProcessingConfig()
       Configuration for Document understanding and enrichment.
      .google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
      Returns:
      Whether the documentProcessingConfig field is set.

    • getDocumentProcessingConfig

      DocumentProcessingConfig getDocumentProcessingConfig()
       Configuration for Document understanding and enrichment.
      .google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
      Returns:
      The documentProcessingConfig.

    • getDocumentProcessingConfigOrBuilder

      DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()
       Configuration for Document understanding and enrichment.
      .google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;

    • hasStartingSchema

      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;
      Returns:
      Whether the startingSchema field is set.

    • getStartingSchema

      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;
      Returns:
      The startingSchema.

    • getStartingSchemaOrBuilder

      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;

    • hasHealthcareFhirConfig

      boolean hasHealthcareFhirConfig()
       Optional. Configuration for `HEALTHCARE_FHIR` vertical.
      .google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the healthcareFhirConfig field is set.

    • getHealthcareFhirConfig

      HealthcareFhirConfig getHealthcareFhirConfig()
       Optional. Configuration for `HEALTHCARE_FHIR` vertical.
      .google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The healthcareFhirConfig.

    • getHealthcareFhirConfigOrBuilder

      HealthcareFhirConfigOrBuilder getHealthcareFhirConfigOrBuilder()
       Optional. Configuration for `HEALTHCARE_FHIR` vertical.
      .google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getIdentityMappingStore

      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) = { ... }
      Returns:
      The identityMappingStore.

    • getIdentityMappingStoreBytes

      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) = { ... }
      Returns:
      The bytes for identityMappingStore.