Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore

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



2847
2848
2849
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2847

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) 


2783
2784
2785
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2783

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) 


2790
2791
2792
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2790

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) 


2795
2796
2797
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2795

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) 


2800
2801
2802
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2800

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) 


2807
2808
2809
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2807

def display_name
  @display_name
end

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



2814
2815
2816
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2814

def document_processing_config
  @document_processing_config
end

#idp_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfig

Identity Provider Config. Corresponds to the JSON property idpConfig

Returns:



2819
2820
2821
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2819

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) 


2824
2825
2826
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2824

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


2832
2833
2834
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2832

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


2840
2841
2842
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2840

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema

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

Returns:



2845
2846
2847
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2845

def starting_schema
  @starting_schema
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2852

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