Google Cloud Discovery Engine V1 Client - Class CreateDataStoreRequest (1.2.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
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ data_store Google\Cloud\DiscoveryEngine\V1\DataStore

Required. The DataStore to create.

↳ data_store_id 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.

↳ create_advanced_site_search bool

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

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
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDataStore

Required. The DataStore to create.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\DataStore|null

hasDataStore

clearDataStore

setDataStore

Required. The DataStore to create.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\DataStore
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var bool
Returns
Type Description
$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
Type Description
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
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

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

dataStore Google\Cloud\DiscoveryEngine\V1\DataStore

Required. The DataStore to create.

dataStoreId 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
Type Description
Google\Cloud\DiscoveryEngine\V1\CreateDataStoreRequest