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.



9775
9776
9777
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9775

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) 


9701
9702
9703
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9701

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

Returns:

  • (String) 


9708
9709
9710
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9708

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) 


9713
9714
9715
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9713

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) 


9718
9719
9720
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9718

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) 


9725
9726
9727
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9725

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

Returns:



9732
9733
9734
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9732

def document_processing_config
  @document_processing_config
end

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

Identity Provider Config. Corresponds to the JSON property idpConfig

Returns:



9737
9738
9739
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9737

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) 


9742
9743
9744
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9742

def industry_vertical
  @industry_vertical
end

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

Language info for DataStore. Corresponds to the JSON property languageInfo

Returns:



9747
9748
9749
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9747

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) 


9755
9756
9757
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9755

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

Returns:

  • (Array<String>) 


9763
9764
9765
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9763

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:



9768
9769
9770
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9768

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:



9773
9774
9775
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9773

def workspace_config
  @workspace_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 9780

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