Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataStore
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDataStore
- 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
-
#acl_enabled ⇒ Boolean
(also: #acl_enabled?)
Immutable.
-
#content_config ⇒ String
Immutable.
-
#create_time ⇒ String
Output only.
-
#default_schema_id ⇒ String
Output only.
-
#display_name ⇒ String
Required.
-
#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
A singleton resource of DataStore.
-
#idp_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdpConfig
Identity Provider Config.
-
#industry_vertical ⇒ String
Immutable.
-
#language_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaLanguageInfo
Language info for DataStore.
-
#name ⇒ String
Immutable.
-
#solution_types ⇒ Array<String>
The solutions that the data store enrolls.
-
#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSchema
Defines the structure and layout of a type of document data.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDataStore
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaDataStore.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDataStore
Returns a new instance of GoogleCloudDiscoveryengineV1alphaDataStore.
9183 9184 9185 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9183 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
9114 9115 9116 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9114 def acl_enabled @acl_enabled 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
9121 9122 9123 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9121 def content_config @content_config end |
#create_time ⇒ String
Output only. Timestamp the DataStore was created at.
Corresponds to the JSON property createTime
9126 9127 9128 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9126 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
9131 9132 9133 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9131 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
9138 9139 9140 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9138 def display_name @display_name end |
#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
A singleton resource of DataStore. It's empty when DataStore is created, which
defaults to digital parser. The first call to DataStoreService.
UpdateDocumentProcessingConfig method will initialize the config.
Corresponds to the JSON property documentProcessingConfig
9145 9146 9147 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9145 def document_processing_config @document_processing_config end |
#idp_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdpConfig
Identity Provider Config.
Corresponds to the JSON property idpConfig
9150 9151 9152 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9150 def idp_config @idp_config end |
#industry_vertical ⇒ String
Immutable. The industry vertical that the data store registers.
Corresponds to the JSON property industryVertical
9155 9156 9157 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9155 def industry_vertical @industry_vertical end |
#language_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaLanguageInfo
Language info for DataStore.
Corresponds to the JSON property languageInfo
9160 9161 9162 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9160 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 property
name`
9168 9169 9170 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9168 def name @name 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
9176 9177 9178 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9176 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
9181 9182 9183 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9181 def starting_schema @starting_schema end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9188 def update!(**args) @acl_enabled = args[:acl_enabled] if args.key?(:acl_enabled) @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) @language_info = args[:language_info] if args.key?(:language_info) @name = args[:name] if args.key?(:name) @solution_types = args[:solution_types] if args.key?(:solution_types) @starting_schema = args[:starting_schema] if args.key?(:starting_schema) end |