Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::DataStore (v0.9.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::DataStore.

DataStore captures global settings and configs at the DataStore level.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#content_config

def content_config() -> ::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig
Returns

#content_config=

def content_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#default_schema_id

def default_schema_id() -> ::String
Returns
  • (::String) — Output only. The id of the default Schema asscociated to this data store.

#display_name

def display_name() -> ::String
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#document_processing_config

def document_processing_config() -> ::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig
Returns

#document_processing_config=

def document_processing_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig
Parameter
Returns

#industry_vertical

def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical
Returns

#industry_vertical=

def industry_vertical=(value) -> ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#solution_types

def solution_types() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>
Returns

#solution_types=

def solution_types=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SolutionType>
Parameter
Returns

#starting_schema

def starting_schema() -> ::Google::Cloud::DiscoveryEngine::V1::Schema
Returns
  • (::Google::Cloud::DiscoveryEngine::V1::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

    This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

    The provided schema will be validated against certain rules on schema. Learn more from this doc.

#starting_schema=

def starting_schema=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Schema
Parameter
  • value (::Google::Cloud::DiscoveryEngine::V1::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

    This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

    The provided schema will be validated against certain rules on schema. Learn more from this doc.

Returns
  • (::Google::Cloud::DiscoveryEngine::V1::Schema) — The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.

    This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.

    The provided schema will be validated against certain rules on schema. Learn more from this doc.