Google Cloud Ces V1 Client - Class DataStore (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class DataStore.

A DataStore resource in Vertex AI Search.

Generated from protobuf message google.cloud.ces.v1.DataStore

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Full resource name of the DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

↳ type int

Output only. The type of the data store. This field is readonly and populated by the server.

↳ document_processing_mode int

Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores.

↳ display_name string

Output only. The display name of the data store.

↳ create_time Google\Protobuf\Timestamp

Output only. Timestamp when the data store was created.

↳ connector_config DataStore\ConnectorConfig

Output only. The connector config for the data store connection.

getName

Required. Full resource name of the DataStore.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

Returns
Type Description
string

setName

Required. Full resource name of the DataStore.

Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Output only. The type of the data store. This field is readonly and populated by the server.

Returns
Type Description
int Enum of type DataStoreType.

setType

Output only. The type of the data store. This field is readonly and populated by the server.

Parameter
Name Description
var int

Enum of type DataStoreType.

Returns
Type Description
$this

getDocumentProcessingMode

Output only. The document processing mode for the data store connection.

Only set for PUBLIC_WEB and UNSTRUCTURED data stores.

Returns
Type Description
int Enum of type DocumentProcessingMode.

setDocumentProcessingMode

Output only. The document processing mode for the data store connection.

Only set for PUBLIC_WEB and UNSTRUCTURED data stores.

Parameter
Name Description
var int

Enum of type DocumentProcessingMode.

Returns
Type Description
$this

getDisplayName

Output only. The display name of the data store.

Returns
Type Description
string

setDisplayName

Output only. The display name of the data store.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. Timestamp when the data store was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when the data store was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getConnectorConfig

Output only. The connector config for the data store connection.

Returns
Type Description
DataStore\ConnectorConfig|null

hasConnectorConfig

clearConnectorConfig

setConnectorConfig

Output only. The connector config for the data store connection.

Parameter
Name Description
var DataStore\ConnectorConfig
Returns
Type Description
$this