Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

User-facing metadata for the connector, shown on the connector detail page ( title, description, short_description, author, authenticated_account, note).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata.



2647
2648
2649
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2647

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#authenticated_account ⇒ String

Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides. Corresponds to the JSON property authenticatedAccount

Returns:

  • (String) 


2615
2616
2617
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2615

def 
  @authenticated_account
end

#author ⇒ String

Optional. The party that authored the connector, e.g. "Google" or a third- party provider name. Lets end users see who authored a connector (future: third-party-authored connectors). Corresponds to the JSON property author

Returns:

  • (String) 


2622
2623
2624
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2622

def author
  @author
end

#description ⇒ String

Optional. Human-readable description of the connector, shown on the connector detail page. One connector has a single description. Corresponds to the JSON property description

Returns:

  • (String) 


2628
2629
2630
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2628

def description
  @description
end

#note ⇒ String

Optional. Free-form, multi-line note about the connector's capabilities or a custom note that can be set for the connector. Corresponds to the JSON property note

Returns:

  • (String) 


2634
2635
2636
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2634

def note
  @note
end

#short_description ⇒ String

Optional. Short, subtitle-length description of the connector (e.g. shown beneath the connector name in list and detail views). Corresponds to the JSON property shortDescription

Returns:

  • (String) 


2640
2641
2642
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2640

def short_description
  @short_description
end

#title ⇒ String

Optional. Display title of the connector. Corresponds to the JSON property title

Returns:

  • (String) 


2645
2646
2647
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2645

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2652
2653
2654
2655
2656
2657
2658
2659
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2652

def update!(**args)
  @authenticated_account = args[:authenticated_account] if args.key?(:authenticated_account)
  @author = args[:author] if args.key?(:author)
  @description = args[:description] if args.key?(:description)
  @note = args[:note] if args.key?(:note)
  @short_description = args[:short_description] if args.key?(:short_description)
  @title = args[:title] if args.key?(:title)
end