Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataStore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/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) ⇒ GoogleCloudDiscoveryengineV1alphaDataStore

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDataStore.



10331
10332
10333
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10331

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) 


10224
10225
10226
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10224

def acl_enabled
  @acl_enabled
end

#advanced_site_search_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig

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

Returns:



10230
10231
10232
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10230

def advanced_site_search_config
  @advanced_site_search_config
end

#billing_estimation ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation

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

Returns:



10235
10236
10237
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10235

def billing_estimation
  @billing_estimation
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCmekConfig

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

Returns:



10240
10241
10242
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10240

def cmek_config
  @cmek_config
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) 


10246
10247
10248
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10246

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) 


10251
10252
10253
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10251

def create_time
  @create_time
end

#default_schema_id ⇒ String

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

Returns:

  • (String) 


10256
10257
10258
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10256

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) 


10263
10264
10265
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10263

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig

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:



10270
10271
10272
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10270

def document_processing_config
  @document_processing_config
end

#idp_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdpConfig

Identity Provider Config. Corresponds to the JSON property idpConfig

Returns:



10275
10276
10277
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10275

def idp_config
  @idp_config
end

#industry_vertical ⇒ String

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

Returns:

  • (String) 


10280
10281
10282
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10280

def industry_vertical
  @industry_vertical
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) 


10288
10289
10290
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10288

def kms_key_name
  @kms_key_name
end

#language_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaLanguageInfo

Language info for DataStore. Corresponds to the JSON property languageInfo

Returns:



10293
10294
10295
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10293

def language_info
  @language_info
end

#name ⇒ String

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

Returns:

  • (String) 


10301
10302
10303
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10301

def name
  @name
end

#natural_language_query_understanding_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig

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

Returns:



10306
10307
10308
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10306

def natural_language_query_understanding_config
  @natural_language_query_understanding_config
end

#serving_config_data_store ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore

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

Returns:



10311
10312
10313
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10311

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>) 


10319
10320
10321
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10319

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema

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

Returns:



10324
10325
10326
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10324

def starting_schema
  @starting_schema
end

#workspace_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaWorkspaceConfig

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

Returns:



10329
10330
10331
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10329

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10336

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)
  @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)
  @idp_config = args[:idp_config] if args.key?(:idp_config)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @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