Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::CollectionComponent (v2.14.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::WidgetConfig::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#connector_auth_state

def connector_auth_state() -> ::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::ConnectorAuthState
Returns

#connector_icon_link

def connector_icon_link() -> ::String
Returns
  • (::String) — Output only. The icon link of the connector source.

#data_source

def data_source() -> ::String
Returns
  • (::String) — The name of the data source, retrieved from Collection.data_connector.data_source.

#data_source=

def data_source=(value) -> ::String
Parameter
  • value (::String) — The name of the data source, retrieved from Collection.data_connector.data_source.
Returns
  • (::String) — The name of the data source, retrieved from Collection.data_connector.data_source.

#data_source_display_name

def data_source_display_name() -> ::String
Returns
  • (::String) — Output only. The display name of the data source.

#data_source_end_user_display_name

def data_source_end_user_display_name() -> ::String
Returns
  • (::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.

#data_source_version

def data_source_version() -> ::Float
Returns
  • (::Float) — Output only. The version of the connector definition backing this collection, mirroring DataConnector.data_source_version.

#data_store_components

def data_store_components() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreComponent>
Returns

#data_store_components=

def data_store_components=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::WidgetConfig::DataStoreComponent>
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name of the collection.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name of the collection.
Returns
  • (::String) — The display name of the collection.

#id

def id() -> ::String
Returns
  • (::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.

#is_first_party

def is_first_party() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector.

#metadata

def metadata() -> ::Google::Cloud::DiscoveryEngine::V1::DataConnector::ConnectorMetadata
Returns

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#tag

def tag() -> ::String
Returns
  • (::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.