Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentInfo
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Detailed document information associated with a user event.
Instance Attribute Summary collapse
-
#id ⇒ String
The Document resource ID.
-
#joined ⇒ Boolean
(also: #joined?)
Output only.
-
#name ⇒ String
The Document resource full name, of the form:
projects/
project/locations/
location/collections/
collection_id/dataStores/
data_store_id/branches/
branch_id/documents/
document_id`Corresponds to the JSON property
name`. -
#promotion_ids ⇒ Array<String>
The promotion IDs associated with this Document.
-
#quantity ⇒ Fixnum
Quantity of the Document associated with the user event.
-
#uri ⇒ String
The Document URI - only allowed for website data stores.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1DocumentInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1DocumentInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1DocumentInfo
Returns a new instance of GoogleCloudDiscoveryengineV1DocumentInfo.
3930 3931 3932 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3930 def initialize(**args) update!(**args) end |
Instance Attribute Details
#id ⇒ String
The Document resource ID.
Corresponds to the JSON property id
3896 3897 3898 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3896 def id @id end |
#joined ⇒ Boolean Also known as: joined?
Output only. Whether the referenced Document can be found in the data store.
Corresponds to the JSON property joined
3901 3902 3903 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3901 def joined @joined end |
#name ⇒ String
The Document resource full name, of the form: projects/
project/locations/
location/collections/
collection_id/dataStores/
data_store_id/branches/
branch_id/documents/
document_id`
Corresponds to the JSON property
name`
3909 3910 3911 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3909 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
3915 3916 3917 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3915 def promotion_ids @promotion_ids end |
#quantity ⇒ Fixnum
Quantity of the Document associated with the user event. Defaults to 1. For
example, this field is 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
3923 3924 3925 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3923 def quantity @quantity end |
#uri ⇒ String
The Document URI - only allowed for website data stores.
Corresponds to the JSON property uri
3928 3929 3930 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3928 def uri @uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3935 3936 3937 3938 3939 3940 3941 3942 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3935 def update!(**args) @id = args[:id] if args.key?(:id) @joined = args[:joined] if args.key?(:joined) @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 |