Class: Google::Cloud::DiscoveryEngine::V1::CreateDataStoreRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb

Overview

Request for DataStoreService.CreateDataStore method.

Instance Attribute Summary collapse

Instance Attribute Details

#cmek_config_name ⇒ ::String

Returns 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.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#create_advanced_site_search ⇒ ::Boolean

Returns 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.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_store ⇒ ::Google::Cloud::DiscoveryEngine::V1::DataStore

Returns Required. The DataStore to create.

Returns:



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_store_id ⇒ ::String

Returns 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.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#disable_cmek ⇒ ::Boolean

Returns 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.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#skip_default_schema_creation ⇒ ::Boolean

Returns 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.



74
75
76
77
 
# File 'proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb', line 74

class CreateDataStoreRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end