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

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

Read-only collection component that contains data store collections fields that may be used for filtering.

For SaaS / Business engines, when LookupWidgetConfig is called with view = WITH_AVAILABLE_CONNECTORS, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have connector_auth_state.auth_state == AUTH_STATE_UNSPECIFIED (or NO_AUTH), an empty connector_auth_state.authorization_uri (the widget calls WidgetBuildAuthorizationUrl on the user's "Connect" click), and synthetic placeholder values in name / id (see field comments). Fields that only make sense for materialized connectors (data_store_components, tenant, action_connector) are left unset for placeholder entries.

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

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 collection. It should be collection resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.

↳ id string

Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.

↳ display_name string

The display name of the collection.

↳ data_store_components array<DataStoreComponent>

For the data store collection, list of the children data stores.

↳ data_source string

The name of the data source, retrieved from Collection.data_connector.data_source.

↳ data_source_version float

Output only. The version of the connector definition backing this collection, mirroring DataConnector.data_source_version.

↳ data_source_display_name string

Output only. The display name of the data source.

↳ data_source_end_user_display_name string

Output only. The end-user-facing display name of the data source, sourced from ConnectorSource.end_user_display_name. When unset, clients fall back to data_source_display_name.

↳ connector_icon_link string

Output only. The icon link of the connector source.

↳ connector_auth_state ConnectorAuthState

Output only. The auth uri of the connector source.

↳ metadata Google\Cloud\DiscoveryEngine\V1\DataConnector\ConnectorMetadata

Output only. User-facing connector metadata (title, description, short_description, author, note), retrieved from the registry ConnectorSource.metadata (joined by data source). Shown on the connector detail page.

↳ is_first_party bool

Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector.

↳ tag string

Output only. The version-independent label of the connector backing this collection, mirroring DataConnector.tag. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As DataConnector.tag documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying DataConnector. Populated only when ConnectorsFeature.enable_connector_tag is on.

getName

The name of the collection. It should be collection resource name.

Format: projects/{project}/locations/{location}/collections/{collection_id}. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.

Returns
Type Description
string

setName

The name of the collection. It should be collection resource name.

Format: projects/{project}/locations/{location}/collections/{collection_id}. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

Output only. the identifier of the collection, used for widget service.

For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.

Returns
Type Description
string

setId

Output only. the identifier of the collection, used for widget service.

For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the collection.

Returns
Type Description
string

setDisplayName

The display name of the collection.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataStoreComponents

For the data store collection, list of the children data stores.

Returns
Type Description
Google\Protobuf\RepeatedField<DataStoreComponent>

setDataStoreComponents

For the data store collection, list of the children data stores.

Parameter
Name Description
var array<DataStoreComponent>
Returns
Type Description
$this

getDataSource

The name of the data source, retrieved from Collection.data_connector.data_source.

Returns
Type Description
string

setDataSource

The name of the data source, retrieved from Collection.data_connector.data_source.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSourceVersion

Output only. The version of the connector definition backing this collection, mirroring DataConnector.data_source_version.

Returns
Type Description
float

setDataSourceVersion

Output only. The version of the connector definition backing this collection, mirroring DataConnector.data_source_version.

Parameter
Name Description
var float
Returns
Type Description
$this

getDataSourceDisplayName

Output only. The display name of the data source.

Returns
Type Description
string

setDataSourceDisplayName

Output only. The display name of the data source.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSourceEndUserDisplayName

Output only. The end-user-facing display name of the data source, sourced from ConnectorSource.end_user_display_name. When unset, clients fall back to data_source_display_name.

Returns
Type Description
string

setDataSourceEndUserDisplayName

Output only. The end-user-facing display name of the data source, sourced from ConnectorSource.end_user_display_name. When unset, clients fall back to data_source_display_name.

Parameter
Name Description
var string
Returns
Type Description
$this

Output only. The icon link of the connector source.

Returns
Type Description
string

Output only. The icon link of the connector source.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectorAuthState

Output only. The auth uri of the connector source.

Returns
Type Description
ConnectorAuthState|null

hasConnectorAuthState

clearConnectorAuthState

setConnectorAuthState

Output only. The auth uri of the connector source.

Parameter
Name Description
var ConnectorAuthState
Returns
Type Description
$this

getMetadata

Output only. User-facing connector metadata (title, description, short_description, author, note), retrieved from the registry ConnectorSource.metadata (joined by data source). Shown on the connector detail page.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\DataConnector\ConnectorMetadata|null

hasMetadata

clearMetadata

setMetadata

Output only. User-facing connector metadata (title, description, short_description, author, note), retrieved from the registry ConnectorSource.metadata (joined by data source). Shown on the connector detail page.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\DataConnector\ConnectorMetadata
Returns
Type Description
$this

getIsFirstParty

Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector.

Returns
Type Description
bool

setIsFirstParty

Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTag

Output only. The version-independent label of the connector backing this collection, mirroring DataConnector.tag. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag.

Not a unique key. As DataConnector.tag documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying DataConnector. Populated only when ConnectorsFeature.enable_connector_tag is on.

Returns
Type Description
string

setTag

Output only. The version-independent label of the connector backing this collection, mirroring DataConnector.tag. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag.

Not a unique key. As DataConnector.tag documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying DataConnector. Populated only when ConnectorsFeature.enable_connector_tag is on.

Parameter
Name Description
var string
Returns
Type Description
$this