Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DataStore

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

Returns a new instance of GoogleCloudDiscoveryengineV1DataStore.



3080
3081
3082
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3080

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

Instance Attribute Details

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


3028
3029
3030
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3028

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) 


3033
3034
3035
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3033

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) 


3038
3039
3040
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3038

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) 


3045
3046
3047
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3045

def display_name
  @display_name
end

#document_processing_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentProcessingConfig

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:



3052
3053
3054
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3052

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) 


3057
3058
3059
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3057

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) 


3065
3066
3067
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3065

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


3073
3074
3075
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3073

def solution_types
  @solution_types
end

#starting_schema ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema

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

Returns:



3078
3079
3080
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3078

def starting_schema
  @starting_schema
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3085

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