Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

DataStore captures global settings and configs at the DataStore level.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaDataStore

Returns a new instance of GoogleCloudDiscoveryengineV1betaDataStore.



24076
24077
24078
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24076

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acl_enabled ⇒ Boolean Also known as: acl_enabled?

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. Corresponds to the JSON property aclEnabled

Returns:

  • (Boolean) 


23940
23941
23942
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23940

def acl_enabled
  @acl_enabled
end

#advanced_site_search_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig

Configuration data for advance site search. Corresponds to the JSON property advancedSiteSearchConfig

Returns:



23946
23947
23948
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23946

def advanced_site_search_config
  @advanced_site_search_config
end

#billing_estimation ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation

Estimation of data size per data store. Corresponds to the JSON property billingEstimation

Returns:



23951
23952
23953
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23951

def billing_estimation
  @billing_estimation
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys. Corresponds to the JSON property cmekConfig

Returns:



23956
23957
23958
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23956

def cmek_config
  @cmek_config
end

#configurable_billing_approach ⇒ String

Optional. Configuration for configurable billing approach. See Corresponds to the JSON property configurableBillingApproach

Returns:

  • (String) 


23961
23962
23963
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23961

def configurable_billing_approach
  @configurable_billing_approach
end

#configurable_billing_approach_update_time ⇒ String

Output only. The timestamp when configurable_billing_approach was last updated. Corresponds to the JSON property configurableBillingApproachUpdateTime

Returns:

  • (String) 


23966
23967
23968
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23966

def configurable_billing_approach_update_time
  @configurable_billing_approach_update_time
end

#content_config ⇒ String

Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. Corresponds to the JSON property contentConfig

Returns:

  • (String) 


23972
23973
23974
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23972

def content_config
  @content_config
end

#create_time ⇒ String

Output only. Timestamp the DataStore was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


23977
23978
23979
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23977

def create_time
  @create_time
end

#default_schema_id ⇒ String

Output only. The id of the default Schema associated to this data store. Corresponds to the JSON property defaultSchemaId

Returns:

  • (String) 


23982
23983
23984
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23982

def default_schema_id
  @default_schema_id
end

#display_name ⇒ String

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. Corresponds to the JSON property displayName

Returns:

  • (String) 


23989
23990
23991
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23989

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. Corresponds to the JSON property documentProcessingConfig

Returns:



23996
23997
23998
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 23996

def document_processing_config
  @document_processing_config
end

#federated_search_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig

Stores information for federated search. Corresponds to the JSON property federatedSearchConfig

Returns:



24001
24002
24003
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24001

def federated_search_config
  @federated_search_config
end

#healthcare_fhir_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig

Config to data store for HEALTHCARE_FHIR vertical. Corresponds to the JSON property healthcareFhirConfig

Returns:



24006
24007
24008
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24006

def healthcare_fhir_config
  @healthcare_fhir_config
end

#identity_mapping_store ⇒ String

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`. Corresponds to the JSON propertyidentityMappingStore`

Returns:

  • (String) 


24014
24015
24016
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24014

def identity_mapping_store
  @identity_mapping_store
end

#industry_vertical ⇒ String

Immutable. The industry vertical that the data store registers. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


24019
24020
24021
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24019

def industry_vertical
  @industry_vertical
end

#is_infobot_faq_data_store ⇒ Boolean Also known as: is_infobot_faq_data_store?

Optional. If set, this DataStore is an Infobot FAQ DataStore. Corresponds to the JSON property isInfobotFaqDataStore

Returns:

  • (Boolean) 


24024
24025
24026
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24024

def is_infobot_faq_data_store
  @is_infobot_faq_data_store
end

#kms_key_name ⇒ String

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. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


24033
24034
24035
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24033

def kms_key_name
  @kms_key_name
end

#language_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaLanguageInfo

Language info for DataStore. Corresponds to the JSON property languageInfo

Returns:



24038
24039
24040
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24038

def language_info
  @language_info
end

#name ⇒ String

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. Corresponds to the JSON propertyname`

Returns:

  • (String) 


24046
24047
24048
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24046

def name
  @name
end

#natural_language_query_understanding_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig

Configuration for Natural Language Query Understanding. Corresponds to the JSON property naturalLanguageQueryUnderstandingConfig

Returns:



24051
24052
24053
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24051

def natural_language_query_understanding_config
  @natural_language_query_understanding_config
end

#serving_config_data_store ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore

Stores information regarding the serving configurations at DataStore level. Corresponds to the JSON property servingConfigDataStore

Returns:



24056
24057
24058
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24056

def serving_config_data_store
  @serving_config_data_store
end

#solution_types ⇒ Array<String>

The solutions that the data store enrolls. Available solutions for each industry_vertical: * MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH. * SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled. Corresponds to the JSON property solutionTypes

Returns:

  • (Array<String>) 


24064
24065
24066
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24064

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSchema

Defines the structure and layout of a type of document data. Corresponds to the JSON property startingSchema

Returns:



24069
24070
24071
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24069

def starting_schema
  @starting_schema
end

#workspace_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaWorkspaceConfig

Config to store data store type configuration for workspace data Corresponds to the JSON property workspaceConfig

Returns:



24074
24075
24076
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24074

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24081
24082
24083
24084
24085
24086
24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24081

def update!(**args)
  @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled)
  @advanced_site_search_config = args[:advanced_site_search_config] if args.key?(:advanced_site_search_config)
  @billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
  @configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
  @configurable_billing_approach_update_time = args[:configurable_billing_approach_update_time] if args.key?(:configurable_billing_approach_update_time)
  @content_config = args[:content_config] if args.key?(:content_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @document_processing_config = args[:document_processing_config] if args.key?(:document_processing_config)
  @federated_search_config = args[:federated_search_config] if args.key?(:federated_search_config)
  @healthcare_fhir_config = args[:healthcare_fhir_config] if args.key?(:healthcare_fhir_config)
  @identity_mapping_store = args[:identity_mapping_store] if args.key?(:identity_mapping_store)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @is_infobot_faq_data_store = args[:is_infobot_faq_data_store] if args.key?(:is_infobot_faq_data_store)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @language_info = args[:language_info] if args.key?(:language_info)
  @name = args[:name] if args.key?(:name)
  @natural_language_query_understanding_config = args[:natural_language_query_understanding_config] if args.key?(:natural_language_query_understanding_config)
  @serving_config_data_store = args[:serving_config_data_store] if args.key?(:serving_config_data_store)
  @solution_types = args[:solution_types] if args.key?(:solution_types)
  @starting_schema = args[:starting_schema] if args.key?(:starting_schema)
  @workspace_config = args[:workspace_config] if args.key?(:workspace_config)
end