Google Cloud Discovery Engine V1 Client - Class DataStoreComponent (1.17.0)

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

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of CollectionComponent.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.DataStoreComponent

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.

↳ id string

Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.

↳ display_name string

The display name of the data store.

↳ entity_name string

The name of the entity, retrieved from Collection.data_connector.entities.entityName.

↳ data_store_config_type int

Output only. The type of the data store config.

getName

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.

Returns
Type Description
string

setName

The name of the data store. It should be data store resource name Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Output only. the identifier of the data store, used for widget service.

For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.

Returns
Type Description
string

setId

Output only. the identifier of the data store, used for widget service.

For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the data store.

Returns
Type Description
string

setDisplayName

The display name of the data store.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityName

The name of the entity, retrieved from Collection.data_connector.entities.entityName.

Returns
Type Description
string

setEntityName

The name of the entity, retrieved from Collection.data_connector.entities.entityName.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataStoreConfigType

Output only. The type of the data store config.

Returns
Type Description
int Enum of type DataStoreConfigType.

setDataStoreConfigType

Output only. The type of the data store config.

Parameter
Name Description
var int

Enum of type DataStoreConfigType.

Returns
Type Description
$this