Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Detailed document information associated with a user event.
Instance Attribute Summary collapse
-
#id ⇒ String
Required.
-
#name ⇒ String
Required.
-
#promotion_ids ⇒ Array<String>
The promotion IDs associated with this Document.
-
#quantity ⇒ Fixnum
Quantity of the Document associated with the user event.
-
#uri ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocumentInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaDocumentInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocumentInfo
Returns a new instance of GoogleCloudDiscoveryengineV1alphaDocumentInfo.
502 503 504 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 502 def initialize(**args) update!(**args) end |
Instance Attribute Details
#id ⇒ String
Required. The Document resource ID.
Corresponds to the JSON property id
473 474 475 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 473 def id @id end |
#name ⇒ String
Required. The Document resource full name, of the form: projects/
project_id/
locations/
location/collections/
collection_id/dataStores/
data_store_id/
branches/
branch_id/documents/
document_id`
Corresponds to the JSON property
name`
480 481 482 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 480 def name @name end |
#promotion_ids ⇒ Array<String>
The promotion IDs associated with this Document. Currently, this field is
restricted to at most one ID.
Corresponds to the JSON property promotionIds
486 487 488 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 486 def promotion_ids @promotion_ids end |
#quantity ⇒ Fixnum
Quantity of the Document associated with the user event. Defaults to 1. For
example, this field will be 2 if two quantities of the same Document are
involved in a add-to-cart
event. Required for events of the following event
types: * add-to-cart
* purchase
Corresponds to the JSON property quantity
494 495 496 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 494 def quantity @quantity end |
#uri ⇒ String
Required. The Document url - only allowed for DataStores with content_config
PUBLIC_WEBSITE.
Corresponds to the JSON property uri
500 501 502 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 500 def uri @uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
507 508 509 510 511 512 513 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 507 def update!(**args) @id = args[:id] if args.key?(:id) @name = args[:name] if args.key?(:name) @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids) @quantity = args[:quantity] if args.key?(:quantity) @uri = args[:uri] if args.key?(:uri) end |