CollectionComponent(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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 |
str
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 |
str
The display name of the collection. |
data_store_components |
MutableSequence[google.cloud.discoveryengine_v1.types.WidgetConfig.DataStoreComponent]
For the data store collection, list of the children data stores. |
data_source |
str
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 |
str
Output only. The display name of the data source. |
data_source_end_user_display_name |
str
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 |
str
Output only. The icon link of the connector source. |
connector_auth_state |
google.cloud.discoveryengine_v1.types.WidgetConfig.ConnectorAuthState
Output only. The auth uri of the connector source. |
metadata |
google.cloud.discoveryengine_v1.types.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 |
str
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.
|