Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::CreateDataStoreRequest (v2.3.0)

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

Request for DataStoreService.CreateDataStore method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cmek_config_name

def cmek_config_name() -> ::String
Returns
  • (::String) — Resource name of the CmekConfig to use for protecting this DataStore.

    Note: The following fields are mutually exclusive: cmek_config_name, disable_cmek. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cmek_config_name=

def cmek_config_name=(value) -> ::String
Parameter
  • value (::String) — Resource name of the CmekConfig to use for protecting this DataStore.

    Note: The following fields are mutually exclusive: cmek_config_name, disable_cmek. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — Resource name of the CmekConfig to use for protecting this DataStore.

    Note: The following fields are mutually exclusive: cmek_config_name, disable_cmek. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_advanced_site_search

def create_advanced_site_search() -> ::Boolean
Returns
  • (::Boolean) — A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

#create_advanced_site_search=

def create_advanced_site_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.
Returns
  • (::Boolean) — A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

#data_store

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

#data_store=

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

#data_store_id

def data_store_id() -> ::String
Returns
  • (::String) — Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

    This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#data_store_id=

def data_store_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

    This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
  • (::String) — Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

    This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#disable_cmek

def disable_cmek() -> ::Boolean
Returns
  • (::Boolean) — DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

    Note: The following fields are mutually exclusive: disable_cmek, cmek_config_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#disable_cmek=

def disable_cmek=(value) -> ::Boolean
Parameter
  • value (::Boolean) — DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

    Note: The following fields are mutually exclusive: disable_cmek, cmek_config_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.

    Note: The following fields are mutually exclusive: disable_cmek, cmek_config_name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.
Returns
  • (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

#skip_default_schema_creation

def skip_default_schema_creation() -> ::Boolean
Returns
  • (::Boolean) — A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

    If set to true, you must manually create a schema for the data store before any documents can be ingested.

    This flag cannot be specified if data_store.starting_schema is specified.

#skip_default_schema_creation=

def skip_default_schema_creation=(value) -> ::Boolean
Parameter
  • value (::Boolean) — A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

    If set to true, you must manually create a schema for the data store before any documents can be ingested.

    This flag cannot be specified if data_store.starting_schema is specified.

Returns
  • (::Boolean) — A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

    If set to true, you must manually create a schema for the data store before any documents can be ingested.

    This flag cannot be specified if data_store.starting_schema is specified.