Discovery Engine v1 API - Class WidgetConfig.Types.CollectionComponent (1.17.0) 

public sealed class WidgetConfig.Types.CollectionComponent : IMessage<WidgetConfig.Types.CollectionComponent>, IEquatable<WidgetConfig.Types.CollectionComponent>, IDeepCloneable<WidgetConfig.Types.CollectionComponent>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class WidgetConfig.Types.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.

Inheritance

object > WidgetConfig.Types.CollectionComponent

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CollectionComponent()

public CollectionComponent()

CollectionComponent(CollectionComponent)

public CollectionComponent(WidgetConfig.Types.CollectionComponent other)
Parameter
Name Description
other WidgetConfigTypesCollectionComponent

Properties

ConnectorAuthState

public WidgetConfig.Types.ConnectorAuthState ConnectorAuthState { get; set; }

Output only. The auth uri of the connector source.

Property Value
Type Description
WidgetConfigTypesConnectorAuthState 
public string ConnectorIconLink { get; set; }

Output only. The icon link of the connector source.

Property Value
Type Description
string

DataSource

public string DataSource { get; set; }

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

Property Value
Type Description
string

DataSourceDisplayName

public string DataSourceDisplayName { get; set; }

Output only. The display name of the data source.

Property Value
Type Description
string

DataSourceEndUserDisplayName

public string DataSourceEndUserDisplayName { get; set; }

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.

Property Value
Type Description
string

DataSourceVersion

public double DataSourceVersion { get; set; }

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

Property Value
Type Description
double

DataStoreComponents

public RepeatedField<WidgetConfig.Types.DataStoreComponent> DataStoreComponents { get; }

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

Property Value
Type Description
RepeatedFieldWidgetConfigTypesDataStoreComponent

DisplayName

public string DisplayName { get; set; }

The display name of the collection.

Property Value
Type Description
string

Id

public string Id { get; set; }

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.

Property Value
Type Description
string

IsFirstParty

public bool IsFirstParty { get; set; }

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

Property Value
Type Description
bool

Metadata

public DataConnector.Types.ConnectorMetadata Metadata { get; set; }

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.

Property Value
Type Description
DataConnectorTypesConnectorMetadata

Name

public string Name { get; set; }

The name of the collection. It should be collection resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}. For APIs under [WidgetService][google.cloud.discoveryengine.v1.WidgetService], such as [WidgetService.LookupWidgetConfig][google.cloud.discoveryengine.v1.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.

Property Value
Type Description
string

Tag

public string Tag { get; set; }

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.

Property Value
Type Description
string