Package com.google.cloud.discoveryengine.v1beta

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

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Immutable. The full resource name of the data store.
 Format:
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      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.v1beta.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.v1beta.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.v1beta.DataStore.industry_vertical]:

 * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
 * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
 solutions cannot be enrolled.
      repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;
      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.v1beta.DataStore.industry_vertical]:

 * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
 * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
 solutions cannot be enrolled.
      repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;
      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.v1beta.DataStore.industry_vertical]:

 * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
 * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
 solutions cannot be enrolled.
      repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;
      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.v1beta.DataStore.industry_vertical]:

 * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
 * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
 solutions cannot be enrolled.
      repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;
      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.v1beta.DataStore.industry_vertical]:

 * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
 * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
 solutions cannot be enrolled.
      repeated .google.cloud.discoveryengine.v1beta.SolutionType solution_types = 5;
      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.v1beta.Schema] asscociated 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.v1beta.Schema] asscociated 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.v1beta.DataStore.ContentConfig.NO_CONTENT].
      .google.cloud.discoveryengine.v1beta.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.v1beta.DataStore.ContentConfig.NO_CONTENT].
      .google.cloud.discoveryengine.v1beta.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The contentConfig.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasLanguageInfo

      boolean hasLanguageInfo()
       Language info for DataStore.
      .google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;
      Returns:
      Whether the languageInfo field is set.

    • getLanguageInfo

      LanguageInfo getLanguageInfo()
       Language info for DataStore.
      .google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;
      Returns:
      The languageInfo.

    • getLanguageInfoOrBuilder

      LanguageInfoOrBuilder getLanguageInfoOrBuilder()
       Language info for DataStore.
      .google.cloud.discoveryengine.v1beta.LanguageInfo language_info = 14;

    • hasNaturalLanguageQueryUnderstandingConfig

      boolean hasNaturalLanguageQueryUnderstandingConfig()
       Optional. Configuration for Natural Language Query Understanding.
      .google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the naturalLanguageQueryUnderstandingConfig field is set.

    • getNaturalLanguageQueryUnderstandingConfig

      NaturalLanguageQueryUnderstandingConfig getNaturalLanguageQueryUnderstandingConfig()
       Optional. Configuration for Natural Language Query Understanding.
      .google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The naturalLanguageQueryUnderstandingConfig.

    • getNaturalLanguageQueryUnderstandingConfigOrBuilder

      NaturalLanguageQueryUnderstandingConfigOrBuilder getNaturalLanguageQueryUnderstandingConfigOrBuilder()
       Optional. Configuration for Natural Language Query Understanding.
      .google.cloud.discoveryengine.v1beta.NaturalLanguageQueryUnderstandingConfig natural_language_query_understanding_config = 34 [(.google.api.field_behavior) = OPTIONAL];

    • hasBillingEstimation

      boolean hasBillingEstimation()
       Output only. Data size estimation for billing.
      .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasWorkspaceConfig

      boolean hasWorkspaceConfig()
       Config to store data store type configuration for workspace data. This
 must be set when
 [DataStore.content_config][google.cloud.discoveryengine.v1beta.DataStore.content_config]
 is set as
 [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
      .google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;
      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.v1beta.DataStore.content_config]
 is set as
 [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
      .google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;
      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.v1beta.DataStore.content_config]
 is set as
 [DataStore.ContentConfig.GOOGLE_WORKSPACE][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.GOOGLE_WORKSPACE].
      .google.cloud.discoveryengine.v1beta.WorkspaceConfig workspace_config = 25;

    • hasDocumentProcessingConfig

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

    • getDocumentProcessingConfig

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

    • getDocumentProcessingConfigOrBuilder

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

    • hasStartingSchema

      boolean hasStartingSchema()
       The start schema to use for this
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
 provisioning it. If unset, a default vertical specialized schema will be
 used.

 This field is only used by [CreateDataStore][] API, and will be ignored if
 used in other APIs. This field will be omitted from all API responses
 including [CreateDataStore][] API. To retrieve a schema of a
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], use
 [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
 API instead.

 The provided schema will be validated against certain rules on schema.
 Learn more from [this
 doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
      .google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;
      Returns:
      Whether the startingSchema field is set.

    • getStartingSchema

      Schema getStartingSchema()
       The start schema to use for this
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
 provisioning it. If unset, a default vertical specialized schema will be
 used.

 This field is only used by [CreateDataStore][] API, and will be ignored if
 used in other APIs. This field will be omitted from all API responses
 including [CreateDataStore][] API. To retrieve a schema of a
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], use
 [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
 API instead.

 The provided schema will be validated against certain rules on schema.
 Learn more from [this
 doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
      .google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;
      Returns:
      The startingSchema.

    • getStartingSchemaOrBuilder

      SchemaOrBuilder getStartingSchemaOrBuilder()
       The start schema to use for this
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
 provisioning it. If unset, a default vertical specialized schema will be
 used.

 This field is only used by [CreateDataStore][] API, and will be ignored if
 used in other APIs. This field will be omitted from all API responses
 including [CreateDataStore][] API. To retrieve a schema of a
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], use
 [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
 API instead.

 The provided schema will be validated against certain rules on schema.
 Learn more from [this
 doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
      .google.cloud.discoveryengine.v1beta.Schema starting_schema = 28;

    • hasServingConfigDataStore

      boolean hasServingConfigDataStore()
       Optional. Stores serving config at DataStore level.
      .google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the servingConfigDataStore field is set.

    • getServingConfigDataStore

      DataStore.ServingConfigDataStore getServingConfigDataStore()
       Optional. Stores serving config at DataStore level.
      .google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The servingConfigDataStore.

    • getServingConfigDataStoreOrBuilder

      DataStore.ServingConfigDataStoreOrBuilder getServingConfigDataStoreOrBuilder()
       Optional. Stores serving config at DataStore level.
      .google.cloud.discoveryengine.v1beta.DataStore.ServingConfigDataStore serving_config_data_store = 30 [(.google.api.field_behavior) = OPTIONAL];