Google Cloud Discovery Engine V1 Client - Class CreateDataStoreRequest (1.5.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CreateDataStoreRequest.

Request for DataStoreService.CreateDataStore method.

Generated from protobuf message google.cloud.discoveryengine.v1.CreateDataStoreRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

↳ data_storeDataStore

Required. The DataStore to create.

↳ data_store_idstring

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.

↳ create_advanced_site_searchbool

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.

↳ skip_default_schema_creationbool

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.

getParent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

Returns
TypeDescription
string

setParent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDataStore

Required. The DataStore to create.

Returns
TypeDescription
DataStore|null

hasDataStore

clearDataStore

setDataStore

Required. The DataStore to create.

Parameter
NameDescription
varDataStore
Returns
TypeDescription
$this

getDataStoreId

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
TypeDescription
string

setDataStoreId

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.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getCreateAdvancedSiteSearch

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
TypeDescription
bool

setCreateAdvancedSiteSearch

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.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

getSkipDefaultSchemaCreation

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
TypeDescription
bool

setSkipDefaultSchemaCreation

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.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}. Please see DataStoreServiceClient::collectionName() for help formatting this field.

dataStoreDataStore

Required. The DataStore to create.

dataStoreIdstring

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
TypeDescription
CreateDataStoreRequest