Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStore

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

Returns a new instance of GoogleCloudDiscoveryengineV1betaDataStore.



15135
15136
15137
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15135

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

Instance Attribute Details

#advanced_site_search_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig

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

Returns:



15039
15040
15041
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15039

def advanced_site_search_config
  @advanced_site_search_config
end

#billing_estimation ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation

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

Returns:



15044
15045
15046
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15044

def billing_estimation
  @billing_estimation
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCmekConfig

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

Returns:



15049
15050
15051
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15049

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) 


15055
15056
15057
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15055

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) 


15060
15061
15062
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15060

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) 


15065
15066
15067
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15065

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) 


15072
15073
15074
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15072

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::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:



15079
15080
15081
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15079

def document_processing_config
  @document_processing_config
end

#industry_vertical ⇒ String

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

Returns:

  • (String) 


15084
15085
15086
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15084

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) 


15092
15093
15094
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15092

def kms_key_name
  @kms_key_name
end

#language_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaLanguageInfo

Language info for DataStore. Corresponds to the JSON property languageInfo

Returns:



15097
15098
15099
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15097

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) 


15105
15106
15107
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15105

def name
  @name
end

#natural_language_query_understanding_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig

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

Returns:



15110
15111
15112
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15110

def natural_language_query_understanding_config
  @natural_language_query_understanding_config
end

#serving_config_data_store ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore

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

Returns:



15115
15116
15117
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15115

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


15123
15124
15125
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15123

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSchema

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

Returns:



15128
15129
15130
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15128

def starting_schema
  @starting_schema
end

#workspace_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaWorkspaceConfig

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

Returns:



15133
15134
15135
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15133

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15140

def update!(**args)
  @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)
  @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