Package com.google.cloud.discoveryengine.v1

Class DataStore

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1.DataStore
All Implemented Interfaces:
DataStoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataStore extends com.google.protobuf.GeneratedMessage implements DataStoreOrBuilder
 DataStore captures global settings and configs at the DataStore level.
Protobuf type google.cloud.discoveryengine.v1.DataStore
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • INDUSTRY_VERTICAL_FIELD_NUMBER

      public static final int INDUSTRY_VERTICAL_FIELD_NUMBER
      See Also:

    • SOLUTION_TYPES_FIELD_NUMBER

      public static final int SOLUTION_TYPES_FIELD_NUMBER
      See Also:

    • DEFAULT_SCHEMA_ID_FIELD_NUMBER

      public static final int DEFAULT_SCHEMA_ID_FIELD_NUMBER
      See Also:

    • CONTENT_CONFIG_FIELD_NUMBER

      public static final int CONTENT_CONFIG_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • ADVANCED_SITE_SEARCH_CONFIG_FIELD_NUMBER

      public static final int ADVANCED_SITE_SEARCH_CONFIG_FIELD_NUMBER
      See Also:

    • NATURAL_LANGUAGE_QUERY_UNDERSTANDING_CONFIG_FIELD_NUMBER

      public static final int NATURAL_LANGUAGE_QUERY_UNDERSTANDING_CONFIG_FIELD_NUMBER
      See Also:

    • KMS_KEY_NAME_FIELD_NUMBER

      public static final int KMS_KEY_NAME_FIELD_NUMBER
      See Also:

    • CMEK_CONFIG_FIELD_NUMBER

      public static final int CMEK_CONFIG_FIELD_NUMBER
      See Also:

    • BILLING_ESTIMATION_FIELD_NUMBER

      public static final int BILLING_ESTIMATION_FIELD_NUMBER
      See Also:

    • ACL_ENABLED_FIELD_NUMBER

      public static final int ACL_ENABLED_FIELD_NUMBER
      See Also:

    • WORKSPACE_CONFIG_FIELD_NUMBER

      public static final int WORKSPACE_CONFIG_FIELD_NUMBER
      See Also:

    • DOCUMENT_PROCESSING_CONFIG_FIELD_NUMBER

      public static final int DOCUMENT_PROCESSING_CONFIG_FIELD_NUMBER
      See Also:

    • STARTING_SCHEMA_FIELD_NUMBER

      public static final int STARTING_SCHEMA_FIELD_NUMBER
      See Also:

    • HEALTHCARE_FHIR_CONFIG_FIELD_NUMBER

      public static final int HEALTHCARE_FHIR_CONFIG_FIELD_NUMBER
      See Also:

    • IDENTITY_MAPPING_STORE_FIELD_NUMBER

      public static final int IDENTITY_MAPPING_STORE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface DataStoreOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface DataStoreOrBuilder
      Returns:
      The bytes for name.

    • 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.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface DataStoreOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface DataStoreOrBuilder
      Returns:
      The bytes for displayName.

    • getIndustryVerticalValue

      public int getIndustryVerticalValue()
       Immutable. The industry vertical that the data store registers.
      .google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getIndustryVerticalValue in interface DataStoreOrBuilder
      Returns:
      The enum numeric value on the wire for industryVertical.

    • getIndustryVertical

      public IndustryVertical getIndustryVertical()
       Immutable. The industry vertical that the data store registers.
      .google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getIndustryVertical in interface DataStoreOrBuilder
      Returns:
      The industryVertical.

    • getSolutionTypesList

      public 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;
      Specified by:
      getSolutionTypesList in interface DataStoreOrBuilder
      Returns:
      A list containing the solutionTypes.

    • getSolutionTypesCount

      public 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;
      Specified by:
      getSolutionTypesCount in interface DataStoreOrBuilder
      Returns:
      The count of solutionTypes.

    • getSolutionTypes

      public 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;
      Specified by:
      getSolutionTypes in interface DataStoreOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The solutionTypes at the given index.

    • getSolutionTypesValueList

      public 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;
      Specified by:
      getSolutionTypesValueList in interface DataStoreOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for solutionTypes.

    • getSolutionTypesValue

      public 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;
      Specified by:
      getSolutionTypesValue in interface DataStoreOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of solutionTypes at the given index.

    • getDefaultSchemaId

      public 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];
      Specified by:
      getDefaultSchemaId in interface DataStoreOrBuilder
      Returns:
      The defaultSchemaId.

    • getDefaultSchemaIdBytes

      public 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];
      Specified by:
      getDefaultSchemaIdBytes in interface DataStoreOrBuilder
      Returns:
      The bytes for defaultSchemaId.

    • getContentConfigValue

      public 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];
      Specified by:
      getContentConfigValue in interface DataStoreOrBuilder
      Returns:
      The enum numeric value on the wire for contentConfig.

    • getContentConfig

      public 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];
      Specified by:
      getContentConfig in interface DataStoreOrBuilder
      Returns:
      The contentConfig.

    • hasCreateTime

      public 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];
      Specified by:
      hasCreateTime in interface DataStoreOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface DataStoreOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface DataStoreOrBuilder

    • hasAdvancedSiteSearchConfig

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

    • getAdvancedSiteSearchConfig

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

    • getAdvancedSiteSearchConfigOrBuilder

      public AdvancedSiteSearchConfigOrBuilder getAdvancedSiteSearchConfigOrBuilder()
       Optional. Configuration for advanced site search.
      .google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdvancedSiteSearchConfigOrBuilder in interface DataStoreOrBuilder

    • hasNaturalLanguageQueryUnderstandingConfig

      public 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];
      Specified by:
      hasNaturalLanguageQueryUnderstandingConfig in interface DataStoreOrBuilder
      Returns:
      Whether the naturalLanguageQueryUnderstandingConfig field is set.

    • getNaturalLanguageQueryUnderstandingConfig

      public 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];
      Specified by:
      getNaturalLanguageQueryUnderstandingConfig in interface DataStoreOrBuilder
      Returns:
      The naturalLanguageQueryUnderstandingConfig.

    • getNaturalLanguageQueryUnderstandingConfigOrBuilder

      public 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];
      Specified by:
      getNaturalLanguageQueryUnderstandingConfigOrBuilder in interface DataStoreOrBuilder

    • getKmsKeyName

      public 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];
      Specified by:
      getKmsKeyName in interface DataStoreOrBuilder
      Returns:
      The kmsKeyName.

    • getKmsKeyNameBytes

      public 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];
      Specified by:
      getKmsKeyNameBytes in interface DataStoreOrBuilder
      Returns:
      The bytes for kmsKeyName.

    • hasCmekConfig

      public boolean hasCmekConfig()
       Output only. CMEK-related information for the DataStore.
      .google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCmekConfig in interface DataStoreOrBuilder
      Returns:
      Whether the cmekConfig field is set.

    • getCmekConfig

      public CmekConfig getCmekConfig()
       Output only. CMEK-related information for the DataStore.
      .google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCmekConfig in interface DataStoreOrBuilder
      Returns:
      The cmekConfig.

    • getCmekConfigOrBuilder

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

    • hasBillingEstimation

      public boolean hasBillingEstimation()
       Output only. Data size estimation for billing.
      .google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasBillingEstimation in interface DataStoreOrBuilder
      Returns:
      Whether the billingEstimation field is set.

    • getBillingEstimation

      public 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];
      Specified by:
      getBillingEstimation in interface DataStoreOrBuilder
      Returns:
      The billingEstimation.

    • getBillingEstimationOrBuilder

      public 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];
      Specified by:
      getBillingEstimationOrBuilder in interface DataStoreOrBuilder

    • getAclEnabled

      public 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];
      Specified by:
      getAclEnabled in interface DataStoreOrBuilder
      Returns:
      The aclEnabled.

    • hasWorkspaceConfig

      public 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;
      Specified by:
      hasWorkspaceConfig in interface DataStoreOrBuilder
      Returns:
      Whether the workspaceConfig field is set.

    • getWorkspaceConfig

      public 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;
      Specified by:
      getWorkspaceConfig in interface DataStoreOrBuilder
      Returns:
      The workspaceConfig.

    • getWorkspaceConfigOrBuilder

      public 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;
      Specified by:
      getWorkspaceConfigOrBuilder in interface DataStoreOrBuilder

    • hasDocumentProcessingConfig

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

    • getDocumentProcessingConfig

      public DocumentProcessingConfig getDocumentProcessingConfig()
       Configuration for Document understanding and enrichment.
      .google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
      Specified by:
      getDocumentProcessingConfig in interface DataStoreOrBuilder
      Returns:
      The documentProcessingConfig.

    • getDocumentProcessingConfigOrBuilder

      public DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()
       Configuration for Document understanding and enrichment.
      .google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
      Specified by:
      getDocumentProcessingConfigOrBuilder in interface DataStoreOrBuilder

    • hasStartingSchema

      public 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;
      Specified by:
      hasStartingSchema in interface DataStoreOrBuilder
      Returns:
      Whether the startingSchema field is set.

    • getStartingSchema

      public 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;
      Specified by:
      getStartingSchema in interface DataStoreOrBuilder
      Returns:
      The startingSchema.

    • getStartingSchemaOrBuilder

      public 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;
      Specified by:
      getStartingSchemaOrBuilder in interface DataStoreOrBuilder

    • hasHealthcareFhirConfig

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

    • getHealthcareFhirConfig

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

    • getHealthcareFhirConfigOrBuilder

      public HealthcareFhirConfigOrBuilder getHealthcareFhirConfigOrBuilder()
       Optional. Configuration for `HEALTHCARE_FHIR` vertical.
      .google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHealthcareFhirConfigOrBuilder in interface DataStoreOrBuilder

    • getIdentityMappingStore

      public 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) = { ... }
      Specified by:
      getIdentityMappingStore in interface DataStoreOrBuilder
      Returns:
      The identityMappingStore.

    • getIdentityMappingStoreBytes

      public 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) = { ... }
      Specified by:
      getIdentityMappingStoreBytes in interface DataStoreOrBuilder
      Returns:
      The bytes for identityMappingStore.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataStore parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataStore parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStore parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataStore parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataStore parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStore parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStore parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataStore.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataStore.Builder newBuilder()

    • newBuilder

      public static DataStore.Builder newBuilder(DataStore prototype)

    • toBuilder

      public DataStore.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataStore.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataStore getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataStore> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataStore> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DataStore getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder